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
<CSCallServiceDelegate> Protocol Reference

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

`#import <CSCallService.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - callService:didReceiveIncomingCall:
| Sent when an incoming call is received. More...
(void) | - callService:didCreateCall:
| Sent when a call is created. More...
(void) | - callService:didReceiveNotificationOfUndeliveredIncomingCall:
| Sent when the user is informed of an incoming call that was not delivered to the local application due to an active server feature, such as call forwarding or send all calls. More...
(void) | - callService:didRemoveCall:
| Sent when a call previously associated with the call service has been removed. More...
(void) | - callServiceDidChangeCapabilities:
| Sent when the service's capabilties have changed. More...
(void) | - callService:didChangeActiveCall:
| Sent when a there is change in active call. More...
(void) | - callService:didReceiveRequestToStartCall:withVideoMode:
| Called to report the receipt of a CTI call request informing the local client that a new video call should be started with the specified video direction. More...
(void) | - callService:didReceiveRequestToAcceptCall:withVideoMode:
| Called to report the receipt of a CTI call request informing the local client that an incoming video call should be accepted with the specified video direction. More...

## Detailed Description

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

## Method Documentation

- (void) callService: |  | (CSCallService *) | callService
didChangeActiveCall: |  | (CSCall *) | call

Sent when a there is change in active call.

An active call is local and in established state. The active call is null if there is no call, or all local calls are in held state.

Parameters

  callService | The call service sending the message.
  call | new call, or null if there is no active call

- (void) callService: |  | (CSCallService *) | callService
didCreateCall: |  | (CSCall *) | call

Sent when a call is created.

Parameters

  callService | The call service sending the message.
  call | The created call.

- (void) callService: |  | (CSCallService *) | callService
didReceiveIncomingCall: |  | (CSCall *) | call

Sent when an incoming call is received.

Parameters

  callService | The call service sending the message.
  call | The incoming call.

- (void) callService: |  | (CSCallService *) | callService
didReceiveNotificationOfUndeliveredIncomingCall: |  | (CSCall *) | call

Sent when the user is informed of an incoming call that was not delivered to the local application due to an active server feature, such as call forwarding or send all calls.

If desired the application can use the information in this session object to update its call history records. Since the session is already ended no further events will be sent for it.

Parameters

  callService | The call service sending the message.
  call | The undelivered call.

- (void) callService: |  | (CSCallService *) | callService
didReceiveRequestToAcceptCall: |  | (CSCall *) | call
withVideoMode: |  | (CSVideoMode) | videoMode

Called to report the receipt of a CTI call request informing the local client that an incoming video call should be accepted with the specified video direction.

It should be noted that video call answering requires the client application initialize video resources such a video rendering view and a camera, which is why this callback is required to be handled by the application in order to complete the call setup. This callback is not reported for handling answering of an incoming audio call request, as the audio call request is automatically handled by the Client SDK using the user-selected (or default) microphone and playback devices. For video calls, because the video rendering surface is directly under the client application's control, answering of an incoming video call request cannot be automatically handled by the Client SDK. If the answer call request is for a bidirectional video, but the local camera device cannot be initialized, the client application should proceed with establishing a receive-only video call by first calling call.setVideoMode(CSVideoModeReceiveOnly), and then calling call.accept(). If, for some reason, the client application is unable to answer the call with receive-only video, it should proceed with answering the call with audio-only, by first calling call.setVideoMode(CSVideoModeDisable), and then call.accept(). Failure to answer the incoming call in a timely fashion will result in timeout of the network request and call setup failure.

Parameters

  callService | The call service sending the message.
  call | Incoming call on which accept() should be called after UI video resources are initialized.
  videoMode | Required video mode/direction. Used to initialize the UI video resources.

- (void) callService: |  | (CSCallService *) | callService
didReceiveRequestToStartCall: |  | (CSCall *) | call
withVideoMode: |  | (CSVideoMode) | videoMode

Called to report the receipt of a CTI call request informing the local client that a new video call should be started with the specified video direction.

It should be noted that video call start requires the client application initialize video resources such a video rendering view and a camera, which is why this callback is required to be handled by the application in order to complete the call setup. This callback is not reported for an incoming audio call creation request, as the audio call creation request is automatically handled by the Client SDK, using the user-selected (or default) microphone and playback devices. If the incoming video call request is for a bidirectional video call, but the local camera device cannot be initialized, the client application should proceed with establishing a receive-only video call by first calling call.setVideoMode(CSVideoModeReceiveOnly), and then call.start(). If, for some reason, the client application is unable to create a receive-only video call, it should proceed with creating an audio-only call, by first calling call.setVideoMode(CSVideoModeDisable), and then call.start(). Failure to create a call will result in timeout of the network request and will cause call setup failure at the network based CTI application.

Parameters

  callService | The call service sending the message.
  call | Outgoing call on which start() should be called after UI video resources are initialized.
  videoMode | Required video mode/direction. Used to initialize the UI video resources.

- (void) callService: |  | (CSCallService *) | callService
didRemoveCall: |  | (CSCall *) | call

Sent when a call previously associated with the call service has been removed.

Parameters

  callService | The call service sending the message.
  call | The removed call.

- (void) callServiceDidChangeCapabilities: |  | (CSCallService *) | callService |

Sent when the service's capabilties have changed.

e.g VideoCapability, VoIPCallingCapability.

Parameters

  callService | The call service sending the message.

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

- CSCallService.h