Avaya Client Services API Reference (OS X)
Instance Methods | Properties | List of all members
CSUser Class Reference

Represents an user (an extension or user account) that can be registered with a call server. More...

#import <CSUser.h>

Inherits NSObject.

Instance Methods

(void) - start
 Starts all services. More...
 
(void) - stop
 Stops all the services. More...
 

Properties

id< CSUserRegistrationDelegate > registrationDelegate
 The delegate responsible for handling user registration related events. More...
 
id< CSUserAdminEventDelegate > userAdminDelegate
 
id< CSUserExternalAppInterfaceDelegate > externalAppInterfaceDelegate
 The delegate responsible for handling external app interface related events. More...
 
id< CSUserResourceDiscoveryDelegate > resourceDiscoveryDelegate
 The delegate responsible for handling resource discovery related events. More...
 
NSString * userId
 The user ID of the user. More...
 
CSCallService * callService
 Service providing call features for this user. More...
 
CSCallFeatureService * callFeatureService
 Service providing call features for this user. More...
 
CSVisualVoiceMailService * visualVoiceMailService
 Service providing visual voicemail feature for this user. More...
 
CSVoiceMessagingService * voiceMessagingService
 Service providing voice messaging feature for this user. More...
 
CSPresenceService * presenceService
 Service providing access to presence features for this user. More...
 
CSMessagingService * messagingService
 Service providing access to messaging features for this user. More...
 
CSOtherPhoneService * otherPhoneService
 Service providing other phone mode for this user. More...
 
CSHIDService * hidService
 Service providing access to Human Interface Device (HID) updates. More...
 
CSSharedControlService * sharedControlService
 Service providing access to shared control features for this user. More...
 
CSContactService * contactService
 Service providing access to contact features for this user. More...
 
CSCollaborationService * collaborationService
 Service providing collaboration services for this user. More...
 
CSCallLogService * callLogService
 Service providing call log services for this user. More...
 
CSSpaceService * spaceService
 
CSUnifiedPortalService * unifiedPortalService
 Service providing access to Unified Portal features for this user. More...
 
CSExportService * exportService
 Service providing exporting of messages for ConferenceChat and MessagingConversation for the user. More...
 
NSArray * externalAppIds
 The application Ids of any external applications that have registered to monitor and / or control calls on behalf of this user. More...
 
CSServiceStatus * contactServiceStatus
 Returns ServiceStatus object describing whether the Contact service is enabled. More...
 
CSServiceStatus * messagingServiceStatus
 Returns ServiceStatus object describing whether the Messaging service is enabled. More...
 
CSServiceStatus * callServiceStatus
 Returns ServiceStatus object describing whether the Call service is enabled. More...
 
CSServiceStatus * collaborationServiceStatus
 Returns ServiceStatus object describing whether the Collaboration service is enabled. More...
 
CSServiceStatus * callFeatureServiceStatus
 Returns ServiceStatus object describing whether the CallFeature service is enabled. More...
 
CSServiceStatus * presenceServiceStatus
 Returns ServiceStatus object describing whether the Presence service is enabled. More...
 
CSServiceStatus * pushNotificationServiceStatus
 Returns ServiceStatus object describing whether the PushNotification service is enabled. More...
 
CSServiceStatus * callLogServiceStatus
 Returns ServiceStatus object describing whether the CallLog service is enabled. More...
 
CSServiceStatus * voiceMessagingServiceStatus
 Returns ServiceStatus object describing whether the VoiceMessaging service is enabled. More...
 
CSServiceStatus * visualVoiceMailServiceStatus
 Returns ServiceStatus object describing whether the VisualVoiceMail service is enabled. More...
 
CSServiceStatus * unifiedPortalServiceStatus
 Returns ServiceStatus object describing whether the UnifiedPortal service is enabled. More...
 
CSServiceStatus * sharedControlServiceStatus
 Returns ServiceStatus object describing whether the SharedControl service is enabled. More...
 
CSServiceStatus * otherPhoneServiceStatus
 Returns ServiceStatus object describing whether the other phone service is enabled. More...
 
CSServiceStatus * hidServiceStatus
 Returns ServiceStatus object describing whether the HID service is enabled. More...
 
CSAgentService * agentService
 Service providing access to Agent features for local user. More...
 
CSServiceStatus * agentServiceStatus
 Returns ServiceStatus object describing whether the Agent service is enabled. More...
 
CSServiceStatus * exportServiceStatus
 Returns ServiceStatus object describing whether the Export service is enabled. More...
 
CSSignalingServerGroup * signalingServerGroup
 Returns the SignalingServerGroup containing the complete call server list used by system, it contains additional servers discovered by system from different source including the servers provided by the user. More...
 

Detailed Description

Represents an user (an extension or user account) that can be registered with a call server.

