Avaya Client Services API Reference (OS X)
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 CCSACSConfigurationConfiguration information for ACS
 CCSActiveParticipantInterface object representing an active participant in a conference call
 C<CSActiveParticipantDelegate>Describes methods that are implemented by the delegate of a CSActiveParticipant
 CCSAgentConfigurationUser configuration information for the Agent service
 CCSAgentFeatureRepresents the contact center agent feature or the feature button administered on the contact center solution
 CCSAgentInformationRepresents an agent information sent from contact center solution to the registered agent's application
 CCSAgentServiceThe 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
 CCSAgentSkill
 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
 CCSAMMConfigurationConfiguration information for AMM
 CCSAudioDetailsAudio-related details for a session
 CCSAudioDeviceAudio device interface
 C<CSAudioDevicesEventListener>
 C<CSAudioFilePlayer>Audio file player control interface
 C<CSAudioFilePlayerListener>Audio file player notification interface
 C<CSAudioInterface>
 C<CSAudioMuteListener>
 CCSAudioRecordPlayStatusListener
 CCSAutodialThe auto dial feature is used to store frequently used or important numbers
 CCSAutomaticGainControlConfiguration
 CCSAvayaMessagingConfigurationConfiguration information for Avaya Messaging provider
 CCSBasicShapeBase class for shapes that can be drawn on whiteboard surface
 CCSBFCPConfigurationConfiguration information for BFCP
 CCSBusyIndicatorRepresent busy indicator feature
 CCSCallThe Call class is a facade object that may be used to represent a 2-party or a or a conference call
 CCSCallCreationInfo
 C<CSCallDelegate>Describes methods that are implemented by the delegate of a CSCall
 CCSCallFeatureServiceThe CSCallFeatureService object is accessible from the CSUser object, providing access to additional business communication features
 C<CSCallFeatureServiceDelegate>
 CCSCallForwardingInformationInterface representing forwarding information of an incoming call
 CCSCallForwardingStatusThe associated parameters of a Enhanced Call Forwarding feature invocation
 CCSCallLogItemRepresents information about a call log item
 CCSCallLogParticipantInterface object representing information about remote party for a call log entry
 CCSCallLogServiceCall 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
 CCSCallPickupAlertParametersThe Enhance or Call Pickup alert details
 CCSCallPickupAlertStatusThe Call Pickup Alert feature status
 CCSCallServiceService for creating and receiving audio/video calls
 C<CSCallServiceDelegate>Describes methods that are implemented by the delegate of a CSCallService
 CCSCancellableDataRetrievalRepresents cancel of asynchronous data retrieval for the current operation
 CCSCapability
 CCSCertificateBasicConstraintBasic constraint certificate extension
 CCSCertificateInfoRepresents X.509 certificate attributes information to be consumed by client applications
 CCSCertificateManagerCertificate 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
 CCSCESConfigurationConfiguration information for CES
 CCSChallengeFor use with a CSCredentialProvider
 CCSChatThe CSChat object provides access to conference chat related capabilities and actions
 C<CSChatDelegate>Chat delegate provides updates about the status of chat
 CCSChatMessageRepresents chat message and associated information
 CCSCircleShapeCSCircleShape objects represent circular shape that can be added to whiteboard surface
 CCSClient
 CCSClientConfiguration
 C<CSClientDelegate>Describes methods that are implemented by the delegate of a CSClient
 CCSClipboardEvent
 CCSCollaborationThe CSCollaboration object provides access to collaboration related capabilities and actions
 CCSCollaborationCapabilitiesThe CSCollaborationCapabilities object provides access to collaboration capabilities
 C<CSCollaborationDelegate>CSCollaborationDelegate is registered as an observer of collaboration status update notifications
 CCSCollaborationDetailsCollaboration related details for session
 CCSCollaborationReceiveStatistics
 CCSCollaborationServiceThe CSCollaborationService object provides service for creating and removing CSCollaboration objects
 C<CSCollaborationServiceDelegate>CSCollaborationServiceDelegate is registered as an observer of CSCollaborationService status update notifications
 CCSCollaborationStatisticsCollaboration common statistics for send and receive
 CCSConferenceThe CSConference object provides access to conferencing related capabilities and actions
 CCSConferenceConfigurationClass representing User Configuration information for a Conference
 C<CSConferenceDelegate>CSConferenceDelegate is registered as an observer of conference status update notifications
 CCSConferenceMobileLinkInterface object representing mobile link feature of a conference call
 CCSConferenceMobileLinkConnectionDetailsClass 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
 CCSConferenceRoomSystemInformationClass representing the conference room system information received from the conference server
 CCSConferenceSlideClass representing a slide that has been presented on a conference call
 CCSConferenceSlideViewerUnsupported: Conference slide viewing is currently not supported
 C<CSConferenceSlideViewerDelegate>Unsupported: Conference slide viewing is currently not supported
 CCSConnectionPolicyDefines the server connection policy used by a CSUser
 CCSContactRepresents an immutable contact object which exposes all possible contact details
 C<CSContact>Protocol used as a common interface for read-only and editable contacts
 CCSContactBoolFieldRepresents a boolean field associated with a contact
 C<CSContactDelegate>Describes methods that are implemented by the delegate of a CSContact
 CCSContactDoubleFieldRepresents a double field associated with a contact
 CCSContactEmailAddressFieldThis class describes the email addresses for the contact record
 CCSContactEmailFieldListList of contact email addresses
 CCSContactFieldA base class for all contact-related field classes which defines the common attributes for all field types
 CCSContactGroupRepresents contact group object which exposes all possible contact group details
 C<CSContactGroupDelegate>Describes methods that are implemented by the delegate of a CSContactGroup
 CCSContactIMAddressFieldList of contact handles
 CCSContactIMAddressFieldListList of contact handles
 CCSContactLimits
 CCSContactMultiValueFieldInterface for multi-value contact field
 CCSContactPhoneFieldRepresents a phone number field associated with a contact
 CCSContactPhoneFieldListList of contact phone numbers
 CCSContactResolveContactsRequestRequest object for resolve contact searches
 CCSContactSearchQueryWatcherPairContains search query string with corresponding data retrieval watcher object
 CCSContactSearchRequestRequest object for extended contact search
 CCSContactServiceThe 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
 CCSContactStringFieldRepresents a string field associated with a contact
 CCSContactStringFieldListList of contact strings
 CCSContentSharingThe CSContentSharing object provides access to content sharing related capabilities and actions
 CCSContentSharingCapabilitiesThe 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
 CCSControllableEndpointThe details of a controllable endpoint for shared control
 CCSCPUThresholdConfiguration
 C<CSCredentialProvider>
 CCSCrisisAlertThis class represents the details about the crisis alert raised in the system
 CCSDataRetrievalDeprecated: Replaced by CSDataRetrievalWatcher
 C<CSDataRetrievalDelegate>Deprecated: Replaced by CSDataRetrievalWatcherDelegate
 CCSDataRetrievalWatcherThis 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
 CCSDataSetDeprecated: This class is for internal Avaya use only
 C<CSDataSetDelegate>Deprecated: This class is for internal Avaya use only
 C<CSDevice>
 C<CSDeviceListener>
 CCSDialingRulesConfigurationThe dialing rules configuration to be applied to transform a user supplied number into a dialable number
 CCSDownloadOptionalParametersSet of optional parameters for Download service
 CCSDownloadResultInfoSet of additional values that are passed to Download Service's completion handler
 CCSDownloadServiceThe 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
 CCSDownloadServiceConfiguration
 CCSDownloadWatcher
 CCSDroppedParticipant
 C<CSDroppedParticipantDelegate>Describes methods that are implemented by the delegate of a CSDroppedParticipant
 CCSDSCPPrecedenceConfiguration
 CCSEC500ConfigurationThe EC500 Feature Name Extensions (FNE's) class that contains the configuration data specific for this User
 CCSEditableContactMutable contact object which exposes all provided contact details
 CCSEditableContactBoolFieldRepresents a field in an EditableContact which stores a boolean, inheriting the meta data description of the field from the original contact field
 CCSEditableContactDoubleFieldRepresents a field in an EditableContact which stores a double, inheriting the meta data description of the field from the original contact field
 CCSEditableContactEmailAddressFieldRepresents a field in an EditableContact which stores an email address, inheriting the metadata description of the field from the original contact field
 CCSEditableContactEmailFieldListList of editable contact email addresses
 CCSEditableContactIMAddressFieldRepresents a field in an EditableContact which stores an IM address, inheriting the meta data description of the field from the original contact field
 CCSEditableContactIMAddressFieldListList of editable contact IM addresses
 CCSEditableContactPhoneFieldRepresents a field in an CSEditableContact which stores a phone number, inheriting the metadata description of the field from the original contact field
 CCSEditableContactPhoneFieldListList of editable contact phone numbers
 CCSEditableContactStringFieldRepresents a field in an EditableContact which stores a string, inheriting the metadata description of the field from the original contact field
 CCSEditableContactStringFieldListList of editable contact strings fields
 CCSEnhancedCallForwardingStatusThe parameters for Enhanced Call Forwarding feature invocation
 CCSEnrollmentCredentialRepresents credential that can be used for identity certificate enroll
 C<CSEnrollmentCredentialProvider>Interface used to represent a CSEnrollmentCredentialProvider
 CCSExportServiceThe 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
 CCSFeatureInvocationParametersThe associated parameters for a feature invocation
 CCSFeatureParametersThis is a union of the parameters of the FNU features
 CCSFeatureStatusParametersThe associated parameters for a specific feature status
 CCSHIDServiceThis 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
 CCSHTTPClientConfigurationData that is common for a HTTP Client
 CCSHTTPUserConfigurationConfiguration information for a HttpSignalingEngine
 CCSIdentifiedInterface for SDK objects that have persistent and unique IDs within their scope
 CCSIPOfficeConfigurationConfiguration information for IP Office
 CCSKeyboardEvent
 CCSLDAPConfigurationConfiguration information for LDAP
 C<CSLevelListener>Audio file player notification interface
 CCSLibraryDocumentUnsupported: The library sharing feature is currently not supported in Client SDK
 CCSLibraryManagerUnsupported: The library sharing feature is currently not supported in Client SDK
 CCSLibrarySharingThe 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)
 CCSLineAppearance
 CCSLocalContactConfigurationFor iOS there is no need to have the configuration information
 CCSMatchedContactsWithMatchLevelContains all results of cached contacts matching
 CCSMaxSupportedVideoResolutionsCapabilityA class representing multi video resolution capabilities of the Client SDK
 CCSMediaConfigurationMedia Configuration
 C<CSMediaLogProvider>
 CCSMediaServicesInstance
 CCSMediaServicesProvider
 CCSMeetingMinutesUnsupported: The meeting minutes feature is currently not supported
 C<CSMeetingMinutesDelegate>Unsupported: The meeting minutes feature is currently not supported
 CCSMessageInterface for all Message related tasks and properties
 CCSMessageBodyPartRepresents a message body of sip response
 C<CSMessageDelegate>Delegate that can be used to retrieve status updates for a message
 CCSMessageDeliveryDetailsThis class defines delivery details of message
 CCSMessageWaitingStatusMessage waiting status information
 CCSMessagingAddressValidationInterface for address validation response
 CCSMessagingAsynchDataRetrieval
 CCSMessagingAttachmentAttachment class is representing a message optional parameter
 C<CSMessagingAttachmentDelegate>
 C<CSMessagingComposingParticipantsWatcherDelegate>
 CCSMessagingConfigurationUser configuration information for the messaging service
 CCSMessagingConversationInterface for all conversation related tasks and properties
 C<CSMessagingConversationDelegate>
 CCSMessagingLeaveConversationResponseInterface for leave conversation response
 CCSMessagingLimitsThis class defines current limits for various messaging service operations
 CCSMessagingParticipantInterface for all messaging participant related tasks and properties
 CCSMessagingParticipantPhoneNumberRepresents a participant's phone number
 CCSMessagingQueryMessaging query data
 CCSMessagingSearchConversation
 CCSMessagingServiceThe 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
 CCSMicrophoneDevice
 CCSMinuteMessageUnsupported: The meeting minutes feature is currently not supported
 CCSMouseEvent
 CCSOSXScreenSharingViewCSOSXScreenSharingView subclasses NSScrollView and provides scrolling behavior for screen sharing content displayed on CSScreenSharingView
 CCSOtherPhoneServiceThis 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
 CCSOutboundSubscriptionConfigurationConfiguration information for Outbound Subscription
 CCSParticipantBase interface object representing a participant on a conference call
 C<CSParticipantDelegate>Describes methods that are implemented by the delegate of a CSParticipant
 CCSPendingParticipantUnsupported: The pending participant feature is currently not supported
 CCSPendingParticipantAdmissionCancellationReasonCSPendingParticipantAdmissionCancellationReason class represents a reason of admission cancellation
 C<CSPendingParticipantDelegate>Describes methods that are implemented by the delegate of a CSPendingParticipant
 CCSPhysicalAddress
 CCSPPMConfigurationThe Personal Profile Manager configuration class that contains the configuration data specific for this User
 CCSPresencePresence information for a user
 C<CSPresenceAccessControlDelegate>
 CCSPresenceAccessControlListThe class encapsulates presence access control list related features available to the user
 CCSPresenceConfigurationUser configuration information for the presence service
 CCSPresenceListSubscriptionAn ad hoc presence list subscription
 C<CSPresenceListSubscriptionDelegate>Describes methods that are implemented by the delegate of a CSPresenceListSubscription
 CCSPresenceServiceThe class encapsulates all of presence related features available to the user
 C<CSPresenceServiceDelegate>
 CCSPresenceWatcherClass 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>
 CCSPresentationSlideCanvasCSPresentationSlidesCanvas - a canvas view to put slide image and whiteboard attached to slide in app view
 CCSPresentationSlidesListener
 CCSQueueStatisticsQueue statistics feature provides statistics about particular skill
 C<CSQueueStatisticsDelegate>Describes methods that are implemented by the delegate of a CSQueueStatistics
 CCSRegistrationGroupA group of signaling servers to register with simultaneously
 CCSRenderingBlockCSRenderingBlock object which represents one block of given size received from collaboration server
 CCSSCEPConfigurationUser configuration information for SCEP (Simple Certificate Enrollment Protocol)
 CCSScreenCapturerOSX
 CCSScreenSharingListenerCSScreenSharingListener is a class that is responsible for two things:
 CCSScreenSharingViewCSScreenSharingView object provides screen sharing canvas on which received frames are drawn on
 CCSSearchTerminalsRequestRequest object for search terminals
 CCSSecurityPolicyConfiguration
 CCSServerInfoRepresents a server to communicate with
 CCSServiceObservingStatusParametersThis class represents the details about the service observing status parameters
 CCSServiceStatus
 CCSSettingsFileParserRepresents a parser that reads Avaya endpoint settings file format
 C<CSSettingsFileParserDelegate>CSSettingsFileParserDelegate is registered as an observer of setting file parser
 CCSShapeCSShape objects represent free shape that can be added to whiteboard surface
 CCSShapePointCSShapePoint objects represent points used by CSShape class
 C<CSSharedControlDelegate>Describes methods that are implemented by the delegate of a CSSharedControlService
 CCSSharedControlServiceThis 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
 CCSSharingApplicationWindowCSSharingApplicationWindow object provides set of information about window which can be shared using CSContentSharing::startSharingApplicationWindowWithWindow:completionHandler
 CCSSharingBlockCSRenderingBlock object which represents one block of given size received from collaboration server
 CCSSharingDisplayCSSharingDisplay object provides set of information about display which can be shared using CSContentSharing::startSharingFullScreenWithScreenId:completionHandler
 CCSSignalingServerRepresents a call server to communicate with
 CCSSignalingServerGroupA group of registration groups to register with individually
 CCSSIPAgentConfigurationConfiguration information for SIP Agent Feature provider
 CCSSIPClientConfigurationData that is common for a SIP Client
 CCSSIPUserConfigurationConfiguration information for a CSSIPSignalingEngine
 CCSSlideUnsupported: The library sharing feature is currently not supported
 C<CSSlideDelegate>Unsupported: The library sharing feature is currently not supported
 CCSSliderThe CSSlider object provides access to slider-related actions
 C<CSSliderDelegate>
 CCSSliderSlideThe CSSliderSlide object provides slide metadata and allows the download of related images
 CCSSpaceParticipant
 CCSSpaceService
 CCSSpeakerDevice
 CCSTeamButtonRepresents team button feature
 CCSTeamButtonIncomingCall
 CCSTerminalRepresents an immutable terminal contact object
 CCSUnifiedPortalConferencingConfigurationConferencing configuration returned by Unified Portal
 CCSUnifiedPortalConfiguration
 CCSUnifiedPortalMeetingInfoMeeting info returned by Unified Portal
 CCSUnifiedPortalResourcesResources returned by Unified Portal
 CCSUnifiedPortalServiceThe UnifiedPortalService provides access to Unified Portal features
 C<CSUnifiedPortalServiceDelegate>
 CCSUserRepresents an user (an extension or user account) that can be registered with a call server
 C<CSUserAdminEventDelegate>
 CCSUserConfigurationConfiguration information for a CSUser
 CCSUserCredentialRepresents a user credential that can be used to respond to an authentication credential challenge
 C<CSUserExternalAppInterfaceDelegate>
 C<CSUserRegistrationDelegate>
 C<CSUserResourceDiscoveryDelegate>
 CCSUserToUserInformationUser-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
 CCSVideoCaptureDevice
 CCSVideoCaptureFormat
 C<CSVideoCapturerDelegate>
 CCSVideoCapturerOSX
 CCSVideoChannelInterface to get video channel related information
 CCSVideoDetailsVideo related details for session
 CCSVideoFrameFileSource
 C<CSVideoInterface>
 C<CSVideoInterfaceDelegate>
 CCSVideoRendererOSX
 CCSVideoResolutionCapabilityClass representing the maximum resolution that can supported for a video stream during a multi video stream conference call
 CCSVideoResolutionPreferenceA class the client application's preference for receive only video resolution for the multiple video channels that can be supported on the call
 CCSVideoResolutionPreferenceForMainVideoStreaming
 CCSVideoResolutionPreferenceForMultiVideoStreamingA 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>
 CCSVideoSinkImpl
 C<CSVideoSource>
 CCSVideoSourceImpl
 CCSVideoSplitter
 CCSVideoStatisticsVideo channel common statistics for send and receive
 CCSVideoTransmitStatistics
 CCSVideoUserConfigurationUser configuration information for video
 C<CSVirtualBackgroundListener>Background replacement notification mechanism
 CCSVirtualRoomVirtual room configured for user
 CCSVisualVoiceMailMessageInterface for all Visual Voicemail Message related tasks and properties
 C<CSVisualVoiceMailMessageDelegate>Delegate that can be used to retrieve status updates for a message
 CCSVisualVoiceMailServiceService interface for visual voicemail, providing visual voicemail service retrieve and delete voice messages, mark messages as read and unread
 C<CSVisualVoiceMailServiceDelegate>
 CCSVoiceMessagingServiceThe CSVoiceMessagingServiceDelegate object is accessible from the User object, providing voicemail status updates
 C<CSVoiceMessagingServiceDelegate>
 CCSVoiceMessagingStatusParameters
 CCSVoIPConfigurationAudio
 CCSVoIPConfigurationVideo
 CCSWCSConfigurationInformation about WCS configuration
 CCSWhiteboardThe CSWhiteboard object provides access to whiteboard related capabilities and actions
 CCSWhiteboardCanvasCSWhiteboardCanvas object provides canvas which can be displayed during whiteboard session
 C<CSWhiteboardDelegate>Whiteboard delegate provides updates about the status of whiteboard sharing
 CCSWhiteboardSurfaceThe 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>
 CCSWhiteboardTextCSWhiteboardText objects represent text that can be added to whiteboard surface
 CCSZangConfigurationConfiguration information for Zang