Avaya Client Services API Reference (iOS)
Instance Methods | Properties | List of all members
CSSharedControlService Class Reference

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< CSSharedControlDelegatesharedControlDelegate
 Notifications about available endpoints and connection state changes. More...
 

Detailed Description

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:

Attention
Following are the current limitations in Shared Control:
  • 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.

Method Documentation

- (void) activateSharedControlWithControllableEndpoint: (CSControllableEndpoint *)  endpoint
completionHandler: (void(^)(NSError *error))  completionHandler 

Activates the shared control service.

Parameters
endpointThe controllable endpoint to be used in shared control.
completionHandlerA block to be called when the operation is completed. Method will do nothing if the block is nil.
  • error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
Note
Local calls will be destroyed when system in the activating shared control link state. Switching from This Computer mode to Desk Phone Mode - if a user wants to continue the call, a user can bridge - on to that call from the desk phone before switching since MDA is ON and the "Max. Simultaneous Devices" setting is set to 2 (for Shared Control).
- (void) deactivateSharedControlWithCompletionHandler: (void(^)(NSError *error))  completionHandler

Deactivates the shared control service.

Parameters
completionHandlerA block to be called when the operation is completed. Method will do nothing if the block is nil.
  • error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
Note
Local calls will be destroyed when the system in the deactivating shared control link state. Switching from Desk Phone mode to This Computer mode i.e. deactivating the shared control service - any soft client calls are lost, but the call stays up on the controlled device. As soon as the soft client successfully switches to This Computer, a user can bridge on to the call by joining, essentially have audio coming into the soft client since MDA is ON and the "Max. Simultaneous Devices" setting is set to 2.

Property Documentation

- (id<CSSharedControlDelegate>) sharedControlDelegate
readwritenonatomicweak

Notifications about available endpoints and connection state changes.


The documentation for this class was generated from the following file: