ArcGIS Runtime SDK for iOS: AGSArcGISFeatureLayerInfo.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSArcGISFeatureLayerInfo.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 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 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 #import <ArcGIS/AGSGeometry.h>
28 #import <ArcGIS/AGSArcGISFeatureLayerInfoServiceType.h>
29 #import <ArcGIS/AGSServiceType.h>
30 
32 @class AGSDrawingInfo;
33 @class AGSFeatureSubtype;
34 @class AGSEnvelope;
36 @class AGSLayerTimeInfo;
37 @class AGSFeatureType;
38 @class AGSField;
39 @class AGSEditFieldsInfo;
40 @class AGSFeatureTemplate;
41 @class AGSRelationshipInfo;
42  //Required for Globals API doc
44 
52 
53 
54 
55 #pragma mark -
56 #pragma mark initializers
57 
58 
59 
60 #pragma mark -
61 #pragma mark properties
62 
66 @property (nullable, nonatomic, strong, readonly) NSURL *URL;
67 
71 @property (nonatomic, assign, readonly) NSInteger serviceLayerID;
72 
76 @property (nonatomic, assign, readonly) BOOL allowGeometryUpdates;
77 
81 @property (nonatomic, copy, readonly) NSString *attribution;
82 
86 @property (nullable, nonatomic, strong, readonly) AGSFeatureServiceCapabilities *capabilities;
87 
91 @property (nonatomic, assign, readonly) BOOL dataVersioned;
92 
96 @property (nullable, nonatomic, copy, readonly) id defaultSubtypeCode;
97 
101 @property (nonatomic, assign, readonly, getter=isVisibleByDefault) BOOL visibleByDefault;
102 
106 @property (nonatomic, assign, readonly) double zDefault;
107 
111 @property (nonatomic, assign, readonly) BOOL zDefaultsEnabled;
112 
113 /* Description of the layer/table in the service
114  @since 100
115  */
116 @property (nonatomic, copy, readonly) NSString *layerDescription;
117 
121 @property (nonatomic, copy, readonly) NSString *displayFieldName;
122 
126 @property (nullable, nonatomic, strong, readonly) AGSDrawingInfo *drawingInfo;
127 
132 @property (nullable, nonatomic, strong, readonly) AGSEditFieldsInfo *editFieldsInfo;
133 
137 @property (nonatomic, assign, readonly) double effectiveMaxScale;
138 
142 @property (nonatomic, assign, readonly) double effectiveMinScale;
143 
147 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *extent;
148 
153 @property (nonatomic, copy, readonly) NSArray<AGSField *> *fields;
154 
158 @property (nonatomic, assign, readonly) AGSGeometryType geometryType;
159 
163 @property (nonatomic, copy, readonly) NSString *globalIDFieldName;
164 
168 @property (nonatomic, assign, readonly) BOOL hasAttachments;
169 
173 @property (nonatomic, assign, readonly) BOOL hasM;
174 
178 @property (nonatomic, assign, readonly) BOOL hasZ;
179 
183 @property (nonatomic, assign, readonly) NSInteger maxRecordCount;
184 
188 @property (nonatomic, assign, readonly) double maxScale;
189 
193 @property (nonatomic, assign, readonly) double minScale;
194 
198 @property (nonatomic, copy, readonly) NSString *serviceLayerName;
199 
203 @property (nonatomic, copy, readonly) NSString *objectIDFieldName;
204 
208 @property (nonatomic, assign, readonly) AGSArcGISFeatureLayerInfoServiceType serviceType;
209 
213 @property (nullable, nonatomic, strong, readonly) AGSOwnershipBasedAccessControlInfo *ownershipBasedAccessControl;
214 
218 @property (nonatomic, copy, readonly) NSArray<AGSRelationshipInfo*> *relationshipInfos;
219 
226 @property (nonatomic, copy, readonly) NSArray<AGSFeatureType*> *featureTypes;
227 
231 @property (nonatomic, assign, readonly) AGSServiceType serviceSourceType;
232 
237 @property (nonatomic, copy, readonly) NSString *subtypeField;
238 
242 @property (nonatomic, assign, readonly) BOOL supportsAdvancedQueries;
243 
247 @property (nonatomic, assign, readonly) BOOL supportsOBACForAnonymousUsers;
248 
252 @property (nonatomic, assign, readonly) BOOL supportsQueryExtent;
253 
257 @property (nonatomic, assign, readonly) BOOL supportsPagination;
258 
262 @property (nonatomic, assign, readonly) BOOL supportsRollbackOnFailureParameter;
263 
267 @property (nonatomic, assign, readonly) BOOL supportsStatistics;
268 
272 @property (nonatomic, copy, readonly) NSArray<AGSFeatureSubtype*> *featureSubtypes;
273 
280 @property (nonatomic, copy, readonly) NSArray<AGSFeatureTemplate*> *featureTemplates;
281 
287 @property (nullable, nonatomic, strong, readonly) AGSLayerTimeInfo *timeInfo;
288 
293 @property (nonatomic, copy, readonly) NSString *typeIDFieldName;
294 
298 @property (nonatomic, copy, readonly) NSString *version;
299 
303 @property (nonatomic, copy, readonly) NSString *CIMVersion;
304 
305 #pragma mark -
306 #pragma mark methods
307 
308 
314 -(nullable AGSField*)fieldWithName:(NSString*)name;
315 
321 -(nullable AGSFeatureType*)featureTypeWithName:(NSString*)name;
322 
323 
324 
325 @end
AGSArcGISFeatureLayerInfoServiceType
Definition: AGSArcGISFeatureLayerInfoServiceType.h:37
AGSGeometryType
Definition: AGSGeometry.h:49
AGSServiceType
Definition: AGSServiceType.h:35
Information about an individual layer or table in ArcGIS Feature Service.
Definition: AGSArcGISFeatureLayerInfo.h:52
NSArray< AGSRelationshipInfo * > * relationshipInfos
Definition: AGSArcGISFeatureLayerInfo.h:218
AGSEnvelope * extent
Definition: AGSArcGISFeatureLayerInfo.h:147
AGSEditFieldsInfo * editFieldsInfo
Definition: AGSArcGISFeatureLayerInfo.h:132
BOOL allowGeometryUpdates
Definition: AGSArcGISFeatureLayerInfo.h:76
BOOL supportsOBACForAnonymousUsers
Definition: AGSArcGISFeatureLayerInfo.h:247
NSArray< AGSFeatureSubtype * > * featureSubtypes
Definition: AGSArcGISFeatureLayerInfo.h:272
NSString * serviceLayerName
Definition: AGSArcGISFeatureLayerInfo.h:198
BOOL dataVersioned
Definition: AGSArcGISFeatureLayerInfo.h:91
NSString * layerDescription
Definition: AGSArcGISFeatureLayerInfo.h:116
double maxScale
Definition: AGSArcGISFeatureLayerInfo.h:188
NSArray< AGSField * > * fields
Definition: AGSArcGISFeatureLayerInfo.h:153
BOOL visibleByDefault
Definition: AGSArcGISFeatureLayerInfo.h:101
BOOL supportsPagination
Definition: AGSArcGISFeatureLayerInfo.h:257
NSString * typeIDFieldName
Definition: AGSArcGISFeatureLayerInfo.h:293
NSArray< AGSFeatureType * > * featureTypes
Definition: AGSArcGISFeatureLayerInfo.h:226
NSString * globalIDFieldName
Definition: AGSArcGISFeatureLayerInfo.h:163
BOOL supportsQueryExtent
Definition: AGSArcGISFeatureLayerInfo.h:252
BOOL hasAttachments
Definition: AGSArcGISFeatureLayerInfo.h:168
AGSDrawingInfo * drawingInfo
Definition: AGSArcGISFeatureLayerInfo.h:126
id defaultSubtypeCode
Definition: AGSArcGISFeatureLayerInfo.h:96
NSString * objectIDFieldName
Definition: AGSArcGISFeatureLayerInfo.h:203
BOOL supportsRollbackOnFailureParameter
Definition: AGSArcGISFeatureLayerInfo.h:262
double zDefault
Definition: AGSArcGISFeatureLayerInfo.h:106
AGSOwnershipBasedAccessControlInfo * ownershipBasedAccessControl
Definition: AGSArcGISFeatureLayerInfo.h:213
BOOL supportsAdvancedQueries
Definition: AGSArcGISFeatureLayerInfo.h:242
NSInteger maxRecordCount
Definition: AGSArcGISFeatureLayerInfo.h:183
NSString * displayFieldName
Definition: AGSArcGISFeatureLayerInfo.h:121
NSString * CIMVersion
Definition: AGSArcGISFeatureLayerInfo.h:303
NSArray< AGSFeatureTemplate * > * featureTemplates
Definition: AGSArcGISFeatureLayerInfo.h:280
NSString * attribution
Definition: AGSArcGISFeatureLayerInfo.h:81
AGSServiceType serviceSourceType
Definition: AGSArcGISFeatureLayerInfo.h:231
NSString * version
Definition: AGSArcGISFeatureLayerInfo.h:298
double minScale
Definition: AGSArcGISFeatureLayerInfo.h:193
AGSLayerTimeInfo * timeInfo
Definition: AGSArcGISFeatureLayerInfo.h:287
BOOL hasZ
Definition: AGSArcGISFeatureLayerInfo.h:178
BOOL zDefaultsEnabled
Definition: AGSArcGISFeatureLayerInfo.h:111
NSURL * URL
Definition: AGSArcGISFeatureLayerInfo.h:66
NSInteger serviceLayerID
Definition: AGSArcGISFeatureLayerInfo.h:71
BOOL supportsStatistics
Definition: AGSArcGISFeatureLayerInfo.h:267
double effectiveMinScale
Definition: AGSArcGISFeatureLayerInfo.h:142
AGSFeatureServiceCapabilities * capabilities
Definition: AGSArcGISFeatureLayerInfo.h:86
AGSGeometryType geometryType
Definition: AGSArcGISFeatureLayerInfo.h:158
NSString * subtypeField
Definition: AGSArcGISFeatureLayerInfo.h:237
AGSArcGISFeatureLayerInfoServiceType serviceType
Definition: AGSArcGISFeatureLayerInfo.h:208
BOOL hasM
Definition: AGSArcGISFeatureLayerInfo.h:173
double effectiveMaxScale
Definition: AGSArcGISFeatureLayerInfo.h:137
Drawing information about a sub-layer of map or feature service.
Definition: AGSDrawingInfo.h:40
Information about edit tracking fields.
Definition: AGSEditFieldsInfo.h:38
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
Capabilities supported by a feature service.
Definition: AGSFeatureServiceCapabilities.h:37
Encapsulates properties of types of features in a feature layer.
Definition: AGSFeatureSubtype.h:41
Represents all of the information needed to create a feature.
Definition: AGSFeatureTemplate.h:64
Encapsulates properties of types of features in a feature layer.
Definition: AGSFeatureType.h:41
An object that represents information about a field.
Definition: AGSField.h:62
Time information details.
Definition: AGSLayerTimeInfo.h:42
Definition: AGSObject.h:28
Ownership-based access control information for the features of a feature service layer.
Definition: AGSOwnershipBasedAccessControlInfo.h:37
Information about a feature table's relationship.
Definition: AGSRelationshipInfo.h:72