BCFormField Class Reference
Container class for information about an individual form field. This class also contains the value to be submitted. More...
#import <BCFormField.h>
Instance Methods | |
| (id) | - initWithType:key:isMultiline:label:labelBrandingKey:isRequired:isVisible:isDepartmentStatusVisible:defaultValue:options: |
| The constructor for BCFormField. More... | |
Class Methods | |
| (id) | + formFieldWithType:key:isMultiline:label:labelBrandingKey:isRequired:isVisible:isDepartmentStatusVisible:defaultValue:options: |
| The static constructor for BCFormField. More... | |
Properties | |
| BCFormFieldType | type |
| Type of the form field. More... | |
| NSString * | key |
| When submitting this is the key field that the server will be expecting. More... | |
| BOOL | isMultiline |
| If the text field is BCFormFieldTypeText then this field indicates if the text input field should have multiple lines. More... | |
| NSString * | label |
| The prompt label for the form field. More... | |
| NSString * | labelBrandingKey |
| The branding value key that should be used for the label, or null if this is a custom field. If this returns nil then label should be used instead. More... | |
| BOOL | isRequired |
| Indicates if there should be validation on this field to ensure the user enters information, or selects a value. More... | |
| BOOL | isVisible |
| Determines if the field should be shown to the user or not. More... | |
| BOOL | isDepartmentStatusVisible |
| If the field is type BCFormFieldTypeSelect and is a BoldChat department selection type of field then this field indicates if the online/offline status of the department should be shown to the user. More... | |
| BCFormFieldOption * | defaultOption |
| If the form field type is BCFormFieldTypeSelect or BCFormFieldTypeRadio it holds the default option. More... | |
| NSArray * | options |
| If the field is BCFormFieldTypeSelect or BCFormFieldTypeRadio then this method returns all the options that should be given to the user. The array holds BCFormFieldOption objects. More... | |
| NSString * | value |
| The value that has been set for this field, or nil if is unset. More... | |
Detailed Description
Container class for information about an individual form field. This class also contains the value to be submitted.
- Since
- Version 1.0
Method Documentation
| + (id) formFieldWithType: | (BCFormFieldType) | type | |
| key: | (NSString *) | key | |
| isMultiline: | (BOOL) | isMultiline | |
| label: | (NSString *) | label | |
| labelBrandingKey: | (NSString *) | labelBrandingKey | |
| isRequired: | (BOOL) | isRequired | |
| isVisible: | (BOOL) | isVisible | |
| isDepartmentStatusVisible: | (BOOL) | isDepartmentStatusVisible | |
| defaultValue: | (NSString *) | defaultValue | |
| options: | (NSArray *) | options | |
The static constructor for BCFormField.
- Parameters
-
type Type of the form field. key When submitting this is the key field that the server will be expecting. isMultiline If the text field is BCFormFieldTypeText then this field indicates if the text input field should have multiple lines. label The title label text of the field. labelBrandingKey The branding value key that should be used for the label, or null if this is a custom field. If this returns nil then label should be used instead. isRequired It indicates if there should be validation on this field to ensure the user enters information, or selects a value. isVisible It determines if the field should be shown to the user or not. isDepartmentStatusVisible If the field is type BCFormFieldTypeSelect and is a BoldChat department selection type of field then this field indicates if the online/offline status of the department should be shown to the user. defaultValue The default value of the form field, if the type is not BCFormFieldTypeSelect or BCFormFieldTypeRadio. options If the field is BCFormFieldTypeSelect or BCFormFieldTypeRadio then this method returns all the options that should be given to the user.
- Returns
- An instance of BCFormField class.
- Since
- Version 1.0
| - (id) initWithType: | (BCFormFieldType) | type | |
| key: | (NSString *) | key | |
| isMultiline: | (BOOL) | isMultiline | |
| label: | (NSString *) | label | |
| labelBrandingKey: | (NSString *) | labelBrandingKey | |
| isRequired: | (BOOL) | isRequired | |
| isVisible: | (BOOL) | isVisible | |
| isDepartmentStatusVisible: | (BOOL) | isDepartmentStatusVisible | |
| defaultValue: | (NSString *) | defaultValue | |
| options: | (NSArray *) | options | |
The constructor for BCFormField.
- Parameters
-
type Type of the form field. key When submitting this is the key field that the server will be expecting. isMultiline If the text field is BCFormFieldTypeText then this field indicates if the text input field should have multiple lines. label The title label text of the field. labelBrandingKey The branding value key that should be used for the label, or null if this is a custom field. If this returns nil then label should be used instead. isRequired It indicates if there should be validation on this field to ensure the user enters information, or selects a value. isVisible It determines if the field should be shown to the user or not. isDepartmentStatusVisible If the field is type BCFormFieldTypeSelect and is a BoldChat department selection type of field then this field indicates if the online/offline status of the department should be shown to the user. defaultValue The default value of the form field, if the type is not BCFormFieldTypeSelect or BCFormFieldTypeRadio. options If the field is BCFormFieldTypeSelect or BCFormFieldTypeRadio then this method returns all the options that should be given to the user.
- Since
- Version 1.0
Property Documentation
|
readnonatomicassign |
If the form field type is BCFormFieldTypeSelect or BCFormFieldTypeRadio it holds the default option.
- Since
- Version 1.0
|
readnonatomicassign |
If the field is type BCFormFieldTypeSelect and is a BoldChat department selection type of field then this field indicates if the online/offline status of the department should be shown to the user.
- Since
- Version 1.0
|
readnonatomicassign |
If the text field is BCFormFieldTypeText then this field indicates if the text input field should have multiple lines.
- Since
- Version 1.0
|
readnonatomicassign |
Indicates if there should be validation on this field to ensure the user enters information, or selects a value.
- Since
- Version 1.0
|
readnonatomicassign |
Determines if the field should be shown to the user or not.
- Since
- Version 1.0
|
readnonatomiccopy |
When submitting this is the key field that the server will be expecting.
- Since
- Version 1.0
|
readnonatomiccopy |
The prompt label for the form field.
- Since
- Version 1.0
|
readnonatomiccopy |
The branding value key that should be used for the label, or null if this is a custom field. If this returns nil then label should be used instead.
- Since
- Version 1.0
|
readnonatomiccopy |
If the field is BCFormFieldTypeSelect or BCFormFieldTypeRadio then this method returns all the options that should be given to the user. The array holds BCFormFieldOption objects.
- Since
- Version 1.0
|
readnonatomicassign |
Type of the form field.
- Since
- Version 1.0
|
readwritenonatomicstrong |
The value that has been set for this field, or nil if is unset.
- Since
- Version 1.0
The documentation for this class was generated from the following file: