PWStructure Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | NSCoding NSCopying |
| Declared in | PWStructure.h |
Overview
PWStructure items are used to build the structure and hierarchy of the data. Each structure item that is defined as an object can also optionally be assigned a schema that defines what content can be saved to those structure items. All values in a PWStructure object are immutable on the client. You can modify PWStructure values in the MaaS portal. PWStructure conforms to the NSCoding and NSCopying protocol.
Other Methods
structureID
An integer that is used to identify the Structure ID.
@property (nonatomic, readonly) NSUInteger structureIDDeclared In
PWStructure.h
parentID
An integer that is used to identify the Parent ID.
@property (nonatomic, readonly) NSUInteger parentIDDeclared In
PWStructure.h
containerID
A string that is used to identify the Container ID.
@property (nonatomic, readonly) NSString *containerIDDeclared In
PWStructure.h
schemaID
A string that is used to identify the Schema ID.
@property (nonatomic, readonly) NSString *schemaIDDeclared In
PWStructure.h
name
A string that is used to identify the structure name.
@property (nonatomic, readonly) NSString *nameDeclared In
PWStructure.h
type
A string that is used to identify the structure type.
@property (nonatomic, readonly) NSString *typeDeclared In
PWStructure.h
field
A string that is used to identify the structure field.
@property (nonatomic, readonly) NSString *fieldDeclared In
PWStructure.h
structureDescription
A string that is used to identify the structure name.
@property (nonatomic, readonly) NSString *structureDescriptionDeclared In
PWStructure.h
sortOrder
An unsigned integer that is used to identify the structure name.
@property (nonatomic, readonly) NSUInteger sortOrderDeclared In
PWStructure.h
isActive
An boolean that is used to identify the Parent ID.
@property (nonatomic, readonly) BOOL isActiveDeclared In
PWStructure.h
creationDate
The creation date of the structure.
@property (nonatomic, readonly) NSDate *creationDateDeclared In
PWStructure.h
lastUpdated
The date of the last update for the structure.
@property (nonatomic, readonly) NSDate *lastUpdatedDeclared In
PWStructure.h
schema
The PWSchema object associated with the current structure, if one exists.
@property (nonatomic, readonly) PWSchema *schemaDeclared In
PWStructure.h
content
The content, where the structure is based on the associated PWSchema.
@property (nonatomic, readonly) NSDictionary *contentDeclared In
PWStructure.h
children
Depending on the API method, the child PWStructure items may be return as well.
@property (nonatomic, readonly) NSArray *childrenDeclared In
PWStructure.h
Convenience
+ unpack:
Convenience method to instantiate a PWStructure object from a properly formatted NSDictionary object.
+ (instancetype)unpack:(NSDictionary *)dictionaryParameters
dictionary |
The dictionary from which to instantiate the |
|---|
Declared In
PWStructure.h
– dictionary
Returns an NSDictionary representation of the current structure.
- (NSDictionary *)dictionaryDeclared In
PWStructure.h