Click or drag to resize

Whiteboard Class

The Whiteboard object provides access to whiteboard related capabilities and actions.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesWhiteboard

Namespace:  Avaya.ClientServices
Assembly:  AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
public class Whiteboard

The Whiteboard type exposes the following members.

Properties
  NameDescription
Public propertyAddSurfaceCapability
Capability object indicating whether the local user is allowed to add whiteboard surface. To do so, the local user needs to be moderator, presenter or panel model mode has to be enabled.
Public propertyRemoveSurfaceCapability
Capability object indicating whether the local user is allowed to remove whiteboard surface. To do so, the local user needs to be moderator, presenter or panel model mode has to be enabled. It's not allowed to remove surface when it's the last whiteboard surface in current whiteboard session.
Top
Methods
  NameDescription
Public methodEnd
Ends this whiteboard session.Another participant with presenter privilege may be able to start a new whiteboard session.
Public methodGetActiveSurface
Returns active whiteboard surface (page).
Public methodGetSurfaces
Array containing all existing WhiteboardSurface objects in the current whiteboard session. Array is sorted by the creation time of objects.
Public methodRemoveSurface
Removes given WhiteboardSurface page from whiteboard session.
Public methodRequestNewSurface
Requests new WhiteboardSurface object which will be representing a new page on a whiteboard.
Public methodStart
Starts the whiteboard session.
Top
Events
  NameDescription
Public eventEnded
Caled when whiteboard session is ended. The contents of this whiteboard session are completely deleted.
Public eventStarted
Called when whiteboard session is started as the active session.
Public eventSurfaceAdded
Called when a new WhiteboardSurface whiteboard page has been added to an existing whiteboard
Public eventSurfaceRemoved
Called when some participant from collaboration has removed a WhiteboardSurface whiteboard page.
Public eventSurfaceSetActive
Called when some participant from collaboration sets an active whiteboard page.
Top
Remarks
This object is accessible via Collaboration object. This object is responsible for handling a whole whiteboard session within which many independent WhiteboardSurface objects can be created whereas each of these objects is responsible for one whiteboard drawing.
See Also