SCField Class Reference
Inherits from | NSObject |
Declared in | SCField.h |
Overview
The SCField object identifies a Sitecore system item’s field.
It provides getters for the field’s properties and asynchronous loader for the field’s value.
Now you can load fields using SCApiSession or SCItem object.
Tasks
-
apiSession
The SCApiSession object this field was created/loaded from.
property
Can be used to load the necessary data. -
fieldId
The system field’s id.
property -
name
The system field’s name.
property -
type
The system field’s type. Possible values: “Image”, “Datetime”, “Checklist” etc.
property -
rawValue
The system field’s raw value.
property -
item
The SCItem object for this field is belong to.
property -
fieldValue
The value of the field, depends on the field type ( see [SCField type] ).
property -
– readFieldValueOperation
Used for the loading field value.
Properties
apiSession
The SCApiSession object this field was created/loaded from.
Can be used to load the necessary data.
@property (nonatomic, readonly) SCExtendedApiSession *apiSession
Discussion
The SCApiSession object this field was created/loaded from.
Can be used to load the necessary data.
Declared In
SCField.h
fieldId
The system field’s id.
@property (nonatomic, readonly) NSString *fieldId
Discussion
The system field’s id.
Declared In
SCField.h
fieldValue
The value of the field, depends on the field type ( see [SCField type] ).
@property (nonatomic, readonly) id fieldValue
Discussion
The value of the field, depends on the field type ( see [SCField type] ).
This value is equal to [SCField rawValue] if class of the field’s object is SCField and can be different for other fields types.
See SCField inheritor class: [SCImageField fieldValue] for details.
Declared In
SCField.h
item
The SCItem object for this field is belong to.
@property (nonatomic, weak, readonly) SCItem *item
Discussion
The SCItem object for this field is belong to.
Declared In
SCField.h
name
The system field’s name.
@property (nonatomic, readonly) NSString *name
Discussion
The system field’s name.
Declared In
SCField.h
Instance Methods
readFieldValueOperation
Used for the loading field value.
- (SCAsyncOp)readFieldValueOperation
Return Value
SCAsyncOp block. Call it to get the expected result. The SCAsyncOpResult handler’s result is [SCField rawValue] by default but can be different for other fields types.
See SCField inheritor class: [SCImageField readFieldValueOperation] for details.
Discussion
Used for the loading field value.
Declared In
SCField.h