#import <CSCallFeatureService.h>

Inherits <NSObjectNSObject>.

Instance Methods
(void)	- callFeatureServiceDidBecomeAvailable:
	Sent to indicate that call feature service is available. More...

(void)	- callFeatureServiceDidBecomeUnavailable:
	Sent to indicate that call feature service is unavailable. More...

(void)	- callFeatureService:didChangeFeatureCapability:
	Sent when the capability of a feature has changed. More...

(void)	- callFeatureService:didChangeFeatureStatus:
	Sent when the status of a feature has changed. More...

(void)	- callFeatureServiceDidChangeAvailableFeatures:
	Sent when the list of available features has changed. More...

(void)	- callFeatureService:didChangeSendAllCallsStatus:forExtension:
	Sent when the status of the send all calls feature has changed. More...

(void)	- callFeatureService:didChangeCallForwardingStatus:forExtension:destination:
	Sent when the status of the call forwarding feature has changed. More...

(void)	- callFeatureService:didChangeCallForwardingBusyNoAnswerStatus:forExtension:destination:
	Sent when the status of the call forwarding busy-no-answer feature has changed. More...

(void)	- callFeatureService:didChangeEnhancedCallForwardingStatus:forExtension:
	Sent when the status of the Enhanced Call Forwarding feature has changed. More...

(void)	- callFeatureService:didChangeEC500Status:
	Sent when the status of the EC500 feature has changed. More...

(void)	- callFeatureService:didChangeAutoCallbackStatus:
	Sent when the status of the auto callback feature has changed. More...

(void)	- callFeatureService:didChangeAutoCallbackList:
	Occurs when the list of outstanding automatic callback extensions is changed. More...

(void)	- callFeatureService:didChangeBusyIndicator:
	Sent when the status of the busy indicator object has changed. More...

(void)	- callFeatureService:didChangeCallPickupAlertStatus:
	Sent when the status of the call pickup feature has changed. More...

(void)	- didChangeTeamButtons:
	Occurs when the available team buttons list are updated. More...

(void)	- callFeatureService:didChangeBusyStatusForTeamButton:
	Occurs if the Team Button busy status is changed when the monitored station either dials or has an active call. More...

(void)	- callFeatureService:didAddIncomingCall:forTeamButton:
	Occurs when the monitored station of Team Button has an incoming ringing call. More...

(void)	- callFeatureService:didUpdateIncomingCall:forTeamButton:
	Occurs when the monitored station updated an incoming ringing call. More...

(void)	- callFeatureService:didRemoveIncomingCall:forTeamButton:
	Occurs when the incoming call to monitored station stops ringing. More...

(void)	- callFeatureService:didChangeForwardingStatusForTeamButton:
	Occurs when the forwarding status of Team Button monitored station is changed. More...

(void)	- callFeatureService:didChangeCrisisAlertStatus:
	Occurs when the status of the crisis alert feature has changed. More...

(void)	- callFeatureService:didChangeMaliciousCallTraceStatus:
	Occurs when the Malicious Call Trace status is changed (active/not active). More...

(void)	- callFeatureService:didEnableServiceObservingType:forEntity:withButtonLamp:
	Reports service observing got enabled. More...

(void)	- callFeatureServiceDidDisableServiceObserving:
	Reports service observing got disabled. More...

(void)	- callFeatureService:didChangeServiceObservingStatus:
	Reports service observing feature status changed. More...

(void)	- callFeatureService:didReceivedServiceObservingError:
	Reports an error received for service observing session. More...

Method Documentation

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didAddIncomingCall:	(CSTeamButtonIncomingCall *)	call
forTeamButton:	(CSTeamButton *)	teamButton

optional

Occurs when the monitored station of Team Button has an incoming ringing call.

The Team Button notification alert status depends on CSTeamButton::pickupRingType.

CSTeamButtonIncomingCall started ringing at the monitored station is provided. CSTeamButtonIncomingCall::pickupWithCompletionHandler: functionality is available.

Parameters

callFeatureService	The call feature service instance reporting the callback.
teamButton	The team button that has alerting calls.
call	The team button call that started alerting.

See also: CSTeamButton::pickupCapability; CSTeamButton::speedDialCapability

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeAutoCallbackList:	(NSArray< NSString * > *)	list

