The parameters that can be present in a customized button.
More...
#import <CSCustomizedButton.h>
Inherits NSObject.
|
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...
|
|
The parameters that can be present in a customized button.
- (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
-
configuredLocation | The physical button index as configured on SMGR. |
customizedLocation | The button index as customized on application's button module by the user. |
buttonType | The button type. |
isAgentFeature | Indicates whether the button is an agent feature. |
featureType | The feature type of the feature. |
applicationName | The application name of the application. |
lineOwner | The line owner of the line-appearance. |
lineID | The line ID of the line-appearance. |
featureParameter | Additional parameter of the feature. |
uniqueAddressForMatching | The unique address of a contact. |
contactNumber | The contact number of a contact. |
personalizedLabel | The personalized label for the customized button. |
canSetPersonalizedLabel | Indicates whether the set personalized label operation is allowed. |
- (instancetype) initWithUniqueAddressForMatching: |
|
(NSString *) |
uniqueAddressForMatching |
contactNumber: |
|
(NSString *) |
contactNumber |
|
|
| |
- (NSString*) applicationName |
|
readnonatomicassign |
Returns the application name of the application when the button being customized is an application.
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.
Indicates whether the button being customized is an agent feature when the button being customized is a feature.
Returns the line ID of the line-appearance when the button being customized is a line-appearance.
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: