Avaya Client Services API Reference (OS X)
|
The CSCallFeatureService object is accessible from the CSUser object, providing access to additional business communication features. More...
#import <CSCallFeatureService.h>
Inherits NSObject.
Instance Methods | |
(NSArray *) | - availableFeatures |
Gets all the calls features available to the user. More... | |
(NSArray *) | - availableBusyIndicators |
Gets all the busy indicators available to the user. More... | |
(NSArray *) | - availableAutodials |
Gets all the autodials available to the user. More... | |
(NSArray< CSFeatureStatusParameters * > *) | - availableHuntGroupBusyPositionFeatures |
Gets a list of configured hunt-group-busy-position feature buttons for the user. More... | |
(void) | - updateAutodial:completionHandler: |
Sends out a request in the network to update a configured Autodial button. More... | |
(BOOL) | - isFeatureAvailable: |
Returns a Boolean value indicating whether the specified feature is available. More... | |
(CSCapability *) | - capabilityForFeature: |
Returns a capability object indicating whether the specified feature is available. More... | |
(CSFeatureStatusParameters *) | - featureStatusParametersForType:withExtension: |
Returns feature status parameters for a specified extension and feature type. More... | |
(CSFeatureStatusParameters *) | - featureStatusParametersForFeature: |
Returns feature status parameters for a specified CSFeatureParameters object. More... | |
(void) | - invokeFeature:completionHandler: |
Invokes a feature that takes no parameters. More... | |
(void) | - invokeFeature:parameters:completionHandler: |
Invokes a feature. More... | |
(CSCapability *) | - sendAllCallsCapabilityForExtension: |
A capability object indicating whether the send all calls feature is available for the specified extention. More... | |
(BOOL) | - isSendAllCallsEnabledForExtension: |
Returns a Boolean value indicating whether the send all calls feature is enabled for the specified extension. More... | |
(void) | - setSendAllCallsEnabled:completionHandler: |
Enables or disables sending all calls to coverage. More... | |
(void) | - setSendAllCallsEnabled:forExtension:completionHandler: |
Enables or disables sending all calls to coverage for another extension. More... | |
(CSCapability *) | - callForwardingCapabilityForExtension: |
A capability object indicating whether the call forwarding feature is available for the specified extension. More... | |
(BOOL) | - isCallForwardingEnabledForExtension: |
Returns a Boolean value indicating whether the call forwarding feature is enabled for the specified extension. More... | |
(NSString *) | - callForwardingDestinationForExtension: |
Returns the call forwarding destination for the specified extension, if any. More... | |
(void) | - setCallForwardingEnabled:destination:completionHandler: |
Enables or disables forwarding of all calls to the specified destination. More... | |
(void) | - setCallForwardingEnabled:forExtension:destination:completionHandler: |
Enables or disables forwarding of all calls to the specified destination for another extension. More... | |
(CSCapability *) | - callForwardingBusyNoAnswerCapabilityForExtension: |
A capability object indicating whether the call forwarding busy-no-answer feature is available for the specified extension. More... | |
(BOOL) | - isCallForwardingBusyNoAnswerEnabledForExtension: |
Returns a Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the specified extension. More... | |
(NSString *) | - callForwardingBusyNoAnswerDestinationForExtension: |
Returns the call forwarding busy-no-answer destination for the specified extension, if any. More... | |
(void) | - setCallForwardingBusyNoAnswerEnabled:destination:completionHandler: |
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination. More... | |
(void) | - setCallForwardingBusyNoAnswerEnabled:forExtension:destination:completionHandler: |
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination for another extension. More... | |
(CSCapability *) | - enhancedCallForwardingCapabilityForExtension: |
A capability object indicating whether the Enhanced Call Forwarding feature is available for the specified extension. More... | |
(CSEnhancedCallForwardingStatus *) | - enhancedCallForwardingStatusForExtension: |
Returns the Enhanced Call Forwarding status for the specified extension. More... | |
(void) | - setEnhancedCallForwardingStatus:completionHandler: |
Sets the Enhanced Call Forwarding status for the user's local extension. More... | |
(void) | - setEnhancedCallForwardingStatus:forExtension:completionHandler: |
Sets the Enhanced Call Forwarding status for another extension. More... | |
(void) | - limitCalls:completionHandler: |
Enables or disables Limit Number of Concurrent Calls feature. More... | |
(void) | - setExclusionEnabled:completionHandler: |
Enables or disables exclusion for the active call. More... | |
(void) | - setEC500Enabled:completionHandler: |
Enables or disables EC500. More... | |
(void) | - setEC500Enabled:withDestinationNumber:completionHandler: |
Enables EC500 with the mobile phone number provided or disables EC500. More... | |
(void) | - extendCallWithCompletionHandler: |
Extends the active call to the off-pbx destinations configured for the user's extension, namely EC500. More... | |
(void) | - cancelExtendCallWithCompletionHandler: |
Cancels a pending extension of the active call to the off-pbx destinations configured for the user's extension. More... | |
(void) | - parkCallWithCompletionHandler: |
Parks the active call. More... | |
(void) | - unparkCallWithCompletionHandler: |
Unparks a call previously parked at the user's extension. More... | |
(void) | - unparkCallAtExtension:completionHandler: |
Unparks a call previously parked at the specified extension. More... | |
(BOOL) | - isAutoCallbackEnabledForDestination: |
A Boolean value indicating whether auto callback feature is enabled for the specified destination. More... | |
(void) | - setAutoCallbackEnabled:completionHandler: |
Enables an automatic callback for the last call if it received a busy signal or was unanswered. More... | |
(void) | - setAutoCallbackEnabled:forDestination:completionHandler: |
Enables or disables automatic callback for the specified destination. More... | |
(void) | - whisperPageToExtension:completionHandler: |
Starts a whisper page to another user that is on an active call. More... | |
(void) | - pickupCallAtExtension:completionHandler: |
Picks up a call ringing at the specified extension (directed call pickup). More... | |
(void) | - pickupGroupCallWithCompletionHandler: |
Picks up a call for the user's pickup group (group call pickup). More... | |
(void) | - pickupCallForGroup:completionHandler: |
Picks up a call for the specified pickup group (extended group call pickup). More... | |
(void) | - blockCallingPartyNumberToDestination:completionHandler: |
Starts a call to the specified destination with the user's calling party number information blocked if the call is made over a trunk. More... | |
(void) | - unblockCallingPartyNumberToDestination:completionHandler: |
Starts a call to the specified destination with the user's calling party number information unblocked if it would normally be blocked. More... | |
(void) | - startPriorityCallToDestination:completionHandler: |
Starts a priority call to the specified destination. More... | |
(void) | - completePreemptionForCall:completionHandler: |
Completes call preemption after user acknowledges the continuous preemption tone. More... | |
(void) | - setHuntGroupBusyPositionEnabled:forHuntGroup:completionHandler: |
Enables or Disables Hunt Group Busy Position feature for a specified hunt group number. More... | |
(void) | - setPersonalizedLabel:forFeature:completionHandler: |
Updates the feature with personalized label given by user. More... | |
(CSCapability *) | - huntGroupBusyPositionCapabilityForHuntGroupNumber: |
A capability object indicating whether the hunt-group-busy-position feature is available for the specified hunt group number. More... | |
(void) | - clearCrisisAlertWithCompletionHandler: |
Clears crisis alert for the watcher. More... | |
(void) | - activateMaliciousCallTraceWithCompletionHandler: |
Activate Malicious Call Trace feature for incoming active call. More... | |
(void) | - makeNoHoldConferenceWithDestination:completionHandler: |
Start No Hold Conference for active call, or add new participant to existing conference. More... | |
(void) | - cancelNoHoldConferenceWithCompletionHandler: |
Cancels the No Hold Conference invocation. More... | |
(void) | - startServiceObserving:withType:withLocation:completionHandler: |
Starts service observing. More... | |
(void) | - changeServiceObservingMode:completionHandler: |
Change the mode of service observing session. More... | |
(void) | - stopCoachingSession: |
Stops coaching session. More... | |
(void) | - stopServiceObserving: |
Stops service observing. More... | |
(CSCapability *) | - callRecordingCapabilityForActionType: |
Returns a capability object indicating whether a particular call recording action is allowed. More... | |
(void) | - performCallRecordingWithActionType:completionHandler: |
Perform call recording operation with specific action type. More... | |
(void) | - moveCall: |
Call Handover to move a call to user's simultaneous/twin clients. More... | |
(void) | - retrieveCall: |
Call Handover to retrieve a call from user's simultaneous/twin clients. More... | |
Properties | |
id< CSCallFeatureServiceDelegate > | delegate |
The delegate responsible for handling call feature events. More... | |
BOOL | isServiceAvailable |
A Boolean value indicating whether the Call Feature Service is available. More... | |
CSCapability * | sendAllCallsCapability |
A capability object indicating whether the send all calls feature is available for the user's local extension. More... | |
BOOL | sendAllCallsEnabled |
A Boolean value indicating whether the send all calls feature is enabled for the user's local extension. More... | |
CSCapability * | callForwardingCapability |
A capability object indicating whether the call forwarding feature is available for the user's local extension. More... | |
BOOL | callForwardingEnabled |
A Boolean value indicating whether the call forwarding feature is enabled for the user's local extension. More... | |
NSString * | callForwardingDestination |
The call forwarding destination for the user's local extension, if any. More... | |
BOOL | internalTwinningEnabled |
A Boolean value indicating whether the internal twinning feature is enabled. More... | |
CSCapability * | callForwardingBusyNoAnswerCapability |
A capability object indicating whether the call forwarding busy-no-answer feature is available for the user's local extension. More... | |
BOOL | callForwardingBusyNoAnswerEnabled |
A Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the user's local extension. More... | |
NSString * | callForwardingBusyNoAnswerDestination |
The call forwarding busy-no-answer destination for the user's local extension, if any. More... | |
CSCapability * | enhancedCallForwardingCapability |
A capability object indicating whether the Enhanced Call Forwarding feature is available for the user's local extension. More... | |
CSEnhancedCallForwardingStatus * | enhancedCallForwardingStatus |
The Enhanced Call Forwarding status for the user's local extension, if any. More... | |
CSCapability * | limitCallsCapability |
A capability object indicating whether the Limit Number of Concurrent Calls feature is available. More... | |
CSCapability * | exclusionCapability |
A capability object indicating whether the exclusion feature is available. More... | |
CSCapability * | EC500Capability |
A capability object indicating whether the EC500 feature is available. More... | |
BOOL | EC500Enabled |
A Boolean value indicating whether the EC500 feature is enabled. More... | |
CSCapability * | extendCallCapability |
A capability object indicating whether the extend call feature is available. More... | |
CSCapability * | parkCallCapability |
A capability object indicating whether the call park feature is available. More... | |
CSCapability * | unparkCallCapability |
A capability object indicating whether the call unpark feature is available. More... | |
CSCapability * | autoCallbackCapability |
A capability object indicating whether the auto callback feature is available. More... | |
BOOL | autoCallbackEnabled |
A Boolean value indicating whether the auto callback feature is enabled. More... | |
NSArray * | autoCallbackList |
The list of outstanding automatic callback destinations in case autoCallbackDestination capability is enabled, empty list otherwise. More... | |
CSCapability * | whisperPageCapability |
A capability object indicating whether the whisper page feature is available. More... | |
CSCapability * | pickupCallAtExtensionCapability |
A capability object indicating whether the directed call pickup feature is available. More... | |
CSCapability * | pickupGroupCallCapability |
A capability object indicating whether the group call pickup feature is available. More... | |
CSCapability * | pickupCallForGroupCapability |
A capability object indicating whether the extended group call pickup feature is available. More... | |
CSCapability * | blockCallingPartyNumberCapability |
A capability object indicating whether the block calling party number feature is available. More... | |
CSCapability * | unblockCallingPartyNumberCapability |
A capability object indicating whether the unblock calling party number feature is available. More... | |
CSCapability * | priorityCallCapability |
A capability object indicating whether the priority call feature is available. More... | |
NSArray< CSTeamButton * > * | teamButtons |
List of team buttons assigned to the station. More... | |
CSCrisisAlert * | crisisAlert |
Returns crisis alert details. More... | |
CSCapability * | maliciousCallTraceCapability |
A capability object indicating whether Malicious Call Trace feature is available for incoming active call. More... | |
BOOL | maliciousCallTraceActive |
A Boolean value indicating whether Malicious Call Trace feature is activated. More... | |
CSCapability * | noHoldConferenceCapability |
A capability object indicating whether No Hold Conference feature is available for active call. More... | |
CSCapability * | noHoldConferenceCancelCapability |
A capability object indicating whether No Hold Conference feature can be canceled. More... | |
NSString * | noHoldConferenceDestination |
The destination extension for No Hold Conference feature button. More... | |
CSServiceObservingStatusParameters * | serviceObservingStatusParameters |
Returns service observing feature status parameters. More... | |
CSCapability * | serviceObservingCapability |
Returns an indication as to whether the service observing is available. More... | |
The CSCallFeatureService object is accessible from the CSUser object, providing access to additional business communication features.
The CSCallFeatureService object provides a set of APIs that allow application developers to implement advanced SIP telephony features.
In general, administered features can be invoked depending upon the current state of the system.
The client application is notified about status updates on features reported by the call feature service through handlers that the application has registered on the CSCallFeatureService object. These updates may be the result of local operations on the CSCallFeatureService object as well as remote changes initiated by either the service/server or other end users.
- (void) activateMaliciousCallTraceWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Activate Malicious Call Trace feature for incoming active call.
When malicious call trace controller (human) presses "mct-contr" button, callback didChangeMaliciousCallTraceStatus(true) is invoked. When the controller deactivates a malicious call trace, callback didChangeMaliciousCallTraceStatus(false) is invoked. Feature is deactivated by pressing the feature deactivation code by same client, which pressed "mct-contr" button. "mct-contr" button is implemented in CM for h.323 only.
handler | A block to be called when the operation is completed.
|
- (NSArray *) availableAutodials |
Gets all the autodials available to the user.
- (NSArray *) availableBusyIndicators |
Gets all the busy indicators available to the user.
- (NSArray *) availableFeatures |
Gets all the calls features available to the user.
- (NSArray<CSFeatureStatusParameters *> *) availableHuntGroupBusyPositionFeatures |
Gets a list of configured hunt-group-busy-position feature buttons for the user.
- (void) blockCallingPartyNumberToDestination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Starts a call to the specified destination with the user's calling party number information blocked if the call is made over a trunk.
destination | The destination to call. |
handler | A block to be called when the operation is completed.
|
- (CSCapability *) callForwardingBusyNoAnswerCapabilityForExtension: | (NSString *) | extension |
A capability object indicating whether the call forwarding busy-no-answer feature is available for the specified extension.
extension | The extension for which to query the availability of the feature. |
- (NSString *) callForwardingBusyNoAnswerDestinationForExtension: | (NSString *) | extension |
Returns the call forwarding busy-no-answer destination for the specified extension, if any.
extension | The extension for which to query the forwarding destination. |
- (CSCapability *) callForwardingCapabilityForExtension: | (NSString *) | extension |
A capability object indicating whether the call forwarding feature is available for the specified extension.
extension | The extension for which to query the availability of the feature. |
- (NSString *) callForwardingDestinationForExtension: | (NSString *) | extension |
Returns the call forwarding destination for the specified extension, if any.
extension | The extension for which to query the forwarding destination. |
- (CSCapability *) callRecordingCapabilityForActionType: | (CSCallRecordingActionType) | type |
Returns a capability object indicating whether a particular call recording action is allowed.
type | The call recording action type. |
- (void) cancelExtendCallWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Cancels a pending extension of the active call to the off-pbx destinations configured for the user's extension.
An invocation of extendCallWithCompletionHandler:
is not considered successful until the call has been answered on one of the user's off-pbx destinations. Until this occurs cancelExtendCallWithCompletionHandler:
may be used to cancel the pending extension of the active call.
handler | A block to be called when the operation is completed.
|
- (void) cancelNoHoldConferenceWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Cancels the No Hold Conference invocation.
The feature can be canceled after invocation of No Hold Conference and during the time it's ringing on the party that is to be added to the No Hold Conference.
handler | A block to be called when the operation is completed.
|
- (CSCapability *) capabilityForFeature: | (CSFeatureType) | featureType |
Returns a capability object indicating whether the specified feature is available.
featureType | The feature to query. |
- (void) changeServiceObservingMode: | (CSServiceObservingMode) | mode | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Change the mode of service observing session.
mode | The Service Observing mode. |
handler | An Object that wants to learn about the result of change service observing mode operation i.e., whether it was successful. |
- (void) clearCrisisAlertWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Clears crisis alert for the watcher.
Multiple users may place emergency call. As a result, the system can have multiple crisis alerts raised. The first crisis alert is presented to all the watchers (attendants), remaining alerts are queued on the server.
If the admin has configured the system in Single User Response mode, then clearing the alert on one of the watchers will clear the alert from all watchers.
The next queued alert will be presented to all the watchers.
If the admin has configured the system in Every User Response mode then if one of the watchers clears the alert, the next alert from the server will be presented only to that user. Other watchers will still have the same crisis alert active on their devices.
In order to receive the next queued crisis alert every watcher has to clear active crisis alert on his device.
handler | A block to be called when the operation is completed.
|
- (void) completePreemptionForCall: | (CSCall *) | preemptedCall | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Completes call preemption after user acknowledges the continuous preemption tone.
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 ring-back precedence tone.
Application must start playing preemption tone upon receipt of event call:didPreempt:isPreemptionCompletionRequiredByClient: (CSCallDelegate-p) and stop preemption tone before calling completeCallPreemption when user acknowledges the preemption. However when other end receives preemption application must stop tone after 3 seconds and call:didPreempt:isPreemptionCompletionRequiredByClient: (CSCallDelegate-p) 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.
preemptedCall | call which was preempted and received didPreempt event. |
handler | A completion handler that receives the result of the operation. |
- (CSCapability *) enhancedCallForwardingCapabilityForExtension: | (NSString *) | extension |
A capability object indicating whether the Enhanced Call Forwarding feature is available for the specified extension.
extension | The extension for which to query the availability of the feature. |
- (CSEnhancedCallForwardingStatus *) enhancedCallForwardingStatusForExtension: | (NSString *) | extension |
Returns the Enhanced Call Forwarding status for the specified extension.
- (void) extendCallWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Extends the active call to the off-pbx destinations configured for the user's extension, namely EC500.
An invocation of extendCallWithCompletionHandler:
is not considered successful until the call has been answered on one of the user's off-pbx destinations. Until this occurs cancelExtendCallWithCompletionHandler:
may be used to cancel the pending extension of the active call.
handler | A block to be called when the operation is completed.
|
- (CSFeatureStatusParameters *) featureStatusParametersForFeature: | (CSFeatureParameters *) | featureParams |
Returns feature status parameters for a specified CSFeatureParameters object.
If feature type is not configured for specified extension, this API will return empty object of type FeatureStatusParameters with CSFeatureStatusUndefined status in it. Other status are CSFeatureStatusOn/CSFeatureStatusOff/CSFeatureStatusAlerting.
featureParams | The CSFeatureParameters object to query feature status. |
- (CSFeatureStatusParameters *) featureStatusParametersForType: | (CSFeatureType) | featureType | |
withExtension: | (NSString *) | ownerExtension | |
Returns feature status parameters for a specified extension and feature type.
If feature type is not configured for specified extension, this API will return empty object of type FeatureStatusParameters with CSFeatureStatusUndefined status in it. Other status are CSFeatureStatusOn/CSFeatureStatusOff/CSFeatureStatusAlerting.
featureType | The feature to query. |
ownerExtension | Extension number |
This method is deprecated please use featureStatusParametersForFeature: .
- (CSCapability *) huntGroupBusyPositionCapabilityForHuntGroupNumber: | (NSInteger) | huntGroupNumber |
A capability object indicating whether the hunt-group-busy-position feature is available for the specified hunt group number.
huntGroupNumber | The hunt group number for which to query the availability of the feature. |
- (void) invokeFeature: | (CSFeatureType) | featureType | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Invokes a feature that takes no parameters.
featureType | The feature to invoke. |
handler | A block to be called when the operation is completed.
|
- (void) invokeFeature: | (CSFeatureType) | featureType | |
parameters: | (CSFeatureInvocationParameters *) | featureParameters | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Invokes a feature.
featureType | The feature to invoke. |
featureParameters | The parameters supporting this feature invocation. |
handler | A block to be called when the operation is completed.
|
- (BOOL) isAutoCallbackEnabledForDestination: | (NSString *) | destination |
A Boolean value indicating whether auto callback feature is enabled for the specified destination.
Use this method only if AutoCallback destination is editable, otherwise use CSCallFeatureService::autoCallbackEnabled property.
destination | The destination to query auto-callback enablement for. |
- (BOOL) isCallForwardingBusyNoAnswerEnabledForExtension: | (NSString *) | extension |
Returns a Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the specified extension.
extension | The extension for which to query the status of the feature. |
- (BOOL) isCallForwardingEnabledForExtension: | (NSString *) | extension |
Returns a Boolean value indicating whether the call forwarding feature is enabled for the specified extension.
extension | The extension for which to query the status of the feature. |
- (BOOL) isFeatureAvailable: | (CSFeatureType) | featureType |
Returns a Boolean value indicating whether the specified feature is available.
featureType | The feature to query. |
- (BOOL) isSendAllCallsEnabledForExtension: | (NSString *) | extension |
Returns a Boolean value indicating whether the send all calls feature is enabled for the specified extension.
extension | The extension for which to query the status of the feature. |
- (void) limitCalls: | (BOOL) | enabled | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables Limit Number of Concurrent Calls feature.
Limit Number of Concurrent Calls feature: Users can use this to limit the number of concurrent calls at a station to one call, where normally multiple call appearances can terminate at the station.
enabled | If YES Limit Number of Concurrent Calls is enabled. If NO Limit Number of Concurrent Calls is disabled. |
handler | A block to be called when the operation is completed.
|
- (void) makeNoHoldConferenceWithDestination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Start No Hold Conference for active call, or add new participant to existing conference.
No Hold Conference feature button allows a user to set up a conference call without interrupting the current conversation. The called party is automatically added to the conference as soon as they answer. Successful completionHandler is invoked after invited party answered, or the feature was canceled. Current active call will be transformed into the conference. The number dialed by the user is sent as a message and not as tone so that the digits are not heard by any party on the call. So No Hold Conference button should be used if it's important that no tones are heard by participants, and/or remote user should not be held. In other cases AddParticipantFromCall/AddParticipant methods of Conference interface should be used. No Hold Conference is Avaya Communication Manager feature, which is not available in other environments.
destination | Network address of the person who is being added to the conference call. |
handler | A block to be called when the operation is completed.
|
- (void) moveCall: | (void(^)(NSError *error)) | handler |
Call Handover to move a call to user's simultaneous/twin clients.
handler | An Object that wants to learn about the result of call handover operation i.e., whether it was successful. |
- (void) parkCallWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Parks the active call.
A parked call may later be unparked from another extension.
handler | A block to be called when the operation is completed.
|
- (void) performCallRecordingWithActionType: | (CSCallRecordingActionType) | type | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Perform call recording operation with specific action type.
type | The call recording action type. |
handler | An Object that wants to learn about the result of call recording operation i.e., whether it was successful. |
- (void) pickupCallAtExtension: | (NSString *) | extension | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Picks up a call ringing at the specified extension (directed call pickup).
extension | The extension to pick up the call from. |
handler | A block to be called when the operation is completed.
|
- (void) pickupCallForGroup: | (NSInteger) | groupNumber | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Picks up a call for the specified pickup group (extended group call pickup).
groupNumber | The group number to pick up the call from. |
handler | A block to be called when the operation is completed.
|
- (void) pickupGroupCallWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Picks up a call for the user's pickup group (group call pickup).
handler | A block to be called when the operation is completed.
|
- (void) retrieveCall: | (void(^)(NSError *error)) | handler |
Call Handover to retrieve a call from user's simultaneous/twin clients.
handler | An Object that wants to learn about the result of call handover operation i.e., whether it was successful. |
- (CSCapability *) sendAllCallsCapabilityForExtension: | (NSString *) | extension |
A capability object indicating whether the send all calls feature is available for the specified extention.
extension | The extension for which to query the availability of the feature. |
- (void) setAutoCallbackEnabled: | (BOOL) | enabled | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables an automatic callback for the last call if it received a busy signal or was unanswered.
When the station becomes able to receive a call the user who invoked this feature will be called back automatically.
enabled | If YES automatic callback is enabled. If NO automatic callback is disabled. |
handler | A block to be called when the operation is completed.
|
- (void) setAutoCallbackEnabled: | (BOOL) | enabled | |
forDestination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables automatic callback for the specified destination.
When the destination user becomes able to receive a call the user who invoked this feature will be called back automatically. Use this method only if autoCallback destination is editable, otherwise use setAutoCallbackEnabled:completionHandler: method.
enabled | If YES automatic callback is enabled. If NO automatic callback is disabled. |
destination | The destination to enable auto-callback for. |
handler | A block to be called when the operation is completed.
|
- (void) setCallForwardingBusyNoAnswerEnabled: | (BOOL) | enabled | |
destination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination.
enabled | If YES forwarding is enabled. If NO forwarding is disabled. |
destination | The destination number to forward calls to. |
handler | A block to be called when the operation is completed.
|
- (void) setCallForwardingBusyNoAnswerEnabled: | (BOOL) | enabled | |
forExtension: | (NSString *) | extension | |
destination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables forwarding of calls that receive a busy signal or are not answered to the specified destination for another extension.
enabled | If YES forwarding is enabled. If NO forwarding is disabled. |
extension | The extension to update call forwarding settings for. |
destination | The destination number to forward calls to. |
handler | A block to be called when the operation is completed.
|
- (void) setCallForwardingEnabled: | (BOOL) | enabled | |
destination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables forwarding of all calls to the specified destination.
enabled | If YES forwarding is enabled. If NO forwarding is disabled. |
destination | The destination number to forward calls to. |
handler | A block to be called when the operation is completed.
|
- (void) setCallForwardingEnabled: | (BOOL) | enabled | |
forExtension: | (NSString *) | extension | |
destination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables forwarding of all calls to the specified destination for another extension.
enabled | If YES forwarding is enabled. If NO forwarding is disabled. |
extension | The extension to enable or disable forwarding for. |
destination | The destination number to forward calls to. |
handler | A block to be called when the operation is completed.
|
- (void) setEC500Enabled: | (BOOL) | enabled | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables EC500.
enabled | If YES EC500 is enabled. If NO EC500 is disabled. |
handler | A block to be called when the operation is completed.
|
- (void) setEC500Enabled: | (BOOL) | enabled | |
withDestinationNumber: | (NSString *) | number | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables EC500 with the mobile phone number provided or disables EC500.
Use this method only if EC500 destination is editable, otherwise use setEC500Enabled:completionHandler: method.
enabled | If YES EC500 is enabled. If NO EC500 is disabled. |
number | A mobile phone number. The destination can be any external number the user is able to dial normally. It should include any prefix if necessary. The number is not relevant if enabled=false. |
handler | A block to be called when the operation is completed.
|
- (void) setEnhancedCallForwardingStatus: | (CSEnhancedCallForwardingStatus *) | enhancedCallForwardingStatus | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Sets the Enhanced Call Forwarding status for the user's local extension.
enhancedCallForwardingStatus | The new enhanced call forwarding status, specifying the busy, no reply, and unconditional call forwarding settings. For IP Office, the same destination number should be provided for call forward busy and no reply. |
handler | A block to be called when the operation is completed.
|
- (void) setEnhancedCallForwardingStatus: | (CSEnhancedCallForwardingStatus *) | enhancedCallForwardingStatus | |
forExtension: | (NSString *) | extension | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Sets the Enhanced Call Forwarding status for another extension.
enhancedCallForwardingStatus | The new enhanced call forwarding status, specifying the busy, no reply, and unconditional call forwarding settings. For IP Office, the same destination number should be provided for call forward busy and no reply. |
extension | The extension to update call forwarding settings for. |
handler | A block to be called when the operation is completed.
|
- (void) setExclusionEnabled: | (BOOL) | enabled | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables exclusion for the active call.
Exclusion prevents any other users from bridging onto the call, and drops any other users who are already bridged onto the call.
enabled | If YES exclusion is enabled. If NO exclusion is disabled. |
handler | A block to be called when the operation is completed.
|
- (void) setHuntGroupBusyPositionEnabled: | (BOOL) | enabled | |
forHuntGroup: | (NSInteger) | huntGroupNumber | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or Disables Hunt Group Busy Position feature for a specified hunt group number.
When enabled, user will not receive any calls targeted for that hunt group. In order to receive calls on the hunt group, feature needs to be disabled again.
enabled | If YES hunt group busy position is enabled. If NO hunt group busy position is disabled. |
huntGroupNumber | The hunt group number for which feature is enabled or disabled. |
handler | A block to be called when the operation is completed.
|
- (void) setPersonalizedLabel: | (NSString *) | featureLabel | |
forFeature: | (CSFeatureParameters *) | featureParams | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Updates the feature with personalized label given by user.
featureLabel | The personalized label to be set. |
featureParams | The CSFeatureParameters object providing details about feature to update. |
handler | A block to be called when the operation is completed.
|
- (void) setSendAllCallsEnabled: | (BOOL) | enabled | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables sending all calls to coverage.
enabled | If YES send all calls is enabled. If NO send all calls is disabled. |
handler | A block to be called when the operation is completed.
|
- (void) setSendAllCallsEnabled: | (BOOL) | enabled | |
forExtension: | (NSString *) | extension | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Enables or disables sending all calls to coverage for another extension.
enabled | If YES send all calls is enabled. If NO send all calls is disabled. |
extension | The extension to enable or disable send all calls for. |
handler | A block to be called when the operation is completed.
|
- (void) startPriorityCallToDestination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Starts a priority call to the specified destination.
Priority calls have distinct alerting and typically do not go to coverage.
destination | The destination to call. |
handler | A block to be called when the operation is completed.
|
- (void) startServiceObserving: | (NSString *) | entity | |
withType: | (CSServiceObservingType) | type | |
withLocation: | (NSInteger) | location | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Starts service observing.
entity | The extension of the endpoint currently observed. |
type | The Service Observing type. |
location | The location number associated with the observed VDN. The valid range is 0-2000. The value 0 means that the service observing type is not "By Location" |
handler | An Object that wants to learn about the result of start service observing operation i.e., whether it was successful. |
- (void) stopCoachingSession: | (void(^)(NSError *error)) | handler |
Stops coaching session.
handler | An Object that wants to learn about the result of stop coaching session operation i.e., whether it was successful. |
- (void) stopServiceObserving: | (void(^)(NSError *error)) | handler |
Stops service observing.
handler | An Object that wants to learn about the result of stop service observing operation i.e., whether it was successful. |
- (void) unblockCallingPartyNumberToDestination: | (NSString *) | destination | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Starts a call to the specified destination with the user's calling party number information unblocked if it would normally be blocked.
destination | The destination to call. |
handler | A block to be called when the operation is completed.
|
- (void) unparkCallAtExtension: | (NSString *) | extension | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Unparks a call previously parked at the specified extension.
extension | The extension from which to retrieve the parked call. |
handler | A block to be called when the operation is completed.
|
- (void) unparkCallWithCompletionHandler: | (void(^)(NSError *error)) | handler |
Unparks a call previously parked at the user's extension.
handler | A block to be called when the operation is completed.
|
- (void) updateAutodial: | (CSAutodial *) | updatedAutodial | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Sends out a request in the network to update a configured Autodial button.
updatedAutodial | User modified autodial button |
handler | A block to be called when the operation is completed.
|
- (void) whisperPageToExtension: | (NSString *) | extension | |
completionHandler: | (void(^)(NSError *error)) | handler | |
Starts a whisper page to another user that is on an active call.
extension | The extension to start a whisper page to. |
handler | A block to be called when the operation is completed.
|
|
readatomicassign |
A capability object indicating whether the auto callback feature is available.
|
readatomicassign |
A Boolean value indicating whether the auto callback feature is enabled.
|
readnonatomicassign |
The list of outstanding automatic callback destinations in case autoCallbackDestination capability is enabled, empty list otherwise.
|
readatomicassign |
A capability object indicating whether the block calling party number feature is available.
|
readatomicassign |
A capability object indicating whether the call forwarding busy-no-answer feature is available for the user's local extension.
|
readatomicassign |
The call forwarding busy-no-answer destination for the user's local extension, if any.
|
readatomicassign |
A Boolean value indicating whether the call forwarding busy-no-answer feature is enabled for the user's local extension.
|
readatomicassign |
A capability object indicating whether the call forwarding feature is available for the user's local extension.
|
readatomicassign |
The call forwarding destination for the user's local extension, if any.
|
readatomicassign |
A Boolean value indicating whether the call forwarding feature is enabled for the user's local extension.
|
readnonatomicassign |
Returns crisis alert details.
If there is an active crisis alert, then the CSCrisisAlert object contains crisis alert status as ON with details of the user who initiated the alert like user location, time of alert raised, etc.
If there isn't any active crisis alert, the feature status will be OFF.
If the Crisis Alert feature button is not configured by the admin, then nil will be returned.
There can be only one active alert on the attendant's console at any given device at a time. Subsequent alerts raised by users will be queued on the server. When the attendant clears the active alert, the next queued alert will be presented to the watcher.
|
readwritenonatomicweak |
The delegate responsible for handling call feature events.
|
readatomicassign |
A capability object indicating whether the EC500 feature is available.
|
readatomicassign |
A Boolean value indicating whether the EC500 feature is enabled.
|
readatomicassign |
A capability object indicating whether the Enhanced Call Forwarding feature is available for the user's local extension.
|
readnonatomicassign |
The Enhanced Call Forwarding status for the user's local extension, if any.
|
readatomicassign |
A capability object indicating whether the exclusion feature is available.
|
readatomicassign |
A capability object indicating whether the extend call feature is available.
|
readatomicassign |
A Boolean value indicating whether the internal twinning feature is enabled.
|
readnonatomicassign |
A Boolean value indicating whether the Call Feature Service is available.
|
readatomicassign |
A capability object indicating whether the Limit Number of Concurrent Calls feature is available.
|
readatomicassign |
A Boolean value indicating whether Malicious Call Trace feature is activated.
|
readatomicassign |
A capability object indicating whether Malicious Call Trace feature is available for incoming active call.
|
readatomicassign |
A capability object indicating whether No Hold Conference feature can be canceled.
|
readatomicassign |
A capability object indicating whether No Hold Conference feature is available for active call.
|
readatomicassign |
The destination extension for No Hold Conference feature button.
|
readatomicassign |
A capability object indicating whether the call park feature is available.
|
readatomicassign |
A capability object indicating whether the directed call pickup feature is available.
|
readatomicassign |
A capability object indicating whether the extended group call pickup feature is available.
|
readatomicassign |
A capability object indicating whether the group call pickup feature is available.
|
readatomicassign |
A capability object indicating whether the priority call feature is available.
|
readatomicassign |
A capability object indicating whether the send all calls feature is available for the user's local extension.
|
readatomicassign |
A Boolean value indicating whether the send all calls feature is enabled for the user's local extension.
|
readnonatomicassign |
Returns an indication as to whether the service observing is available.
|
readnonatomicassign |
Returns service observing feature status parameters.
If service observing feature is enabled then the CSServiceObservingStatusParameters object contains details of service observing feature.
|
readnonatomicassign |
List of team buttons assigned to the station.
This list represents those addresses/endpoints/users participated in this leg of the call and does not represent the union of all users who participated in this call. The local user may have conversed with those remoteParticipants listed in callEvents records.
|
readatomicassign |
A capability object indicating whether the unblock calling party number feature is available.
|
readatomicassign |
A capability object indicating whether the call unpark feature is available.
|
readatomicassign |
A capability object indicating whether the whisper page feature is available.