Avaya Client Services API Reference (iOS)
Instance Methods | Properties | List of all members
CSCustomizedButton Class Reference

The parameters that can be present in a customized button. More...

#import <CSCustomizedButton.h>

Inherits NSObject.

Instance Methods

(instancetype) - initWithConfiguredLocation:customizedLocation:buttonType:isAgentFeature:featureType:applicationName:lineOwner:lineID:featureParameter:uniqueAddressForMatching:contactNumber:personalizedLabel:canSetPersonalizedLabel:
 Constructs a CSCustomizedButton object from the specified parameters. More...
 
(instancetype) - initWithButtonType:
 
(instancetype) - initWithUniqueAddressForMatching:contactNumber:
 

Properties

NSInteger configuredLocation
 Returns the physical button index as configured on SMGR. More...
 
NSInteger customizedLocation
 Returns the button index as customized on application's button module by the user. More...
 
CSButtonType buttonType
 Returns the button type for the button being customized. More...
 
BOOL isAgentFeature
 Indicates whether the button being customized is an agent feature when the button being customized is a feature. More...
 
NSInteger featureType
 Returns the feature type of the feature when the button being customized is a feature. More...
 
NSString * applicationName
 Returns the application name of the application when the button being customized is an application. More...
 
NSString * lineOwner
 Returns the line owner of the line-appearance when the button being customized is a line-appearance. More...
 
NSString * lineID
 Returns the line ID of the line-appearance when the button being customized is a line-appearance. More...
 
NSString * featureParameter
 Returns any additional parameter of the feature when the button being customized is a feature. More...
 
NSString * uniqueAddressForMatching
 Returns the unique address of a contact when the button being customized is a contact. More...
 
NSString * contactNumber
 Returns the contact number of a contact when the button being customized is a contact. More...
 
NSString * personalizedLabel
 Returns the personalized label for the customized button. More...
 
BOOL canSetPersonalizedLabel
 Indicates whether the set personalized label operation is allowed. More...
 

Detailed Description

The parameters that can be present in a customized button.

Method Documentation

- (instancetype) initWithButtonType: (CSButtonType buttonType
- (instancetype) initWithConfiguredLocation: (NSInteger)  configuredLocation
customizedLocation: (NSInteger)  customizedLocation
buttonType: (CSButtonType buttonType
isAgentFeature: (BOOL)  isAgentFeature
featureType: (NSInteger)  featureType
applicationName: (NSString *)  applicationName
lineOwner: (NSString *)  lineOwner
lineID: (NSString *)  lineID
featureParameter: (NSString *)  featureParameter
uniqueAddressForMatching: (NSString *)  uniqueAddressForMatching
contactNumber: (NSString *)  contactNumber
personalizedLabel: (NSString *)  personalizedLabel
canSetPersonalizedLabel: (BOOL)  canSetPersonalizedLabel 

Constructs a CSCustomizedButton object from the specified parameters.

Parameters
configuredLocationThe physical button index as configured on SMGR.
customizedLocationThe button index as customized on application's button module by the user.
buttonTypeThe button type.
isAgentFeatureIndicates whether the button is an agent feature.
featureTypeThe feature type of the feature.
applicationNameThe application name of the application.
lineOwnerThe line owner of the line-appearance.
lineIDThe line ID of the line-appearance.
featureParameterAdditional parameter of the feature.
uniqueAddressForMatchingThe unique address of a contact.
contactNumberThe contact number of a contact.
personalizedLabelThe personalized label for the customized button.
canSetPersonalizedLabelIndicates whether the set personalized label operation is allowed.
- (instancetype) initWithUniqueAddressForMatching: (NSString *)  uniqueAddressForMatching
contactNumber: (NSString *)  contactNumber 

Property Documentation

- (NSString*) applicationName
readnonatomicassign

Returns the application name of the application when the button being customized is an application.

- (CSButtonType) buttonType
readnonatomicassign

Returns the button type for the button being customized.

- (BOOL) canSetPersonalizedLabel
readnonatomicassign

Indicates whether the set personalized label operation is allowed.

This property is used only for the contact buttons. The set personalized label operation is always allowed for the other buttons.

- (NSInteger) configuredLocation
readnonatomicassign

Returns the physical button index as configured on SMGR.

- (NSString*) contactNumber
readnonatomicassign

Returns the contact number of a contact when the button being customized is a contact.

- (NSInteger) customizedLocation
readnonatomicassign

Returns the button index as customized on application's button module by the user.

- (NSString*) featureParameter
readnonatomicassign

Returns any additional parameter of the feature when the button being customized is a feature.

- (NSInteger) featureType
readnonatomicassign

Returns the feature type of the feature when the button being customized is a feature.

Returns CSFeatureType (for AST feature) or CSAgentFeatureType (for Agent feature) casted to an NSInteger.

- (BOOL) isAgentFeature
readnonatomicassign

Indicates whether the button being customized is an agent feature when the button being customized is a feature.

- (NSString*) lineID
readnonatomicassign

Returns the line ID of the line-appearance when the button being customized is a line-appearance.

- (NSString*) lineOwner
readnonatomicassign

Returns the line owner of the line-appearance when the button being customized is a line-appearance.

- (NSString*) personalizedLabel
readnonatomicassign

Returns the personalized label for the customized button.

- (NSString*) uniqueAddressForMatching
readnonatomicassign

Returns the unique address of a contact when the button being customized is a contact.


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