ArcGIS Runtime SDK for iOS
100.15
|
An Arcade expression object, containing an expression, a name, a return type and a title.
An ArcadeExpression
object gathers an Arcade script expression together with:
Instance Methods | |
(instancetype) | - initWithExpression: |
(instancetype) | - initWithExpression:title:name: |
(instancetype) | - initWithExpression:title:name:returnType: |
(BOOL) | - isEqualToArcadeExpression: |
(nullable id) | - toJSON: |
Class Methods | |
(instancetype) | + arcadeExpressionWithExpression: |
(instancetype) | + arcadeExpressionWithExpression:title:name: |
(instancetype) | + arcadeExpressionWithExpression:title:name:returnType: |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
NSString * | expression |
NSString * | name |
AGSArcadeExpressionReturnType | returnType |
NSString * | title |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
+ (instancetype) arcadeExpressionWithExpression: | (NSString *) | expression |
Creates a new Arcade expression object with an expression script.
The AGSArcadeExpression::name
and AGSArcadeExpression::title
properties will default to empty strings. The AGSArcadeExpression::returnType
property will default to AGSArcadeExpressionReturnTypeAutomatic
.
expression | The Arcade expression to be evaluated. |
+ (instancetype) arcadeExpressionWithExpression: | (NSString *) | expression | |
title: | (NSString *) | title | |
name: | (NSString *) | name | |
Creates a new Arcade expression object.
The AGSArcadeExpression::returnType
property will default to AGSArcadeExpressionReturnTypeAutomatic
.
expression | The Arcade expression to be evaluated. |
title | The title of the expression. |
name | The name of the expression. |
+ (instancetype) arcadeExpressionWithExpression: | (NSString *) | expression | |
title: | (NSString *) | title | |
name: | (NSString *) | name | |
returnType: | (AGSArcadeExpressionReturnType) | returnType | |
Creates a new Arcade expression object.
expression | The Arcade expression to be evaluated. |
title | The title of the expression. |
name | The name of the expression. |
returnType | The type to cast the evaluated value to. |
|
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) initWithExpression: | (NSString *) | expression |
Creates a new Arcade expression object with an expression script.
The AGSArcadeExpression::name
and AGSArcadeExpression::title
properties will default to empty strings. The AGSArcadeExpression::returnType
property will default to AGSArcadeExpressionReturnTypeAutomatic
.
expression | The Arcade expression to be evaluated. |
- (instancetype) initWithExpression: | (NSString *) | expression | |
title: | (NSString *) | title | |
name: | (NSString *) | name | |
Creates a new Arcade expression object.
The AGSArcadeExpression::returnType
property will default to AGSArcadeExpressionReturnTypeAutomatic
.
expression | The Arcade expression to be evaluated. |
title | The title of the expression. |
name | The name of the expression. |
- (instancetype) initWithExpression: | (NSString *) | expression | |
title: | (NSString *) | title | |
name: | (NSString *) | name | |
returnType: | (AGSArcadeExpressionReturnType) | returnType | |
Creates a new Arcade expression object.
expression | The Arcade expression to be evaluated. |
title | The title of the expression. |
name | The name of the expression. |
returnType | The type to cast the evaluated value to. |
- (BOOL) isEqualToArcadeExpression: | (AGSArcadeExpression *) | other |
Tests if two Arcade expression objects are equal.
other | The second object. |
YES
if this AGSArcadeExpression
and the other AGSArcadeExpression
objects are equivalent, NO
if they are not.
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
readnonatomiccopy |
The Arcade expression string.
|
readnonatomiccopy |
The name that the author uses to refer to the expression.
If not set explicitly, then the default is an empty name string.
|
readnonatomicassign |
The expected return type of the expression.
If the Arcade expression creates results of a different type (e.g. a date or an array) then the result will be cast to the expected return type. If no sensible cast can be carried out, then the result will be nil
.
|
readnonatomiccopy |
The title that the author uses to describe the expression.
If not set explicitly, then the default is an empty title string.
|
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.