Avaya Client Services API Reference (iOS)
|
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. More...
#import <CSSharedControlService.h>
Inherits NSObject.
Instance Methods | |
(void) | - activateSharedControlWithControllableEndpoint:completionHandler: |
Activates the shared control service. More... | |
(void) | - deactivateSharedControlWithCompletionHandler: |
Deactivates the shared control service. More... | |
Properties | |
id< CSSharedControlDelegate > | sharedControlDelegate |
Notifications about available endpoints and connection state changes. More... | |
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.
Access to the shared control service is provided by the SharedControlService property on the CSUser class. A Spark based shared signalling channel is established between the controlling client (soft client) and the controlled device (Desk Phone) through the Aura Session Manager, to keep call states in sync and communicate signaling messages. The Shared Control mechanism is a first party control mechanism similar to the CTI interface traditionally provided on Windows PCs except that the controlling and controlled endpoints are endpoints registered with Avaya Aura. This feature has two main entities:
Controlled Endpoint/Client/Device
- Avaya endpoints that support the shared control mechanism advertise their support by inserting "avaya-sc-enabled" tag in the contact URI they register. The clients are currently not planned to be controlled endpoints. Controlling Endpoint/Client
- when a user chooses to run the client in the shared control mode, the application does not receive incoming calls from the server but from the controlled endpoint instead. This is done so that all incoming and outgoing requests are sent over to the endpoint that is “actively” registered with Aura (the desk phone) and receives incoming calls. The client always acts as a controlling endpoint.Currently
only SIP mode is supported for Shared Control. Currently
SM is the only Avaya registrar that supports the registration in Shared Control. Currently
only Avaya 96x1 desk phones and Summit (H175) series are supported for Shared Control. The
server addresses list on the controlling and controlled endpoints should be identical to avoid registration issues. Split
media i.e.audio on controlled endpoint and video on controlling endpoint is only supported with Summit (H175) phones. The
controlled endpoint supports only one controlling endpoint in Shared Control. The latest controlling endpoint initiating the session controls the controlled endpoint. For instance: if UC client - 1 is in Shared Control with controlled endpoint, and UC client - 2 initiates Shared Control with same controlled endpoint, the session with client - 1 is ended by controlled endpoint. - (void) activateSharedControlWithControllableEndpoint: | (CSControllableEndpoint *) | endpoint | |
completionHandler: | (void(^)(NSError *error)) | completionHandler | |
Activates the shared control service.
endpoint | The controllable endpoint to be used in shared control. |
completionHandler | A block to be called when the operation is completed. Method will do nothing if the block is nil.
|
- (void) deactivateSharedControlWithCompletionHandler: | (void(^)(NSError *error)) | completionHandler |
Deactivates the shared control service.
completionHandler | A block to be called when the operation is completed. Method will do nothing if the block is nil.
|
|
readwritenonatomicweak |
Notifications about available endpoints and connection state changes.