optional

Occurs when the list of outstanding automatic callback extensions is changed.

Parameters

callFeatureService	The call feature service instance sending the message.
list	The new list of outstanding automatic callback extensions.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeAutoCallbackStatus:	(BOOL)	enabled

optional

Sent when the status of the auto callback feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
enabled	The new state of the feature.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeBusyIndicator:	(CSBusyIndicator *)	busyIndicator

optional

Sent when the status of the busy indicator object has changed.

Parameters

callFeatureService	The call feature service instance that the callback is associated with.
busyIndicator	The changed busy indicator object.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeBusyStatusForTeamButton:	(CSTeamButton *)	teamButton

optional

Occurs if the Team Button busy status is changed when the monitored station either dials or has an active call.

A Team Button is considered Idle if all call appearances on the monitored station are either in the Idle or Ringing states. If there are bridged call appearances on the monitored station, the states "Alerting" and "In-Use" are interpreted by the CM as equivalent to Idle.

Parameters

callFeatureService	The call feature service instance reporting the callback.
teamButton	The team button with busy status updated.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeCallForwardingBusyNoAnswerStatus:	(BOOL)	enabled
forExtension:	(NSString *)	extension
destination:	(NSString *)	destination

optional

Sent when the status of the call forwarding busy-no-answer feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
enabled	The new state of the feature.
extension	The extension for which the feature has been enabled or disabled. The value is nil if the feature has been enabled or disabled for the user's local extension.
destination	The new forwarding destination.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeCallForwardingStatus:	(BOOL)	enabled
forExtension:	(NSString *)	extension
destination:	(NSString *)	destination

optional

Sent when the status of the call forwarding feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
enabled	The new state of the feature.
extension	The extension for which the feature has been enabled or disabled. The value is nil if the feature has been enabled or disabled for the user's local extension.
destination	The new forwarding destination.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeCallPickupAlertStatus:	(CSCallPickupAlertStatus *)	callPickupFeatureStatus

optional

Sent when the status of the call pickup feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
callPickupFeatureStatus	The call pickup feature alert status

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeCrisisAlertStatus:	(CSCrisisAlert *)	crisisAlert

optional

Occurs when the status of the crisis alert feature has changed.

The status can also be retrieved using CSCallFeatureService::crisisAlert method.

When any user places an emergency call then the system raises the crisis alert which is presented to the watchers (attendants).

If a user is not logged in while an active alert is raised in the system, the alert will be presented to the user upon login.

If multiple users are watchers for the crisis alert, all the watchers will be presented with crisis alert.

There can be only one active alert on the watcher's console. Subsequent alerts will be queued on the server. When the attendant clears the active alert, next queued alert will be presented.

See also: CSCrisisAlert; - clearCrisisAlertWithCompletionHandler: (CSCallFeatureService)

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeEC500Status:	(BOOL)	enabled

optional

Sent when the status of the EC500 feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
enabled	The new state of the feature.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeEnhancedCallForwardingStatus:	(CSEnhancedCallForwardingStatus *)	featureStatus
forExtension:	(NSString *)	extension

optional

Sent when the status of the Enhanced Call Forwarding feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
featureStatus	The updated feature status information.
extension	The extension for which the feature has been enabled or disabled. The value is nil if the feature has been enabled or disabled for the user's local extension.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeFeatureCapability:	(CSFeatureType)	featureType

optional

Sent when the capability of a feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
featureType	The feature for which capability has changed.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeFeatureStatus:	(CSFeatureStatusParameters *)	featureStatus

optional

Sent when the status of a feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
featureStatus	The updated feature status information.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeForwardingStatusForTeamButton:	(CSTeamButton *)	teamButton

optional

Occurs when the forwarding status of Team Button monitored station is changed.

See also: CSTeamButton::forwardingEnabled; CSTeamButton::forwardingDestination

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeMaliciousCallTraceStatus:	(BOOL)	active

optional

Occurs when the Malicious Call Trace status is changed (active/not active).

Feature status is changed to active when Malicious Call Trace controller took control over a malicious call trace. Feature status is changed to not active when Malicious Call Trace controller deactivated a malicious call trace.

