ArcGIS Runtime SDK for iOS
100.15
|
An object that represents information about a field.
Instances of this class represent information about each field in a layer.
Instance Methods | |
(instancetype) | - initWithFieldType:name:alias:length:domain:editable:allowNull: |
(nullable id) | - toJSON: |
Class Methods | |
(instancetype) | + dateFieldWithName:alias: |
(instancetype) | + doubleFieldWithName:alias: |
(instancetype) | + fieldWithFieldType:name:alias:length:domain:editable:allowNull: |
(instancetype) | + floatFieldWithName:alias: |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
(instancetype) | + longIntFieldWithName:alias: |
(instancetype) | + shortIntFieldWithName:alias: |
(instancetype) | + textFieldWithName:alias:length: |
Properties | |
NSString * | alias |
BOOL | allowNull |
AGSDomain * | domain |
BOOL | editable |
NSInteger | length |
NSString * | name |
AGSFieldType | type |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
+ (instancetype) dateFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
Convenience method to create a date field. The field will be editable and nullable.
name | of the field |
alias | of the field |
+ (instancetype) doubleFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
Convenience method to create a double field. The field will be editable and nullable.
name | of the field |
alias | of the field |
+ (instancetype) fieldWithFieldType: | (AGSFieldType) | fieldType | |
name: | (NSString *) | name | |
alias: | (NSString *) | alias | |
length: | (NSInteger) | length | |
domain: | (nullable AGSDomain *) | domain | |
editable: | (BOOL) | editable | |
allowNull: | (BOOL) | allowNull | |
Initialize the field with the provided parameters
fieldType | specifying the type of field |
name | of the field |
alias | of the field |
length | of the field (only applicable for text fields) |
domain | of the field, if any |
editable | specifying whether the field is editable or not |
allowNull | specifying whether null values are allowed for the field or not |
+ (instancetype) floatFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
Convenience method to create a float field. The field will be editable and nullable.
name | of the field |
alias | of the field |
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
- (instancetype) initWithFieldType: | (AGSFieldType) | fieldType | |
name: | (NSString *) | name | |
alias: | (NSString *) | alias | |
length: | (NSInteger) | length | |
domain: | (nullable AGSDomain *) | domain | |
editable: | (BOOL) | editable | |
allowNull: | (BOOL) | allowNull | |
Initialize the field with the provided parameters
fieldType | specifying the type of field |
name | of the field |
alias | of the field |
length | of the field |
domain | of the field, if any |
editable | specifying whether the field is editable or not |
allowNull | specifying whether null values are allowed for the field or not |
+ (instancetype) longIntFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
Convenience method to create a long field. The field will be editable and nullable.
name | of the field |
alias | of the field |
+ (instancetype) shortIntFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
Convenience method to create a short field. The field will be editable and nullable.
name | of the field |
alias | of the field |
+ (instancetype) textFieldWithName: | (NSString *) | name | |
alias: | (NSString *) | alias | |
length: | (NSInteger) | length | |
Convenience method to create a text field. The field will be editable and nullable.
name | of the field |
alias | of the field |
length | of the field |
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
readnonatomiccopy |
Alias name of the field. Alias name is usually more user friendly than the actual field name which may use underlying datasource naming conventions.
|
readnonatomicassign |
Indicates if the field can accept null values.
|
readnonatomicstrong |
The domain limiting values to a range or a set of coded values for the field.
|
readnonatomicassign |
Indicates whether the field is editable.
|
readnonatomicassign |
The field length.
|
readnonatomiccopy |
Name of the field.
|
readnonatomicassign |
Type of value in the field.
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.