Avaya Client Services API Reference (OS X)
Instance Methods | List of all members
<CSCollaborationDelegate> Protocol Reference

CSCollaborationDelegate is registered as an observer of collaboration status update notifications. More...

#import <CSCollaboration.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - collaborationDidStart:
 Reports that a collaboration instance has started automatically. More...
 
(void) - collaborationDidEnd:
 Reports that a collaboration instance and all of its channels (whiteboard, content sharing, library sharing, etc.) has been ended. More...
 
(void) - collaborationServiceDidBecomeAvailable:
 Called when the collaboration session started and became available. More...
 
(void) - collaborationServiceDidBecomeUnavailable:
 Called when the collaboration session became unavailable due to network disruption. More...
 
(void) - collaborationDidChangeCapabilities:
 Reports that the collaboration's capabilities have changed. More...
 
(void) - collaborationDidEjectParticipant:
 Reports that the local user has been ejected from collaboration. More...
 
(void) - collaborationDidChangePresenterPrivilege:
 Reports that the local user's presenter privilege was changed. More...
 
(void) - collaborationDidChangeModeratorPrivilege:
 Reports that the local user's moderator privilege was changed. More...
 
(void) - collaborationDidInitialize:
 Reports that the collaboration has been initialized - all starting events were processed. More...
 

Detailed Description

CSCollaborationDelegate is registered as an observer of collaboration status update notifications.

The client application is notified about status updates reported by the collaboration server through the CSCollaborationDelegate object. These updates may be the result of local operations on the CSCollaboration object as well as remote changes initiated by either the server or other users on the collaboration call.

See also
CSCollaboration

Method Documentation

- (void) collaborationDidChangeCapabilities: (CSCollaboration *)  collaboration

Reports that the collaboration's capabilities have changed.

Parameters
collaborationThe collaboration sending the message.
- (void) collaborationDidChangeModeratorPrivilege: (CSCollaboration *)  collaboration

Reports that the local user's moderator privilege was changed.

Parameters
collaborationThe collaboration sending the message.
- (void) collaborationDidChangePresenterPrivilege: (CSCollaboration *)  collaboration

Reports that the local user's presenter privilege was changed.

Parameters
collaborationThe collaboration sending the message.
- (void) collaborationDidEjectParticipant: (CSCollaboration *)  collaboration

Reports that the local user has been ejected from collaboration.

Parameters
collaborationThe collaboration sending the message.
- (void) collaborationDidEnd: (CSCollaboration *)  collaboration

Reports that a collaboration instance and all of its channels (whiteboard, content sharing, library sharing, etc.) has been ended.

This notification is not sent when the collaboration is ended by local user. In this case, the local application is notified by the completion handler.

Parameters
collaborationThe collaboration sending the message.
See also
- endWithCompletionHandler: (CSCollaboration)
- (void) collaborationDidInitialize: (CSCollaboration *)  collaboration

Reports that the collaboration has been initialized - all starting events were processed.

Parameters
collaborationThe collaboration sending the message.
See also
CSCollaboration::initialized
- (void) collaborationDidStart: (CSCollaboration *)  collaboration

Reports that a collaboration instance has started automatically.

Notification is not send after starting collaboration by user. In situation of starting collaboration explicitly by user he is notified by completion handler.

Parameters
collaborationThe collaboration sending the message.
See also
- startWithCompletionHandler: (CSCollaboration)
- (void) collaborationServiceDidBecomeAvailable: (CSCollaboration *)  collaboration

Called when the collaboration session started and became available.

Collaboration can become available/unavailable in case of network disruptions within one collaboration call.

Parameters
collaborationThe collaboration sending the message.
See also
CSCollaboration::collaborationServiceDidBecomeUnavailable:
- (void) collaborationServiceDidBecomeUnavailable: (CSCollaboration *)  collaboration

Called when the collaboration session became unavailable due to network disruption.

This notification does not indicate that the collaboration session was ended.

Parameters
collaborationThe collaboration sending the message.
See also
CSCollaboration::collaborationServiceDidBecomeAvailable:

The documentation for this protocol was generated from the following file: