Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:

C CSACSConfiguration | Configuration information for ACS
C CSActiveParticipant | Interface object representing an active participant in a conference call
C<CSActiveParticipantDelegate> | Describes methods that are implemented by the delegate of a `CSActiveParticipant`
C CSAgentConfiguration | User configuration information for the Agent service
C CSAgentFeature | Represents the contact center agent feature or the feature button administered on the contact center solution
C CSAgentInformation | Represents an agent information sent from contact center solution to the registered agent's application
C CSAgentService | The AgentService object is accessible from the User object, providing access to a set of APIs that allow application developers to implement SIP contact center agent features
C<CSAgentServiceStatusDelegate> | Represents an interface that the client application needs to implement to receive the result of a requested agent operations
C CSAgentSkill |
C<CSAgentStateDelegate> | An interface that the client application needs to implement to receive the result of an agent login or logout operation and agent state updates
C CSAMMConfiguration | Configuration information for AMM
C CSAudioDetails | Audio-related details for a session
C CSAudioDevice | Audio device interface
C<CSAudioDevicesEventListener> |
C<CSAudioFilePlayer> | Audio file player control interface
C<CSAudioFilePlayerListener> | Audio file player notification interface
C<CSAudioInterface> |
C<CSAudioMuteListener> |
C CSAudioRecordPlayStatusListener |
C CSAutodial | The auto dial feature is used to store frequently used or important numbers
C CSAutomaticGainControlConfiguration |
C CSAvayaMessagingConfiguration | Configuration information for Avaya Messaging provider
C CSBasicShape | Base class for shapes that can be drawn on whiteboard surface
C CSBFCPConfiguration | Configuration information for BFCP
C CSBusyIndicator | Represent busy indicator feature
C CSButtonModuleService | The CSButtonModuleService object is accessible from the CSUser object, providing access to the button customization feature
C<CSButtonModuleServiceDelegate> |
C CSCall | The Call class is a facade object that may be used to represent a 2-party or a or a conference call
C CSCallCreationInfo |
C<CSCallDelegate> | Describes methods that are implemented by the delegate of a `CSCall`
C CSCallFeatureService | The CSCallFeatureService object is accessible from the CSUser object, providing access to additional business communication features
C<CSCallFeatureServiceDelegate> |
C CSCallForwardingInformation | Interface representing forwarding information of an incoming call
C CSCallForwardingStatus | The associated parameters of a Enhanced Call Forwarding feature invocation
C CSCallLogItem | Represents information about a call log item
C CSCallLogParticipant | Interface object representing information about remote party for a call log entry
C CSCallLogService | Call Log Service provides history entries for calls that have been made or received on the client
C<CSCallLogServiceDelegate> | Describes methods that are implemented by the delegate of a `CSCallLogService`
C CSCallPickupAlertParameters | The Enhance or Call Pickup alert details
C CSCallPickupAlertStatus | The Call Pickup Alert feature status
C CSCallService | Service for creating and receiving audio/video calls
C<CSCallServiceDelegate> | Describes methods that are implemented by the delegate of a `CSCallService`
C CSCancellableDataRetrieval | Represents cancel of asynchronous data retrieval for the current operation
C CSCapability |
C CSCertificateBasicConstraint | Basic constraint certificate extension
C CSCertificateInfo | Represents X.509 certificate attributes information to be consumed by client applications
C CSCertificateManager | Certificate manager class allows application developers to configure and make use of the library's client/server certificate trust validation logic
C<CSCertificateManagerClientIdentityDelegate> | CSCertificateManagerClientIdentityDelegate is registered as a listener to get notified about the client identity certificate's expiration status
C<CSCertificateManagerDelegate> | Describes methods that are implemented by the delegate of a CSCertificateManager
C<CSCertificateManagerEnrollmentDelegate> | Describes methods that are implemented by the delegate of a CSCertificateManager
C CSCESConfiguration | Configuration information for CES
C CSChallenge | For use with a CSCredentialProvider
C CSChat | The CSChat object provides access to conference chat related capabilities and actions
C<CSChatDelegate> | Chat delegate provides updates about the status of chat
C CSChatMessage | Represents chat message and associated information
C CSCircleShape | CSCircleShape objects represent circular shape that can be added to whiteboard surface
C CSClient |
C CSClientConfiguration |
C<CSClientDelegate> | Describes methods that are implemented by the delegate of a `CSClient`
C CSClipboardEvent |
C CSCollaboration | The CSCollaboration object provides access to collaboration related capabilities and actions
C CSCollaborationCapabilities | The CSCollaborationCapabilities object provides access to collaboration capabilities
C<CSCollaborationDelegate> | CSCollaborationDelegate is registered as an observer of collaboration status update notifications
C CSCollaborationDetails | Collaboration related details for session
C CSCollaborationReceiveStatistics |
C CSCollaborationService | The CSCollaborationService object provides service for creating and removing CSCollaboration objects
C<CSCollaborationServiceDelegate> | CSCollaborationServiceDelegate is registered as an observer of CSCollaborationService status update notifications
C CSCollaborationStatistics | Collaboration common statistics for send and receive
C CSConference | The CSConference object provides access to conferencing related capabilities and actions
C CSConferenceConfiguration | Class representing User Configuration information for a Conference
C<CSConferenceDelegate> | CSConferenceDelegate is registered as an observer of conference status update notifications
C CSConferenceMobileLink | Interface object representing mobile link feature of a conference call
C CSConferenceMobileLinkConnectionDetails | Class representing the connection details when mobile link successfully connected to the specific room system
C<CSConferenceMobileLinkDelegate> | Describes methods that are implemented by the delegate of a `CSConferenceMobileLink`
C CSConferenceRoomSystemInformation | Class representing the conference room system information received from the conference server
C CSConferenceSlide | Class representing a slide that has been presented on a conference call
C CSConferenceSlideViewer | Unsupported: Conference slide viewing is currently not supported
C<CSConferenceSlideViewerDelegate> | Unsupported: Conference slide viewing is currently not supported
C CSConnectionPolicy | Defines the server connection policy used by a `CSUser`
C CSContact | Represents an immutable contact object which exposes all possible contact details
C<CSContact> | Protocol used as a common interface for read-only and editable contacts
C CSContactBoolField | Represents a boolean field associated with a contact
C<CSContactDelegate> | Describes methods that are implemented by the delegate of a `CSContact`
C CSContactDoubleField | Represents a double field associated with a contact
C CSContactEmailAddressField | This class describes the email addresses for the contact record
C CSContactEmailFieldList | List of contact email addresses
C CSContactField | A base class for all contact-related field classes which defines the common attributes for all field types
C CSContactGroup | Represents contact group object which exposes all possible contact group details
C<CSContactGroupDelegate> | Describes methods that are implemented by the delegate of a `CSContactGroup`
C CSContactIMAddressField | List of contact handles
C CSContactIMAddressFieldList | List of contact handles
C CSContactLimits |
C CSContactMultiValueField | Interface for multi-value contact field
C CSContactPhoneField | Represents a phone number field associated with a contact
C CSContactPhoneFieldList | List of contact phone numbers
C CSContactResolveContactsRequest | Request object for resolve contact searches
C CSContactSearchQueryWatcherPair | Contains search query string with corresponding data retrieval watcher object
C CSContactSearchRequest | Request object for extended contact search
C CSContactService | The CSContactService object is accessible from the CSUser object, and providing access to functionality associated with contacts
C<CSContactServiceDelegate> | Describes methods that are implemented by the delegate of a `CSContactService`
C CSContactStringField | Represents a string field associated with a contact
C CSContactStringFieldList | List of contact strings
C CSContentSharing | The CSContentSharing object provides access to content sharing related capabilities and actions
C CSContentSharingCapabilities | The CSContentSharingCapabilities object provides access to content sharing capabilities
C<CSContentSharingDelegate> | CSContentSharingDelegate is registered as an observer of content sharing status update notifications
C<CSContentSharingRemoteControlDelegate> | CSContentSharingRemoteControlDelegate is registered as an observer of content sharing status update notifications concerning remote control
C CSControllableEndpoint | The details of a controllable endpoint for shared control
C CSCPUThresholdConfiguration |
C<CSCredentialProvider> |
C CSCrisisAlert | This class represents the details about the crisis alert raised in the system
C CSCustomizedButton | The parameters that can be present in a customized button
C CSDataRetrieval | Deprecated: Replaced by CSDataRetrievalWatcher
C<CSDataRetrievalDelegate> | Deprecated: Replaced by CSDataRetrievalWatcherDelegate
C CSDataRetrievalWatcher | This class defines an interface that client applications use to perform data retrieval operations for both static and dynamic collections of objects within the SDK
C<CSDataRetrievalWatcherDelegate> | This protocol is used by CSDataRetrievalWatcher objects to report progress for the retrieval operation and updates to the associated data collection
C CSDataSet | Deprecated: This class is for internal Avaya use only
C<CSDataSetDelegate> | Deprecated: This class is for internal Avaya use only
C<CSDevice> |
C<CSDeviceListener> |
C CSDialingRulesConfiguration | The dialing rules configuration to be applied to transform a user supplied number into a dialable number
C CSDownloadOptionalParameters | Set of optional parameters for Download service
C CSDownloadResultInfo | Set of additional values that are passed to Download Service's completion handler
C CSDownloadService | The DownloadService object provides a set of APIs that allow app to download any files through a URL securely including auto configure setting file, trust cert file, custom logo file, etc
C CSDownloadServiceConfiguration |
C CSDownloadWatcher |
C CSDroppedParticipant |
C<CSDroppedParticipantDelegate> | Describes methods that are implemented by the delegate of a `CSDroppedParticipant`
C CSDSCPPrecedenceConfiguration |
C CSEC500Configuration | The EC500 Feature Name Extensions (FNE's) class that contains the configuration data specific for this User
C CSEditableContact | Mutable contact object which exposes all provided contact details
C CSEditableContactBoolField | Represents a field in an EditableContact which stores a boolean, inheriting the meta data description of the field from the original contact field
C CSEditableContactDoubleField | Represents a field in an EditableContact which stores a double, inheriting the meta data description of the field from the original contact field
C CSEditableContactEmailAddressField | Represents a field in an EditableContact which stores an email address, inheriting the metadata description of the field from the original contact field
C CSEditableContactEmailFieldList | List of editable contact email addresses
C CSEditableContactIMAddressField | Represents a field in an EditableContact which stores an IM address, inheriting the meta data description of the field from the original contact field
C CSEditableContactIMAddressFieldList | List of editable contact IM addresses
C CSEditableContactPhoneField | Represents a field in an CSEditableContact which stores a phone number, inheriting the metadata description of the field from the original contact field
C CSEditableContactPhoneFieldList | List of editable contact phone numbers
C CSEditableContactStringField | Represents a field in an EditableContact which stores a string, inheriting the metadata description of the field from the original contact field
C CSEditableContactStringFieldList | List of editable contact strings fields
C CSEnhancedCallForwardingStatus | The parameters for Enhanced Call Forwarding feature invocation
C CSEnrollmentCredential | Represents credential that can be used for identity certificate enroll
C<CSEnrollmentCredentialProvider> | Interface used to represent a CSEnrollmentCredentialProvider
C CSExportService | The CSExportService object is accessible from the CSUser object, providing the ability to export messages for Conference Chat and Messaging conversation
C<CSExportServiceDelegate> | Describes methods that are implemented by the delegate of a `CSExportService`
C CSFeatureInvocationParameters | The associated parameters for a feature invocation
C CSFeatureParameters | This is a union of the parameters of the FNU features
C CSFeatureStatusParameters | The associated parameters for a specific feature status
C CSHIDService | This service provides information about the Human Interface Device (HID) devices connected to the machine, along with associated button presses that are NOT automatically handled by the SDK
C<CSHIDServiceDelegate> | Describes methods that are implemented by the delegate of a `CSHIDService`
C CSHTTPClientConfiguration | Data that is common for a HTTP Client
C CSHTTPUserConfiguration | Configuration information for a HttpSignalingEngine
C CSIdentified | Interface for SDK objects that have persistent and unique IDs within their scope
C CSIPOfficeConfiguration | Configuration information for IP Office
C CSKeyboardEvent |
C CSLDAPConfiguration | Configuration information for LDAP
C<CSLevelListener> | Audio file player notification interface
C CSLibraryDocument | Unsupported: The library sharing feature is currently not supported in Client SDK
C CSLibraryManager | Unsupported: The library sharing feature is currently not supported in Client SDK
C CSLibrarySharing | The library sharing feature is currently not supported in ClientSDK Only two methods of CSLibrarySharingDelegate which notifies the client about library sharing started and ended
C<CSLibrarySharingDelegate> | Library sharing delegate provides updates about the status of library document sharing and whether a new shared page is received from the server (for a non presenting participant)
C CSLineAppearance |
C CSLocalContactConfiguration | For iOS there is no need to have the configuration information
C CSMatchedContactsWithMatchLevel | Contains all results of cached contacts matching
C CSMaxSupportedVideoResolutionsCapability | A class representing multi video resolution capabilities of the Client SDK
C CSMediaConfiguration | Media Configuration
C<CSMediaLogProvider> |
C CSMediaServicesInstance |
C CSMediaServicesProvider |
C CSMeetingMinutes | Unsupported: The meeting minutes feature is currently not supported
C<CSMeetingMinutesDelegate> | Unsupported: The meeting minutes feature is currently not supported
C CSMessage | Interface for all Message related tasks and properties
C CSMessageBodyPart | Represents a message body of sip response
C<CSMessageDelegate> | Delegate that can be used to retrieve status updates for a message
C CSMessageDeliveryDetails | This class defines delivery details of message
C CSMessageWaitingStatus | Message waiting status information
C CSMessagingAddressValidation | Interface for address validation response
C CSMessagingAsynchDataRetrieval |
C CSMessagingAttachment | Attachment class is representing a message optional parameter
C<CSMessagingAttachmentDelegate> |
C<CSMessagingComposingParticipantsWatcherDelegate> |
C CSMessagingConfiguration | User configuration information for the messaging service
C CSMessagingConversation | Interface for all conversation related tasks and properties
C<CSMessagingConversationDelegate> |
C CSMessagingLeaveConversationResponse | Interface for leave conversation response
C CSMessagingLimits | This class defines current limits for various messaging service operations
C CSMessagingParticipant | Interface for all messaging participant related tasks and properties
C CSMessagingParticipantPhoneNumber | Represents a participant's phone number
C CSMessagingQuery | Messaging query data
C CSMessagingSearchConversation |
C CSMessagingService | The CSMessagingService object is accessible from the CSUser object, and provides access to messaging related capabilities and actions
C<CSMessagingServiceDelegate> | Protocol of delegate that can be used to retrieve status updates from the CSMessagingService
C CSMicrophoneDevice |
C CSMinuteMessage | Unsupported: The meeting minutes feature is currently not supported
C CSMouseEvent |
C CSOSXScreenSharingView | CSOSXScreenSharingView subclasses NSScrollView and provides scrolling behavior for screen sharing content displayed on CSScreenSharingView
C CSOtherPhoneService | This service provides the user with the ability to direct media to any other phone (typically a cell phone/ home phone) while controlling signaling from the client
C<CSOtherPhoneServiceDelegate> | Describes methods that are implemented by the delegate of a `CSOtherPhoneService`
C CSOutboundSubscriptionConfiguration | Configuration information for Outbound Subscription
C CSParticipant | Base interface object representing a participant on a conference call
C<CSParticipantDelegate> | Describes methods that are implemented by the delegate of a `CSParticipant`
C CSPendingParticipant | Unsupported: The pending participant feature is currently not supported
C CSPendingParticipantAdmissionCancellationReason | CSPendingParticipantAdmissionCancellationReason class represents a reason of admission cancellation
C<CSPendingParticipantDelegate> | Describes methods that are implemented by the delegate of a `CSPendingParticipant`
C CSPhysicalAddress |
C CSPPMConfiguration | The Personal Profile Manager configuration class that contains the configuration data specific for this User
C CSPresence | Presence information for a user
C<CSPresenceAccessControlDelegate> |
C CSPresenceAccessControlList | The class encapsulates presence access control list related features available to the user
C CSPresenceConfiguration | User configuration information for the presence service
C CSPresenceListSubscription | An ad hoc presence list subscription
C<CSPresenceListSubscriptionDelegate> | Describes methods that are implemented by the delegate of a `CSPresenceListSubscription`
C CSPresenceService | The class encapsulates all of presence related features available to the user
C<CSPresenceServiceDelegate> |
C CSPresenceWatcher | Class representing either a remote user who is already tracking local user's presence, or a remote user who is asking for permission to track local user's presence
C<CSPresenceWatcherRequestDelegate> |
C CSPresentationSlideCanvas | CSPresentationSlidesCanvas - a canvas view to put slide image and whiteboard attached to slide in app view
C CSPresentationSlidesListener |
C CSQueueStatistics | Queue statistics feature provides statistics about particular skill
C<CSQueueStatisticsDelegate> | Describes methods that are implemented by the delegate of a `CSQueueStatistics`
C CSRegistrationGroup | A group of signaling servers to register with simultaneously
C CSRenderingBlock | CSRenderingBlock object which represents one block of given size received from collaboration server
C CSSCEPConfiguration | User configuration information for SCEP (Simple Certificate Enrollment Protocol)
C CSScreenCapturerOSX |
C CSScreenSharingListener | CSScreenSharingListener is a class that is responsible for two things:
C CSScreenSharingView | CSScreenSharingView object provides screen sharing canvas on which received frames are drawn on
C CSSearchTerminalsRequest | Request object for search terminals
C CSSecurityPolicyConfiguration |
C CSServerInfo | Represents a server to communicate with
C CSServiceObservingStatusParameters | This class represents the details about the service observing status parameters
C CSServiceStatus |
C CSSettingsFileParser | Represents a parser that reads Avaya endpoint settings file format
C<CSSettingsFileParserDelegate> | CSSettingsFileParserDelegate is registered as an observer of setting file parser
C CSShape | CSShape objects represent free shape that can be added to whiteboard surface
C CSShapePoint | CSShapePoint objects represent points used by CSShape class
C<CSSharedControlDelegate> | Describes methods that are implemented by the delegate of a `CSSharedControlService`
C CSSharedControlService | This service provides the user with the ability to direct media to the Desk Phone (Hard Phone) while issuing signaling commands from the Desk Phone and/or the client
C CSSharingApplicationWindow | CSSharingApplicationWindow object provides set of information about window which can be shared using CSContentSharing::startSharingApplicationWindowWithWindow:completionHandler
C CSSharingBlock | CSRenderingBlock object which represents one block of given size received from collaboration server
C CSSharingDisplay | CSSharingDisplay object provides set of information about display which can be shared using CSContentSharing::startSharingFullScreenWithScreenId:completionHandler
C CSSignalingServer | Represents a call server to communicate with
C CSSignalingServerGroup | A group of registration groups to register with individually
C CSSIPAgentConfiguration | Configuration information for SIP Agent Feature provider
C CSSIPClientConfiguration | Data that is common for a SIP Client
C CSSIPUserConfiguration | Configuration information for a `CSSIPSignalingEngine`
C CSSlide | Unsupported: The library sharing feature is currently not supported
C<CSSlideDelegate> | Unsupported: The library sharing feature is currently not supported
C CSSlider | The CSSlider object provides access to slider-related actions
C<CSSliderDelegate> |
C CSSliderSlide | The CSSliderSlide object provides slide metadata and allows the download of related images
C CSSpaceParticipant |
C CSSpaceService |
C CSSpeakerDevice |
C CSStatisticsData | Represents VuStats statistics data gathered from the server
C CSTeamButton | Represents team button feature
C CSTeamButtonIncomingCall |
C CSTerminal | Represents an immutable terminal contact object
C CSUnifiedPortalConferencingConfiguration | Conferencing configuration returned by Unified Portal
C CSUnifiedPortalConfiguration |
C CSUnifiedPortalMeetingInfo | Meeting info returned by Unified Portal
C CSUnifiedPortalResources | Resources returned by Unified Portal
C CSUnifiedPortalService | The UnifiedPortalService provides access to Unified Portal features
C<CSUnifiedPortalServiceDelegate> |
C CSUser | Represents an user (an extension or user account) that can be registered with a call server
C<CSUserAdminEventDelegate> |
C CSUserConfiguration | Configuration information for a `CSUser`
C CSUserCredential | Represents a user credential that can be used to respond to an authentication credential challenge
C<CSUserExternalAppInterfaceDelegate> |
C<CSUserRegistrationDelegate> |
C<CSUserResourceDiscoveryDelegate> |
C CSUserToUserInformation | User-to-User Information (UUI), known as call control UUI data, is a small piece of data inserted by an application initiating the call and utilized by the application receiving the call
C CSVideoCaptureDevice |
C CSVideoCaptureFormat |
C<CSVideoCapturerDelegate> |
C CSVideoCapturerOSX |
C CSVideoChannel | Interface to get video channel related information
C CSVideoDetails | Video related details for session
C CSVideoFrameFileSource |
C<CSVideoInterface> |
C<CSVideoInterfaceDelegate> |
C CSVideoRendererOSX |
C CSVideoResolutionCapability | Class representing the maximum resolution that can supported for a video stream during a multi video stream conference call
C CSVideoResolutionPreference | A class the client application's preference for receive only video resolution for the multiple video channels that can be supported on the call
C CSVideoResolutionPreferenceForMainVideoStreaming |
C CSVideoResolutionPreferenceForMultiVideoStreaming | A class the client application's preference for receive only video resolution for the multiple video channels that can be supported on the call
C<CSVideoSink> |
C CSVideoSinkImpl |
C<CSVideoSource> |
C CSVideoSourceImpl |
C CSVideoSplitter |
C CSVideoStatistics | Video channel common statistics for send and receive
C CSVideoTransmitStatistics |
C CSVideoUserConfiguration | User configuration information for video
C<CSVirtualBackgroundListener> | Background replacement notification mechanism
C CSVirtualRoom | Virtual room configured for user
C CSVisualVoiceMailMessage | Interface for all Visual Voicemail Message related tasks and properties
C<CSVisualVoiceMailMessageDelegate> | Delegate that can be used to retrieve status updates for a message
C CSVisualVoiceMailService | Service interface for visual voicemail, providing visual voicemail service retrieve and delete voice messages, mark messages as read and unread
C<CSVisualVoiceMailServiceDelegate> |
C CSVoiceMessagingService | The CSVoiceMessagingServiceDelegate object is accessible from the User object, providing voicemail status updates
C<CSVoiceMessagingServiceDelegate> |
C CSVoiceMessagingStatusParameters |
C CSVoIPConfigurationAudio |
C CSVoIPConfigurationVideo |
C CSWCSConfiguration | Information about WCS configuration
C CSWhiteboard | The CSWhiteboard object provides access to whiteboard related capabilities and actions
C CSWhiteboardCanvas | CSWhiteboardCanvas object provides canvas which can be displayed during whiteboard session
C<CSWhiteboardDelegate> | Whiteboard delegate provides updates about the status of whiteboard sharing
C CSWhiteboardSurface | The CSWhiteboardSurface object represents independent whiteboard surface containing all shapes drawn on given whiteboard surface
C<CSWhiteboardSurfaceDelegate> | CSWhiteboardSurfaceDelegate is registered as an observer of whiteboard surface update notifications
C<CSWhiteboardSurfaceNSObject> |
C CSWhiteboardText | CSWhiteboardText objects represent text that can be added to whiteboard surface
C CSZangConfiguration | Configuration information for Zang