|
Avaya Client Services API Reference (OS X)
|
Represents team button feature. More...
#import <CSTeamButton.h>
Inherits NSObject.
Instance Methods | |
| (void) | - speedDialWithOverride:completionHandler: |
| Initiates team button speed dial. More... | |
| (void) | - setPersonalizedLabel:completionHandler: |
| Updates the Team Button with personalized label given by user. More... | |
Properties | |
| NSString * | label |
| Returns the the label of team button. More... | |
| NSString * | ownerExtension |
| Returns the extension of monitored station. More... | |
| CSForwardingOverride | forwardingOverride |
| Specifies whether the forwarding destination of monitored station will be ignored by Team Button speed dial invocation if any of forwarding features are enabled on the monitored station. More... | |
| NSString * | forwardingDestination |
| Returns the rerouting destination of the monitored station. More... | |
| BOOL | forwardingEnabled |
| Shows whether the monitored station has forwarding enabled. More... | |
| BOOL | pickupByGoingOffHookEnabled |
| Indicates whether to pickup the currently selected call in the screen after going off hook when the Team Pickup screen is displayed. More... | |
| BOOL | silentIfActive |
| Indicates whether the Team Button audible alert should not be played if the monitoring station has at least one call appearance active. More... | |
| BOOL | busy |
| Indicates whether the monitored station has an active call. More... | |
| NSTimeInterval | delayInterval |
| Specifies the delay interval in seconds the team button alert should be delayed by if the CSTeamButton::pickupRingType is set to DELAYED. More... | |
| CSRingType | pickupRingType |
| Returns the team button call pickup ring types if configured. More... | |
| NSArray< CSTeamButtonIncomingCall * > * | teamButtonIncomingCalls |
| List of the incoming calls alerting on monitored extension. More... | |
| CSCapability * | pickupCapability |
| A capability object indicating whether the user can pick up the Team button call. More... | |
| CSCapability * | speedDialCapability |
| A capability object indicating whether the user can initiate speed dial using the Team button. More... | |
Represents team button feature.
A monitoring station can perform speed dial or pick up an incoming call ringing on the monitoring extension. This object is provided with notification whenever the status changes.
| - (void) setPersonalizedLabel: | (NSString *) | featureLabel | |
| completionHandler: | (void(^)(NSError *error)) | handler | |
Updates the Team Button with personalized label given by user.
| featureLabel | The personalized label to be set. |
| handler | A block to be called when the operation is completed.
|
| - (void) speedDialWithOverride: | (BOOL) | overrideDestination | |
| completionHandler: | (void(^)(NSError *error)) | handler | |
Initiates team button speed dial.
| overrideDestination | Specifies whether the forwarding destination of monitored station will be overridden depending on the override policy. |
| handler | A block to be called when the operation is completed.
|
|
readnonatomicassign |
Indicates whether the monitored station has an active call.
|
readnonatomicassign |
Specifies the delay interval in seconds the team button alert should be delayed by if the CSTeamButton::pickupRingType is set to DELAYED.
|
readnonatomicassign |
Returns the rerouting destination of the monitored station.
|
readnonatomicassign |
Shows whether the monitored station has forwarding enabled.
Rerouting is considered active if Send All Calls, Call Forward or Enhanced Call Forward have active forwarding.
|
readnonatomicassign |
Specifies whether the forwarding destination of monitored station will be ignored by Team Button speed dial invocation if any of forwarding features are enabled on the monitored station.
If set to ask, the client can override the forwarding destination using the override argument of CSTeamButton::speedDialWithOverride:completionHandler:
|
readnonatomicassign |
Returns the the label of team button.
|
readnonatomicassign |
Returns the extension of monitored station.
|
readnonatomicassign |
Indicates whether to pickup the currently selected call in the screen after going off hook when the Team Pickup screen is displayed.
|
readatomicassign |
A capability object indicating whether the user can pick up the Team button call.
Allowed when the monitoring station has at least one incoming ringing call. Mutual exclusive with CSTeamButton::speedDialCapability.
|
readnonatomicassign |
Returns the team button call pickup ring types if configured.
The possible values are with the according CM setting values: Off - No ringing - 'n' On - Continuous ringing - 'r' Delayed - Delayed ringing - 'd' Abbreviated - Abbreviated (single) ringing - 'a' InterCom - Intercom ringing - 'i' Delayed ring type means the team button alert should be delayed by delay time specified CSTeamButton::delayInterval.
|
readnonatomicassign |
Indicates whether the Team Button audible alert should not be played if the monitoring station has at least one call appearance active.
|
readatomicassign |
A capability object indicating whether the user can initiate speed dial using the Team button.
Allowed when the monitoring station has no incoming ringing calls. Mutual exclusive with CSTeamButton::pickupCapability.
|
readnonatomicassign |
List of the incoming calls alerting on monitored extension.
