Bold360 and BoldChat Developer Center
Getting Started with the API

BCFormFieldOption Class Reference

Container class for storing information about an option for BCFormFieldTypeSelect or BCFormFieldTypeRadio. More...

#import <BCFormFieldOption.h>

Inheritance diagram for BCFormFieldOption:

Instance Methods

(id) - initWithName:value:nameBrandingKey:isDefaultValue:
 The constructor for items options that does not have availability settings. More...
 
(id) - initWithName:value:nameBrandingKey:isDefaultValue:isAvailable:availableLabel:
 The constructor for items options that have availability settings. More...
 

Class Methods

(id) + formOptionWithName:value:nameBrandingKey:isDefaultValue:
 The static constructor for items options that does not have availability settings. More...
 
(id) + formOptionWithName:value:nameBrandingKey:isDefaultValue:isAvailable:availableLabel:
 The static constructor for items options that have availability settings. More...
 

Properties

NSString * name
 The name of the field, this is appropriate to show to a user. More...
 
NSString * value
 The value of the field, this is not appropriate to show to a user. More...
 
NSString * nameBrandingKey
 The branding key for name localization if exists for the option. More...
 
NSString * availableLabel
 For deparments selection fields that have online/offlinet status, this will return the status label to be displayed to the user. More...
 
BOOL isDefaultValue
 YES if the value is the default. More...
 
BOOL isAvailable
 YES if the value is the default one for the BCFormFieldTypeSelect or BCFormFieldTypeRadio field. More...
 
BOOL isAvailiblitySet
 Determines if isAvailable and availableLabel values are set. More...
 

Detailed Description

Container class for storing information about an option for BCFormFieldTypeSelect or BCFormFieldTypeRadio.

Since
Version 1.0

Method Documentation

+ (id) formOptionWithName: (NSString *)  name
value: (NSString *)  value
nameBrandingKey: (NSString *)  nameBrandingKey
isDefaultValue: (BOOL)  isDefaultValue 

The static constructor for items options that does not have availability settings.

Parameters
nameThe name of the field, this is appropriate to show to a user.
valueThe value of the field, this is not appropriate to show to a user.
nameBrandingKeyThe branding key for name localization if exists for the option.
isDefaultValueYES if the value is the default.
Returns
An instance of BCFormFieldOption.
Since
Version 1.0
+ (id) formOptionWithName: (NSString *)  name
value: (NSString *)  value
nameBrandingKey: (NSString *)  nameBrandingKey
isDefaultValue: (BOOL)  isDefaultValue
isAvailable: (BOOL)  isAvailable
availableLabel: (NSString *)  availableLabel 

The static constructor for items options that have availability settings.

Parameters
nameThe name of the field, this is appropriate to show to a user.
valueThe value of the field, this is not appropriate to show to a user.
nameBrandingKeyThe branding key for name localization if exists for the option.
isDefaultValueYES if the value is the default.
isAvailableYES if the value is the default one for the BCFormFieldTypeSelect or BCFormFieldTypeRadio field.
availableLabelFor deparments selection fields that have online/offlinet status, this will return the status label to be displayed to the user.
Returns
An instance of BCFormFieldOption.
Since
Version 1.0
- (id) initWithName: (NSString *)  name
value: (NSString *)  value
nameBrandingKey: (NSString *)  nameBrandingKey
isDefaultValue: (BOOL)  isDefaultValue 

The constructor for items options that does not have availability settings.

Parameters
nameThe name of the field, this is appropriate to show to a user.
valueThe value of the field, this is not appropriate to show to a user.
nameBrandingKeyThe branding key for name localization if exists for the option.
isDefaultValueYES if the value is the default.
Returns
An instance of BCFormFieldOption.
Since
Version 1.0
- (id) initWithName: (NSString *)  name
value: (NSString *)  value
nameBrandingKey: (NSString *)  nameBrandingKey
isDefaultValue: (BOOL)  isDefaultValue
isAvailable: (BOOL)  isAvailable
availableLabel: (NSString *)  availableLabel 

The constructor for items options that have availability settings.

Parameters
nameThe name of the field, this is appropriate to show to a user.
valueThe value of the field, this is not appropriate to show to a user.
nameBrandingKeyThe branding key for name localization if exists for the option.
isDefaultValueYES if the value is the default.
isAvailableYES if the value is the default one for the BCFormFieldTypeSelect or BCFormFieldTypeRadio field.
availableLabelFor deparments selection fields that have online/offlinet status, this will return the status label to be displayed to the user.
Returns
An instance of BCFormFieldOption.
Since
Version 1.0

Property Documentation

- (NSString*) availableLabel
readnonatomiccopy

For deparments selection fields that have online/offlinet status, this will return the status label to be displayed to the user.

Since
Version 1.0
- (BOOL) isAvailable
readnonatomicassign

YES if the value is the default one for the BCFormFieldTypeSelect or BCFormFieldTypeRadio field.

Since
Version 1.0
- (BOOL) isAvailiblitySet
readnonatomicassign

Determines if isAvailable and availableLabel values are set.

Since
Version 1.0
- (BOOL) isDefaultValue
readnonatomicassign

YES if the value is the default.

Since
Version 1.0
- (NSString*) name
readnonatomiccopy

The name of the field, this is appropriate to show to a user.

Since
Version 1.0
- (NSString*) nameBrandingKey
readnonatomiccopy

The branding key for name localization if exists for the option.

Since
Version 1.0
- (NSString*) value
readnonatomiccopy

The value of the field, this is not appropriate to show to a user.

Since
Version 1.0
The documentation for this class was generated from the following file:
Need more info? Contact us