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

Collaboration Class

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

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

    public class Collaboration

The Collaboration type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| Capabilities | Return the collaboration capabilities.
| Chat | Returns Chat object associated with the collaboration.
| ChatCapability | Returns whether the collaboration call supports chat.
| CollaborationInitialized | Returns flag indicating whether collaborations has been initialized. Flag is set true when all starting events are processed.
| CollaborationRenderType | Returns the type of collaboration renderer the client application needs to create to display collaboration content
| ContentSharing | Returns ContentSharing object associated with the collaboration.
| ContentSharingCapability | Returns whether the collaboration call supports content sharing.
| HasModeratorPrivilege | Checks whether the current collaboration user has moderator privileges.
| HasPresenterPrivilege | Checks whether the current collaboration user has presenter privileges.
| IsEjected | Indicates that the current user was ejected from the collaboration by the moderator.
| IsReceivingSharingPaused | Returns true if receiving sharing is paused.
| LibraryManager | Returns LibraryManager object associated with the collaboration.
| LibrarySharing | Returns LibrarySharing object associated with the collaboration.
| LibrarySharingCapability | Returns whether the collaboration call supports library sharing.
| MeetingMinutes | Returns MeetingMinutes object associated with the collaboration.
| MeetingMinutesCapability | Returns whether the collaboration call supports meeting minutes.
| NetworkLibraryCapability | Returns whether the collaboration call supports library management.
| ReceivingSharingControlCapability | Returns Capability object indicating whether it is possible to control receiving sharing through PauseReceivingSharing(Collaboration ReceivingSharingControlCompletionHandler) and ResumeReceivingSharing(Collaboration ReceivingSharingControlCompletionHandler).
| RetrieveParticipantListCapability | Returns whether the collaboration can be queried to get the list of conference participants.
| Slider | Returns Slider object associated with the collaboration.
| SliderCapability | Returns Capability object indicating whether the slider feature is available.
| Whiteboard | Returns Whiteboard object associated with the collaboration.
| WhiteboardCapability | Returns Capability object indicating whether whiteboard sharing can be started by local participant.

Top
Methods

| Name | Description
--- | --- | ---
| End | Ends the collaboration session. Collaboration can not be ended twice or during the collaboration starting or ending process.
| GetCallId | Return call id associated with collaboration.
| GetCollaborationId | Returns the unique numeric ID associated with the particular collaboration object.
| GetParticipants | Returns the participant list associated with the collaboration session. Depending on the capabilities of the collaboration session, the list of participants may not be provided (e.g., when presentation is supported through RTP video stream and not through the web collaboration interface). This method is added to support collaboration only sessions where there is no corresponding audio/video conference call. This method may be called when the collaboration session is associated with a conference call. The call/conference object may be queried to retrieve the full list of participants whereas this method may be used to retrieve the collaboration-only participants. Updates to the participant list (add, remove or update) are reported through the DataSetChangeListener instance registered with the DataSet object.
| PauseReceivingSharing | Pauses receiving certain collaboration sharing updates.
| ReadCollaborationDetails | Returns detailed information about the collaboration statistics
| ResumeReceivingSharing | Resumes receiving certain collaboration sharing updates.
| Start | Starts the collaboration session. Collaboration can not be started twice or during the collaboration starting or ending process.

Top
Events

| Name | Description
--- | --- | ---
| CapabilitiesChanged | Occurs when the collaboration's capabilities change, e.g., as a result of collaboration state change or an internal event.
| Ended | Reports that a collaboration instance and all of its channels (whiteboard, content sharing, library sharing, etc.) has been ended.
| Initialized | Called to report that the collaboration was Initialized.
| ModeratorPrivilegeChanged | Called to report that the collaboration participant's moderator privilege was changed.
| ParticipantEjected | Called to report that the collaboration participant was ejected.
| PresenterPrivilegeChanged | Called to report that the collaboration participant's presenter privilege was changed.
| ServiceAvailable | Called to report that the collaboration session has a healthy signaling path.
| ServiceUnavailable | Called to report that the collaboration session does not have a healthy signaling path.
| Started | Reports that a collaboration instance has started.

Top
Remarks
The Collaboration object is accessible via CollaborationService and provides a set of APIs that allow application developers to access different features and services provided by Avaya's various collaboration solutions.
See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.