Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

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

Instance Methods | List of all members
<CSSharedControlDelegate> Protocol Reference

Describes methods that are implemented by the delegate of a `CSSharedControlService`. More...

`#import <CSSharedControlService.h>`

Inherits <NSObject>.

## Instance Methods
(void) | - sharedControlService:didFindControllableEndpoints:
| Occurs when a controllable endpoint is available to do Shared Control with, i.e. More...
(void) | - sharedControlService:didUpdateControllableEndpoints:
| Occurs when there is an update in list of controllable endpoints. More...
(void) | - sharedControlServiceDidDetectAllControllableEndpointsUnavailable:
| Occurs when no controllable endpoint is available to do Shared Control with, i.e. More...
(void) | - sharedControlService:didConnectToEndpoint:
| Occurs when the shared control link with the controllable endpoint is established and a user can control the desk phone now. More...
(void) | - sharedControlService:didDisconnectFromEndpoint:withError:
| Occurs when the shared control link with the controllable endpoint is ended gracefully or down because of network issues. More...
(void) | - sharedControlService:didFailToConnectToEndpoint:withError:
| Occurs when shared control link with the controllable endpoint could not be setup. More...

## Detailed Description

Describes methods that are implemented by the delegate of a `CSSharedControlService`.

## Method Documentation

- (void) sharedControlService: |  | (CSSharedControlService *) | sharedControlService
didConnectToEndpoint: |  | (CSControllableEndpoint *) | endpoint

Occurs when the shared control link with the controllable endpoint is established and a user can control the desk phone now.

This is typically when the RegisterApplicationResponse is received from the desk phone.

Parameters

  sharedControlService | service which sent notification.
  endpoint | connected endpoint.

- (void) sharedControlService: |  | (CSSharedControlService *) | sharedControlService
didDisconnectFromEndpoint: |  | (CSControllableEndpoint *) | endpoint
withError: |  | (NSError *) | error

Occurs when the shared control link with the controllable endpoint is ended gracefully or down because of network issues.

Parameters

  sharedControlService | service which sent notification.
  endpoint | disconnected endpoint.
  error | error description if disconnect is result of error.

- (void) sharedControlService: |  | (CSSharedControlService *) | sharedControlService
didFailToConnectToEndpoint: |  | (CSControllableEndpoint *) | endpoint
withError: |  | (NSError *) | error

Occurs when shared control link with the controllable endpoint could not be setup.

This is typically when the shared control link cannot be setup with the controlled endpoint due to various reasons.

Parameters

  sharedControlService | service which sent notification.
  endpoint | endpoint for which setup has failed.
  error | error object describing a problem.

- (void) sharedControlService: |  | (CSSharedControlService *) | sharedControlService
didFindControllableEndpoints: |  | (NSArray *) | endpoints

Occurs when a controllable endpoint is available to do Shared Control with, i.e.

when the desk phone is logged in and there was no desk phone logged in before.

Parameters

  sharedControlService | service which sent notification.
  endpoints | array containing `CSControllableEndpoint` objects.

- (void) sharedControlService: |  | (CSSharedControlService *) | sharedControlService
didUpdateControllableEndpoints: |  | (NSArray *) | endpoints

Occurs when there is an update in list of controllable endpoints.

This update can be addition or removal of an endpoint, i.e. the desk phone is logged in or out.

Parameters

  sharedControlService | service which sent notification.
  endpoints | array containing `CSControllableEndpoint` objects.

- (void) sharedControlServiceDidDetectAllControllableEndpointsUnavailable: |  | (CSSharedControlService *) | sharedControlService |

Occurs when no controllable endpoint is available to do Shared Control with, i.e.

there is no desk phone logged in.

Parameters

  sharedControlService | service which sent notification.

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

- CSSharedControlService.h