Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
WhiteboardSurface Class
WhiteboardSurface Properties
WhiteboardSurface Methods
WhiteboardSurface Events

WhiteboardSurface Class

The WhiteboardSurface object represents an independent whiteboard surface (page) containing all shapes drawn on a given whiteboard surface.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
WhiteboardSurface

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    public class WhiteboardSurface

The WhiteboardSurface type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AddedBy | Participant that added this surface.
| RemovedBy | Participant that removed this surface.
| SetAsActiveCapability | Capability object indicating whether the local user is allowed to set given whiteboard surface active. To do so, the local user needs to be moderator, presenter or panel model mode has to be enabled.

Top
Methods

| Name | Description
--- | --- | ---
| AddCircle | Add circle to whiteboard.
| AddShape | Add shape (polygon) to whiteboard.
| AddText | Adds text field to whiteboard.
| ClearContent | Removes all shapes from whiteboard.
| DeleteShape | Remove shape from whiteboard.
| FinishShape | Finishes drawing AbstractShape object, ex. line can be continuously drawn and this indicates that this object is fully drawn.
| GetShapes | Returns list of shapes on whiteboard surface.
| GetSurfaceId | Returns whiteboard surface Id.
| SetAsActive | Sets whiteboard surface as currently used.
| UpdateShape | Update (move) shape.

Top
Events

| Name | Description
--- | --- | ---
| ShapeAdded | Called when shape has been added.
| ShapeDeleted | Called when shape has been deleted.
| ShapeEnded | Reports that on whiteboard page user has finished drawing shape.
| ShapeUpdated | Called when shape has been updated.
| WhiteboardCleared |

Top
See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.