Parameters

callFeatureService	The call feature service instance sending the message.
active	The new status of the feature (active/not active).

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeSendAllCallsStatus:	(BOOL)	enabled
forExtension:	(NSString *)	extension

optional

Sent when the status of the send all calls feature has changed.

Parameters

callFeatureService	The call feature service instance sending the message.
enabled	The new state of the feature.
extension	The extension for which the feature has been enabled or disabled. The value is nil if the feature has been enabled or disabled for the user's local extension.

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didChangeServiceObservingStatus:	(CSServiceObservingStatusParameters *)	serviceObservingStatusParameters

optional

Reports service observing feature status changed.

Parameters

callFeatureService	instance of call feature service callback is associated with
serviceObservingStatusParameters	service observing status parameters

See also: CSServiceObservingStatusParameters

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didEnableServiceObservingType:	(CSServiceObservingType)	type
forEntity:	(NSString *)	entity
withButtonLamp:	(CSButtonLampState)	buttonLamp

optional

Reports service observing got enabled.

Parameters

callFeatureService	instance of call feature service callback is associated with
type	The Service Observing type
entity	The observed entity
buttonLamp	The Service Observing button lamp type

See also: CSCallFeatureService::startServiceObservingwithTypewithLocationcompletionHandler:

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didReceivedServiceObservingError:	(NSError *)	errorCode

optional

Reports an error received for service observing session.

Client SDK raises this event if it receives an error from the server during the service observing session. e.g. supervisor is trying to start a service observing session by providing an invalid agent id. e.g. observed user has activated the exclusion during the service observing call.

Parameters

callFeatureService	instance of call feature service callback is associated with
errorCode	An error object describing the service observing error

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didRemoveIncomingCall:	(CSTeamButtonIncomingCall *)	call
forTeamButton:	(CSTeamButton *)	teamButton

optional

Occurs when the incoming call to monitored station stops ringing.

CSTeamButtonIncomingCall stopped ringing at the monitored station is provided. CSTeamButtonIncomingCall::pickupWithCompletionHandler: functionality is available.

Parameters

callFeatureService	The call feature service instance reporting the callback.
teamButton	The team button that has alerting calls.
call	The team button call that stopped alerting.

See also: CSTeamButton::pickupCapability; CSTeamButton::speedDialCapability

- (void) callFeatureService:	(CSCallFeatureService *)	callFeatureService
didUpdateIncomingCall:	(CSTeamButtonIncomingCall *)	call
forTeamButton:	(CSTeamButton *)	teamButton

optional

Occurs when the monitored station updated an incoming ringing call.

The Team Button notification alert status depends on CSTeamButton::pickupRingType. CSTeamButtonIncomingCall::pickupWithCompletionHandler: functionality is available.

Parameters

callFeatureService	The call feature service instance reporting the callback.
teamButton	The team button that has alerting calls.
call	The team button call that changed the alert parameters.

See also: CSTeamButton::pickupCapability; CSTeamButton::speedDialCapability

- (void) callFeatureServiceDidBecomeAvailable: (CSCallFeatureService *) callFeatureService

optional

Sent to indicate that call feature service is available.

Parameters

callFeatureService The call feature service instance sending the message.

- (void) callFeatureServiceDidBecomeUnavailable: (CSCallFeatureService *) callFeatureService

optional

Sent to indicate that call feature service is unavailable.

Parameters

callFeatureService The call feature service instance sending the message.

- (void) callFeatureServiceDidChangeAvailableFeatures: (CSCallFeatureService *) callFeatureService

optional

Sent when the list of available features has changed.

Parameters

callFeatureService The call feature service instance sending the message.

- (void) callFeatureServiceDidDisableServiceObserving: (CSCallFeatureService *) callFeatureService

optional

Reports service observing got disabled.

Parameters

callFeatureService instance of call feature service callback is associated with

See also: - stopServiceObserving: (CSCallFeatureService)

- (void) didChangeTeamButtons: (CSCallFeatureService *) callFeatureService

optional

Occurs when the available team buttons list are updated.

See also: CSCallFeatureService::teamButtons

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

CSCallFeatureService.h

Instance Methods

Method Documentation