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

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

`#import <CSCall.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - callDidStart:
| Sent when the call has been started. More...
(void) | - callDidBeginRemoteAlerting:withEarlyMedia:
| Sent when the outgoing call begins alerting at the remote end. More...
(void) | - callDidQueue:
| Sent when an outgoing call is queued by a network server. More...
(void) | - callDidRedirect:
| Sent when an outgoing call is redirected by the network servers to a different destination (e.g., when EC500 forking takes place or call is covered to voice mail). More...
(void) | - callDidBeginEstablishing:
| The call is being answered before the network side call is completely set up. More...
(void) | - callDidEstablish:
| Sent when the outgoing call has been established. More...
(void) | - callDidHold:
| Sent when the call has been held. More...
(void) | - callDidUnhold:
| Sent when the call has been unheld. More...
(void) | - callDidRemoteHold:
| Sent when the call has been held on the remote end. More...
(void) | - callDidRemoteUnhold:
| Sent when the call has been unheld on the remote end. More...
(void) | - callDidJoin:
| Sent when the call has been successfully joined and transitioned from a remote call to a local call. More...
(void) | - callWasIgnored:
| Sent when the incoming call has been ignored. More...
(void) | - callDidDeny:
| Sent when the incoming call has been successfully denied. More...
(void) | - callDidEnd:reason:
| Sent when the call has ended. More...
(void) | - call:didFailWithError:
| Sent when the call has failed. More...
(void) | - call:didMuteAudio:
| Sent when the call's audio is muted or unmuted. More...
(void) | - call:didSilenceSpeaker:
| Sent when speaker is silenced or unsilenced for the call. More...
(void) | - call:didUpdateVideoChannels:
| Sent when the video channels have been updated. More...
(void) | - call:didRemoteRemoveVideoChannel:
| Sent when a video channel has been removed by the remote end. More...
(void) | - callDidReceiveVideoAddRequest:
| Sent when the remote end has requested that video be added to the call. More...
(void) | - call:didAcceptVideoAddRequest:
| Sent when the incoming video add request has been accepted by the local end. More...
(void) | - callDidDenyVideoAddRequest:
| Sent when the incoming video add request has been denied by the local end. More...
(void) | - callDidTimeoutVideoAddRequest:
| Sent when the incoming video add request has timed out. More...
(void) | - call:didChangeRemoteAddress:displayName:
| Sent when the remote address or display name for the call has changed. More...
(void) | - call:didChangeConferenceStatus:
| Sent when the conference status of the call has changed. More...
(void) | - callServiceDidBecomeAvailable:
| Sent when a signaling path has been established for the call. More...
(void) | - callServiceDidBecomeUnavailable:
| Sent when the signaling path for the call has been lost. More...
(void) | - callDidChangeCapabilities:
| Sent when the the call's capabilities have changed, e.g., as a result of a call state change or other internal events. More...
(void) | - callParticipantMatchedContactsChanged:
| Sent when the the remote participant's matched contacts changed. More...
(void) | - callDidRequestDialToneForDigitCollection:
| For a call in the off-hook dialing state, indicates that the dial plan data has specified that the application should resume playing dial tone until another digit is entered. More...
(void) | - callDidCompleteDigitCollection:
| For a call in the off-hook dialing state, indicates that digit collection has completed and the call will now be initiated using the collected digits. More...
(void) | - callLongHoldTimeDidExpire:
| Sent when the call was kept on hold for longer than the hold recall timeout administered on Avaya Communication Manager (CM). More...
(void) | - call:didChangePrecedenceLevel:
| Sent when the precedence level for the call has changed. More...
(void) | - call:didPreempt:isPreemptionCompletionRequiredByClient:
| Sent to inform application about call being preempted. More...
(void) | - call:didChangeAllowedVideoDirection:
| Sent when the allowed video direction has changed. More...
(void) | - call:didChangeExtraProperties:
| Occurs when the extra properties associated with the call have changed. More...
(void) | - call:didChangeRecordingState:
| Sent when the call recording started or stopped. More...
(void) | - call:didChangeSecureIndication:
| Sent when the end to end security status of the call gets changed from/to secure/unsecure. More...
(void) | - call:didChangeVerificationStatus:
| Sent when the verification status of the call is changed. More...

## Detailed Description

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

## Method Documentation

- (void) call: |  | (CSCall *) | call
didAcceptVideoAddRequest: |  | (CSVideoChannel *) | videoChannel

Sent when the incoming video add request has been accepted by the local end.

Parameters

  videoChannel | The video channel used to accept video.
  call | The call sending the message.

- (void) call: |  | (CSCall *) | call
didChangeAllowedVideoDirection: |  | (CSAllowedVideoDirection) | videoDirection
| optional

Sent when the allowed video direction has changed.

Parameters

  call | The call sending the message.
  videoDirection | new allowed video direction.

- (void) call: |  | (CSCall *) | call
didChangeConferenceStatus: |  | (BOOL) | isConference

Sent when the conference status of the call has changed.

For example, as a result of adding a participant a two-party call may have been transitioned to a conference call, or a conference call transitioned to a two-party call as result of a participant being dropped.

Parameters

  call | The call sending the message.
  isConference | The new conference status.

- (void) call: |  | (CSCall *) | call
didChangeExtraProperties: |  | (NSDictionary *) | extraProperties
| optional

Occurs when the extra properties associated with the call have changed.

The list of extra properties is provided as part of the callback, but can also be queried by accessing to the extraProperties property.

Parameters

  call | The call sending the message.
  extraProperties | Complete list of extra properties associated with the call.

- (void) call: |  | (CSCall *) | call
didChangePrecedenceLevel: |  | (CSPrecedenceLevel) | newPrecedenceLevel
| optional

Sent when the precedence level for the call has changed.

Parameters

  call | The call sending the message.
  newPrecedenceLevel | the new precedence level of call.

See also
  CSPrecedenceLevel

- (void) call: |  | (CSCall *) | call
didChangeRecordingState: |  | (CSCallRecordingState) | recordingState
| optional

Sent when the call recording started or stopped.

Parameters

  call | The call sending the message.
  recordingState | The new call recording state.

- (void) call: |  | (CSCall *) | call
didChangeRemoteAddress: |  | (NSString *) | remoteAddress
displayName: |  | (NSString *) | displayName

Sent when the remote address or display name for the call has changed.

Parameters

  call | The call sending the message.
  remoteAddress | The new remote address.
  displayName | The new display name.

- (void) call: |  | (CSCall *) | call
didChangeSecureIndication: |  | (BOOL) | isSecure
| optional

Sent when the end to end security status of the call gets changed from/to secure/unsecure.

Parameters

  call | The call sending the message.
  isSecure | The boolean value indicating whether the call is secure or not.

- (void) call: |  | (CSCall *) | call
didChangeVerificationStatus: |  | (CSVerificationStatus) | verificationStatus
| optional

Sent when the verification status of the call is changed.

Parameters

  call | The call sending the message.
  verificationStatus | The verification status of the call.

- (void) call: |  | (CSCall *) | call
didFailWithError: |  | (NSError *) | error

Sent when the call has failed.

This method is sent when the call has failed either as a result of a local error or as a result of an error received from the network (e.g., when a call attempt to an unreachable address is made). The specific reason for failure is identified by `error`. It should be noted that a call that has failed is not automatically ended by the signaling engine. The application must still call -[CSCall end] to end the failed call. This is done so that a UI implementation that is line-oriented can keep the line appearance occupied while the call is in failed state.

Parameters

  call | The call sending the message.
  error | An error object describing the failure.

- (void) call: |  | (CSCall *) | call
didMuteAudio: |  | (BOOL) | muted

Sent when the call's audio is muted or unmuted.

Parameters

  call | The call sending the message.
  muted | The new audio mute state.

- (void) call: |  | (CSCall *) | call
didPreempt: |  | (CSPreemptionReason) | preemptionReason
isPreemptionCompletionRequiredByClient: |  | (BOOL) | isPreemptionCompletionRequiredByClient
| optional

Sent to inform application about call being preempted.

This would trigger application to start either continuous preemption tone OR three seconds preemption tone based on flag isPreemptionCompletionRequiredByClient and call state.

Call preemption occurs when a precedence call is sent to a preemptable endpoint that is busy with a call of lower precedence and has no idle appearances. This causes the lower precedence call to be preempted, regardless of whether the lower precedence call and the new higher precedence call are of the same media type. When preemption occurs, the active busy user receive a continuous preemption tone until user acknowledges the preemption by invoking complete preemption method and the other party receives a preemption tone for a minimum of 3 seconds. After acknowledging the preemption, the extension to which the precedence call is directed will be provided with precedence ringing and the calling party will receive an audible ringback precedence tone.

Application must start playing preemption tone upon receipt of event onCallPreempted and stop preemption tone before calling completePreemptionForCall:completionHandler: (CSCallFeatureService) when user acknowledges the preemption. However when other end receives preemption application must stop tone after 3 seconds and completePreemptionForCall:completionHandler: (CSCallFeatureService) is NOT needed since there is no precedence call is directed at this end, other end is free and ready to receive any other new call while tone is being played.

Parameters

  call | Call object that the callback is associated with, the same call object should be used for completing the preemption.
  preemptionReason | the reason why this call was preempted.
  isPreemptionCompletionRequiredByClient | indicates if application needs complete call preemption.

When isPreemptionCompletionRequiredByClient is true, Application must inform system when user acknowledges the preemption after continuous preemption tone is being played because active busy user's call is preempted. This is done by calling method completePreemptionForCall:completionHandler: (CSCallFeatureService). After user acknowledges the preemption, that also means application would stop preemption tone.

When isPreemptionCompletionRequiredByClient is false, Application needs to play three seconds preemption tone after active or outgoing alerting call is preempted.

See also
  - completePreemptionForCall:completionHandler: (CSCallFeatureService)
  CSPreemptionReason

- (void) call: |  | (CSCall *) | call
didRemoteRemoveVideoChannel: |  | (CSVideoChannel *) | videoChannel

Sent when a video channel has been removed by the remote end.

Parameters

  call | The call sending the message.
  videoChannel | The removed video channel.

- (void) call: |  | (CSCall *) | call
didSilenceSpeaker: |  | (BOOL) | silenced

Sent when speaker is silenced or unsilenced for the call.

Parameters

  call | The call sending the message.
  silenced | The new speaker silence state.

- (void) call: |  | (CSCall *) | call
didUpdateVideoChannels: |  | (NSArray *) | videoChannels

Sent when the video channels have been updated.

Parameters

  call | The call sending the message.
  videoChannels | The updated video channels.

- (void) callDidBeginEstablishing: |  | (CSCall *) | call |

The call is being answered before the network side call is completely set up.

This can happen when, for example, a VoIP push notification is processed to create a Call object to alert the end user without the underlying network resources. If the end user accepts the incoming call before the call is received over the signaling network, this method is called to let the client application know of the call progress.

- (void) callDidBeginRemoteAlerting: |  | (CSCall *) | call
withEarlyMedia: |  | (BOOL) | hasEarlyMedia

Sent when the outgoing call begins alerting at the remote end.

In SIP this corresponds to the call receiving a 180 or 183 response from the network. It should be noted that this method may be sent multiple times during initiating an outgoing call as a result of changes to early media availability and/or redirections. Application developers should not make assumptions about exact ordering of provisional responses, as the sequence depends on different call routing features/topologies.

Parameters

  call | The call sending the message.
  hasEarlyMedia | Indicates whether early media is associated with the call.

- (void) callDidChangeCapabilities: |  | (CSCall *) | call |

Sent when the the call's capabilities have changed, e.g., as a result of a call state change or other internal events.

Parameters

  call | The call sending the message.

- (void) callDidCompleteDigitCollection: |  | (CSCall *) | call |
| optional

For a call in the off-hook dialing state, indicates that digit collection has completed and the call will now be initiated using the collected digits.

- (void) callDidDeny: |  | (CSCall *) | call |

Sent when the incoming call has been successfully denied.

Parameters

  call | The call sending the message.

- (void) callDidDenyVideoAddRequest: |  | (CSCall *) | call |

Sent when the incoming video add request has been denied by the local end.

Parameters

  call | The call sending the message.

- (void) callDidEnd: |  | (CSCall *) | call
reason: |  | (CSCallEndReason) | reason

Sent when the call has ended.

Parameters

  call | The call sending the message.
  reason | The reason of a call end.

- (void) callDidEstablish: |  | (CSCall *) | call |

Sent when the outgoing call has been established.

In SIP this corresponds to the call receiving a 200 response from the network.

Parameters

  call | The call sending the message.

- (void) callDidHold: |  | (CSCall *) | call |

Sent when the call has been held.

Parameters

  call | The call sending the message.

- (void) callDidJoin: |  | (CSCall *) | call |

Sent when the call has been successfully joined and transitioned from a remote call to a local call.

Parameters

  call | The call sending the message.

- (void) callDidQueue: |  | (CSCall *) | call |

Sent when an outgoing call is queued by a network server.

In SIP this callback happens as a result of receiving SIP 182 provisional response. In Avaya's SIP solution, this response is received in contact center environment, when the call is placed in a VDN queue, waiting to be connected to a live agent.

Parameters

  call | The call sending the message.

- (void) callDidReceiveVideoAddRequest: |  | (CSCall *) | call |

Sent when the remote end has requested that video be added to the call.

Parameters

  call | The call sending the message.

- (void) callDidRedirect: |  | (CSCall *) | call |

Sent when an outgoing call is redirected by the network servers to a different destination (e.g., when EC500 forking takes place or call is covered to voice mail).

In SIP, this callback happens when 181 provisional response is received. It should be noted that this notice depends on the capabilities of the network servers, and some servers may redirect a call without providing a specific redirection notice.

Parameters

  call | The call sending the message.

- (void) callDidRemoteHold: |  | (CSCall *) | call |

Sent when the call has been held on the remote end.

Parameters

  call | The call sending the message.

- (void) callDidRemoteUnhold: |  | (CSCall *) | call |

Sent when the call has been unheld on the remote end.

Parameters

  call | The call sending the message.

- (void) callDidRequestDialToneForDigitCollection: |  | (CSCall *) | call |
| optional

For a call in the off-hook dialing state, indicates that the dial plan data has specified that the application should resume playing dial tone until another digit is entered.

- (void) callDidStart: |  | (CSCall *) | call |

Sent when the call has been started.

Parameters

  call | The call sending the message.

- (void) callDidTimeoutVideoAddRequest: |  | (CSCall *) | call |

Sent when the incoming video add request has timed out.

Parameters

  call | The call sending the message.

- (void) callDidUnhold: |  | (CSCall *) | call |

Sent when the call has been unheld.

Parameters

  call | The call sending the message.

- (void) callLongHoldTimeDidExpire: |  | (CSCall *) | call |
| optional

Sent when the call was kept on hold for longer than the hold recall timeout administered on Avaya Communication Manager (CM).

Upon receipt of this event, the SDK's client application is responsible for presenting (alerting) the event to the user.

Parameters

  call | The call sending the message.

- (void) callParticipantMatchedContactsChanged: |  | (CSCall *) | call |

Sent when the the remote participant's matched contacts changed.

e.g., new contacts added, deleted or update.

Parameters

  call | The call sending the message.

- (void) callServiceDidBecomeAvailable: |  | (CSCall *) | call |

Sent when a signaling path has been established for the call.

Parameters

  call | The call sending the message.

- (void) callServiceDidBecomeUnavailable: |  | (CSCall *) | call |

Sent when the signaling path for the call has been lost.

Parameters

  call | The call sending the message.

- (void) callWasIgnored: |  | (CSCall *) | call |

Sent when the incoming call has been ignored.

Parameters

  call | The call sending the message.

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

- CSCall.h