Identities are created through a protocol-specific signaling engine instance.

Method Documentation

- (void) start

Starts all services.

Progress is provided via the CSUserRegistrationDelegate methods and other service delegates. A successful callback sequence for a two-server configuration will be similar to the following:

  • user:registrationInProgressWithServer:<server 1>
  • user:registrationInProgressWithServer:<server 2>
  • user:registrationSuccessfulWithServer:<server 1>
  • user:registrationSuccessfulWithServer:<server 2>
  • userRegistrationSuccessfulWithAllServers
- (void) stop

Stops all the services.

Progress is provided via the CSUserRegistrationDelegate methods and other service delegates. A successful callback sequence for a two-server configuration will be similar to the following:

  • user:unregistrationInProgressWithServer:<server 1>
  • user:unregistrationInProgressWithServer:<server 2>
  • user:unregistrationSuccessfulWithServer:<server 1>
  • user:unregistrationSuccessfulWithServer:<server 2>
  • userUnregistrationCompleteWithAllServers

Property Documentation

- (CSAgentService*) agentService
readnonatomicassign

Service providing access to Agent features for local user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) agentServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Agent service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSCallFeatureService*) callFeatureService
readnonatomicassign

Service providing call features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) callFeatureServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the CallFeature service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSCallLogService*) callLogService
readnonatomicassign

Service providing call log services for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) callLogServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the CallLog service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSCallService*) callService
readnonatomicassign

Service providing call features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) callServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Call service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSCollaborationService*) collaborationService
readnonatomicassign

Service providing collaboration services for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) collaborationServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Collaboration service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSContactService*) contactService
readnonatomicassign

Service providing access to contact features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) contactServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Contact service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSExportService*) exportService
readnonatomicassign

Service providing exporting of messages for ConferenceChat and MessagingConversation for the user.

- (CSServiceStatus*) exportServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Export service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (NSArray*) externalAppIds
readnonatomicassign

The application Ids of any external applications that have registered to monitor and / or control calls on behalf of this user.

- (id<CSUserExternalAppInterfaceDelegate>) externalAppInterfaceDelegate
readwritenonatomicweak

The delegate responsible for handling external app interface related events.

- (CSHIDService*) hidService
readnonatomicassign

Service providing access to Human Interface Device (HID) updates.

- (CSServiceStatus*) hidServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the HID service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSMessagingService*) messagingService
readnonatomicassign

Service providing access to messaging features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) messagingServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Messaging service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSOtherPhoneService*) otherPhoneService
readnonatomicassign

Service providing other phone mode for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) otherPhoneServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the other phone service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSPresenceService*) presenceService
readnonatomicassign

Service providing access to presence features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) presenceServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the Presence service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSServiceStatus*) pushNotificationServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the PushNotification service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (id<CSUserRegistrationDelegate>) registrationDelegate
readwritenonatomicweak

The delegate responsible for handling user registration related events.

- (id<CSUserResourceDiscoveryDelegate>) resourceDiscoveryDelegate
readwritenonatomicweak

The delegate responsible for handling resource discovery related events.

- (CSSharedControlService*) sharedControlService
readnonatomicassign

Service providing access to shared control features for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) sharedControlServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the SharedControl service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSSignalingServerGroup*) signalingServerGroup
readnonatomicassign

Returns the SignalingServerGroup containing the complete call server list used by system, it contains additional servers discovered by system from different source including the servers provided by the user.

Client application can persist it and then use it for subsequent registrations for creation of CSConnectionPolicy.

Returns
CSSignalingServerGroup object containing the complete call server list used by system.
  • user:didReceiveSignalingServerGroup:
- (CSSpaceService*) spaceService
readnonatomicassign
- (CSUnifiedPortalService*) unifiedPortalService
readnonatomicassign

Service providing access to Unified Portal features for this user.

- (CSServiceStatus*) unifiedPortalServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the UnifiedPortal service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (id<CSUserAdminEventDelegate>) userAdminDelegate
readwritenonatomicweak
- (NSString*) userId
readnonatomicassign

The user ID of the user.

- (CSVisualVoiceMailService*) visualVoiceMailService
readnonatomicassign

Service providing visual voicemail feature for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) visualVoiceMailServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the VisualVoiceMail service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
- (CSVoiceMessagingService*) voiceMessagingService
readnonatomicassign

Service providing voice messaging feature for this user.

If the user has not yet been configured this property will return nil.

- (CSServiceStatus*) voiceMessagingServiceStatus
readnonatomicassign

Returns ServiceStatus object describing whether the VoiceMessaging service is enabled.

Returns
CSServiceStatus object describing whether a certain service is enabled.
The documentation for this class was generated from the following file:
© 2016 Avaya Inc. All Rights Reserved.