ArcGIS Runtime SDK for iOS: AGSArcadeExpression.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSArcadeExpression.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 #import <ArcGIS/AGSJSONSerializable.h>
30 
31 
32 
36 typedef NS_ENUM(NSInteger, AGSArcadeExpressionReturnType) {
43 };
44 
54 
55 #pragma mark -
56 #pragma mark initializers
57 
58 
59 
67 - (instancetype)initWithExpression:(NSString *)expression;
68 
76 + (instancetype)arcadeExpressionWithExpression:(NSString *)expression;
77 
86 - (instancetype)initWithExpression:(NSString *)expression
87  title:(NSString *)title
88  name:(NSString *)name;
89 
98 + (instancetype)arcadeExpressionWithExpression:(NSString *)expression
99  title:(NSString *)title
100  name:(NSString *)name;
101 
109 - (instancetype)initWithExpression:(NSString *)expression
110  title:(NSString *)title
111  name:(NSString *)name
112  returnType:(AGSArcadeExpressionReturnType)returnType;
113 
121 + (instancetype)arcadeExpressionWithExpression:(NSString *)expression
122  title:(NSString *)title
123  name:(NSString *)name
124  returnType:(AGSArcadeExpressionReturnType)returnType;
125 
126 #pragma mark -
127 #pragma mark properties
128 
132 @property (nonatomic, copy, readonly) NSString *expression;
133 
139 @property (nonatomic, copy, readonly) NSString *name;
140 
148 @property (nonatomic, assign, readonly) AGSArcadeExpressionReturnType returnType;
149 
155 @property (nonatomic, copy, readonly) NSString *title;
156 
157 #pragma mark -
158 #pragma mark methods
159 
166 - (BOOL)isEqualToArcadeExpression:(AGSArcadeExpression *)other;
167 @end
168 
169 
AGSArcadeExpressionReturnType
Definition: AGSArcadeExpression.h:36
@ AGSArcadeExpressionReturnTypeBoolean
Definition: AGSArcadeExpression.h:42
@ AGSArcadeExpressionReturnTypeNumber
Definition: AGSArcadeExpression.h:38
@ AGSArcadeExpressionReturnTypeDictionary
Definition: AGSArcadeExpression.h:40
@ AGSArcadeExpressionReturnTypeString
Definition: AGSArcadeExpression.h:39
@ AGSArcadeExpressionReturnTypeAny
Definition: AGSArcadeExpression.h:41
@ AGSArcadeExpressionReturnTypeAutomatic
Definition: AGSArcadeExpression.h:37
An Arcade expression object, containing an expression, a name, a return type and a title.
Definition: AGSArcadeExpression.h:53
NSString * name
Definition: AGSArcadeExpression.h:139
NSString * expression
Definition: AGSArcadeExpression.h:132
AGSArcadeExpressionReturnType returnType
Definition: AGSArcadeExpression.h:148
NSString * title
Definition: AGSArcadeExpression.h:155
Definition: AGSObject.h:28
A protocol to convert objects to and from JSON.
Definition: AGSJSONSerializable.h:38