Click or drag to resize

Collaboration Class

The Collaboration object provides access to collaboration related capabilities and actions.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesCollaboration

Namespace:  Avaya.ClientServices
Assembly:  AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
public class Collaboration

The Collaboration type exposes the following members.

Properties
  NameDescription
Public propertyCapabilities
Return the collaboration capabilities.
Public propertyChat
Returns Chat object associated with the collaboration.
Public propertyChatCapability
Returns whether the collaboration call supports chat.
Public propertyCollaborationInitialized
Returns flag indicating whether collaborations has been initialized. Flag is set true when all starting events are processed.
Public propertyCollaborationRenderType
Returns the type of collaboration renderer the client application needs to create to display collaboration content
Public propertyContentSharing
Returns ContentSharing object associated with the collaboration.
Public propertyContentSharingCapability
Returns whether the collaboration call supports content sharing.
Public propertyHasModeratorPrivilege
Checks whether the current collaboration user has moderator privileges.
Public propertyHasPresenterPrivilege
Checks whether the current collaboration user has presenter privileges.
Public propertyIsEjected
Indicates that the current user was ejected from the collaboration by the moderator.
Public propertyIsReceivingSharingPaused
Returns true if receiving sharing is paused.
Public propertyLibraryManager
Returns LibraryManager object associated with the collaboration.
Public propertyLibrarySharing
Returns LibrarySharing object associated with the collaboration.
Public propertyLibrarySharingCapability
Returns whether the collaboration call supports library sharing.
Public propertyMeetingMinutes
Returns MeetingMinutes object associated with the collaboration.
Public propertyMeetingMinutesCapability
Returns whether the collaboration call supports meeting minutes.
Public propertyNetworkLibraryCapability
Returns whether the collaboration call supports library management.
Public propertyReceivingSharingControlCapability
Public propertyRetrieveParticipantListCapability
Returns whether the collaboration can be queried to get the list of conference participants.
Public propertySlider
Returns Slider object associated with the collaboration.
Public propertySliderCapability
Returns Capability object indicating whether the slider feature is available.
Public propertyWhiteboard
Returns Whiteboard object associated with the collaboration.
Public propertyWhiteboardCapability
Returns Capability object indicating whether whiteboard sharing can be started by local participant.
Top
Methods
  NameDescription
Public methodEnd
Ends the collaboration session. Collaboration can not be ended twice or during the collaboration starting or ending process.
Public methodGetCallId
Return call id associated with collaboration.
Public methodGetCollaborationId
Returns the unique numeric ID associated with the particular collaboration object.
Public methodGetParticipants
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.
Public methodPauseReceivingSharing
Pauses receiving certain collaboration sharing updates.
Public methodReadCollaborationDetails
Returns detailed information about the collaboration statistics
Public methodResumeReceivingSharing
Resumes receiving certain collaboration sharing updates.
Public methodStart
Starts the collaboration session. Collaboration can not be started twice or during the collaboration starting or ending process.
Top
Events
  NameDescription
Public eventCapabilitiesChanged
Occurs when the collaboration's capabilities change, e.g., as a result of collaboration state change or an internal event.
Public eventEnded
Reports that a collaboration instance and all of its channels (whiteboard, content sharing, library sharing, etc.) has been ended.
Public eventInitialized
Called to report that the collaboration was Initialized.
Public eventModeratorPrivilegeChanged
Called to report that the collaboration participant's moderator privilege was changed.
Public eventParticipantEjected
Called to report that the collaboration participant was ejected.
Public eventPresenterPrivilegeChanged
Called to report that the collaboration participant's presenter privilege was changed.
Public eventServiceAvailable
Called to report that the collaboration session has a healthy signaling path.
Public eventServiceUnavailable
Called to report that the collaboration session does not have a healthy signaling path.
Public eventStarted
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