PWSchemaField Class Reference
Inherits from | NSObject |
Conforms to | NSCoding NSCopying |
Declared in | PWSchemaField.h |
Overview
PWSchemaField
objects define the fields that are specified for a PWSchema
object. A PWSchemaField
object has a few base parameters and can be extended to support additional key:value pairs. Additional key:value pairs are available in the customKeys
property. You can modify PWSchemaField
values in MaaS Portal. PWSchemaField
conforms to the NSCoding
and NSCopying
protocol.
Tasks
Other Methods
-
field
A string describing the field key.
property -
label
A string describing the field label.
property -
type
A string describing the field type.
property -
required
A boolean value which indicates whether or note this field is required.
property -
fieldDescription
A string describing the field.
property -
customKeys
Additional keys are based on the type and can be modified in MaaS Portal
property
Convenience
-
+ unpack:
Convenience method to instantiate a
PWSchemaField
object from a properly formattedNSDictionary
object. -
– dictionary
Returns an
NSDictionary
representation of the current container.
Properties
customKeys
Additional keys are based on the type and can be modified in MaaS Portal
@property (nonatomic, readonly) NSDictionary *customKeys
Declared In
PWSchemaField.h
field
A string describing the field key.
@property (nonatomic, readonly) NSString *field
Declared In
PWSchemaField.h
fieldDescription
A string describing the field.
@property (nonatomic, readonly) NSString *fieldDescription
Declared In
PWSchemaField.h
label
A string describing the field label.
@property (nonatomic, readonly) NSString *label
Declared In
PWSchemaField.h
required
A boolean value which indicates whether or note this field is required.
@property (nonatomic, readonly) BOOL required
Declared In
PWSchemaField.h
type
A string describing the field type.
@property (nonatomic, readonly) NSString *type
Declared In
PWSchemaField.h
Class Methods
unpack:
Convenience method to instantiate a PWSchemaField
object from a properly formatted NSDictionary
object.
+ (instancetype)unpack:(NSDictionary *)dictionary
Parameters
- dictionary
The dictionary from which to instantiate the
PWSchemaField
object.
Declared In
PWSchemaField.h