Avaya Client Services API Reference (OS X)
|
The CSWhiteboard object provides access to whiteboard related capabilities and actions. More...
#import <CSWhiteboard.h>
Inherits NSObject.
Instance Methods | |
(void) | - startWithCompletionHandler: |
Starts the whiteboard session. More... | |
(void) | - endWithCompletionHandler: |
Ends the whiteboard session. More... | |
(void) | - requestNewSurfaceWithCompletionHandler: |
Requests new whiteboard surface. More... | |
(void) | - removeSurface:withCompletionHandler: |
Removes whiteboard surface. More... | |
(CSWhiteboardSurface *) | - getActiveSurface |
Returns active whiteboard surface. More... | |
Properties | |
id< CSWhiteboardDelegate > | delegate |
The delegate used to handle events related to whiteboard session. More... | |
NSArray * | surfaces |
Array containing all existing CSWhiteboardSurface objects in the current whiteboard session. More... | |
CSCapability * | removeSurfaceCapability |
CSCapability object indicating whether the local user is allowed to remove whiteboard surface. More... | |
CSCapability * | addSurfaceCapability |
CSCapability object indicating whether the local user is allowed to add whiteboard surface. More... | |
The CSWhiteboard object provides access to whiteboard related capabilities and actions.
CSWhiteboard object is accessible via CSCollaboration. Status updates concerning whiteboard are reported via CSWhiteboardDelegate.
In order to display whiteboard client also needs to create CSWhiteboardCanvas and initialize it properly.
CSWhiteboard is responsible for handling whole whiteboard session. Whiteboard session may have many independent CSWhiteboardSurface objects where each of CSWhiteboardSurface object is responsible for one whiteboard drawings.
- (void) endWithCompletionHandler: | (void(^)(CSWhiteboard *whiteboard, NSError *error)) | handler |
Ends the whiteboard session.
handler | A block to be called when the operation is completed.
|
- (CSWhiteboardSurface *) getActiveSurface |
Returns active whiteboard surface.
With property CSWhiteboard::surfaces can be used to display number of active sharing surface in UI.
- (void) removeSurface: | (CSWhiteboardSurface *) | surface | |
withCompletionHandler: | (void(^)(CSWhiteboardSurface *surface, CSParticipant *participant, NSError *error)) | handler | |
Removes whiteboard surface.
If whiteboard surface was removed whiteboard:didRemoveSurface:byParticipant: (CSWhiteboardDelegate-p) is called apart from completion handler.
surface | The surface to remove. |
handler | A block to be called when the operation is completed.
|
- (void) requestNewSurfaceWithCompletionHandler: | (void(^)(CSWhiteboardSurface *surface, CSParticipant *participant, NSError *error)) | handler |
Requests new whiteboard surface.
If whiteboard surface was added whiteboard:didAddSurface:byParticipant: (CSWhiteboardDelegate-p) is called apart from completion handler.
handler | A block to be called when the operation is completed.
|
- (void) startWithCompletionHandler: | (void(^)(CSWhiteboardSurface *surface, CSParticipant *participant, NSError *error)) | handler |
Starts the whiteboard session.
handler | A block to be called when the operation is completed.
|
|
readnonatomiccopy |
CSCapability 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.
|
readwritenonatomicweak |
The delegate used to handle events related to whiteboard session.
|
readnonatomiccopy |
CSCapability 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.
|
readnonatomicassign |
Array containing all existing CSWhiteboardSurface objects in the current whiteboard session.
Array is sorted by creating time of objects.