|
Avaya Client Services API Reference (OS X)
|
The CSCollaborationService object provides service for creating and removing CSCollaboration objects. More...
#import <CSCollaborationService.h>
Inherits NSObject.
Instance Methods | |
| (CSCollaboration *) | - createCollaborationWithCollaborationURL:collaborationCode:passcode:guestName:completionHandler: |
| Creates a new collaboration session from collaboration URL and collaboration code. More... | |
| (void) | - createCollaborationWithWebConferenceURI:completionHandler: |
| Creates a new collaboration session based on the input collaboration session URI. More... | |
| (CSCollaboration *) | - createCollaborationForCall:withCompletionHandler: |
| Creates a new collaboration session for the given call. More... | |
Properties | |
| id< CSCollaborationServiceDelegate > | delegate |
| The delegate used to handle updates of CSCollaborationService. More... | |
| BOOL | hasActiveCollaboration |
| Indicates whether there is an active collaboration in progress. More... | |
The CSCollaborationService object provides service for creating and removing CSCollaboration objects.
Status updates of CSCollaborationService are reported through the CSCollaborationServiceDelegate object.
| - (CSCollaboration *) createCollaborationForCall: | (CSCall *) | call | |
| withCompletionHandler: | (void(^)(CSCollaboration *collab, NSError *error)) | handler | |
Creates a new collaboration session for the given call.
Returns empty pointer if the call is not a conference or it already has a collaboration. Otherwise returns the pointer to the uninitialized collaboration object and starts process of collaboration creation.
| call | Call for which the collaboration session is created |
| handler | Block to be called when the operation is completed.
|
| - (CSCollaboration *) createCollaborationWithCollaborationURL: | (NSString *) | collaborationURL | |
| collaborationCode: | (NSString *) | collaborationCode | |
| passcode: | (NSString *) | passcode | |
| guestName: | (NSString *) | guestName | |
| completionHandler: | (void(^)(CSCollaboration *collab, NSError *error)) | handler | |
Creates a new collaboration session from collaboration URL and collaboration code.
| collaborationURL | URL of collaboration |
| collaborationCode | Code for collaboration |
| passcode | Passcode for collaboration |
| guestName | Optional guest name for collaboration |
| handler | Block to be called when the operation is completed.
|
| - (void) createCollaborationWithWebConferenceURI: | (NSURL *) | webConferenceURI | |
| completionHandler: | (void(^)(CSCollaboration *collaboration, NSError *error)) | handler | |
Creates a new collaboration session based on the input collaboration session URI.
This method is used by endpoints such as the Equinox Conferencing room system endpoints that independently and programmatically obtain the complete web collaboration URI from the conference server without using the call creation services provided by the SDK. It is the application's responsibility to make sure that all of the parameters required to connect to the web collaboration server are provided in collaborationURL. Otherwise collaboration creation process will fail.
| webConferenceURI | Complete collaboration session URI including all of the parameters required to set up a web collaboration connection. |
| handler | Block to be called when the operation is completed.
|
|
readwritenonatomicweak |
The delegate used to handle updates of CSCollaborationService.
|
readnonatomicassign |
Indicates whether there is an active collaboration in progress.
