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

Whiteboard Class

The Whiteboard object provides access to whiteboard related capabilities and actions.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
Whiteboard

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

    public class Whiteboard

The Whiteboard type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AddSurfaceCapability | 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.
| RemoveSurfaceCapability | 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

| Name | Description
--- | --- | ---
| End | Ends this whiteboard session.Another participant with presenter privilege may be able to start a new whiteboard session.
| GetActiveSurface | Returns active whiteboard surface (page).
| GetSurfaces | Array containing all existing WhiteboardSurface objects in the current whiteboard session. Array is sorted by the creation time of objects.
| RemoveSurface | Removes given WhiteboardSurface page from whiteboard session.
| RequestNewSurface | Requests new WhiteboardSurface object which will be representing a new page on a whiteboard.
| Start | Starts the whiteboard session.

Top
Events

| Name | Description
--- | --- | ---
| Ended | Caled when whiteboard session is ended. The contents of this whiteboard session are completely deleted.
| Started | Called when whiteboard session is started as the active session.
| SurfaceAdded | Called when a new WhiteboardSurface whiteboard page has been added to an existing whiteboard
| SurfaceRemoved | Called when some participant from collaboration has removed a WhiteboardSurface whiteboard page.
| SurfaceSetActive | 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

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.