ArcGIS Runtime SDK for iOS: AGSArcGISFeatureTable.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSArcGISFeatureTable.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSFeatureTable.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSRelationshipConstraintViolationType) {
40 };
41 
45 @class AGSFeatureTemplate;
46 @class AGSFeatureType;
47 @class AGSField;
48 @class AGSArcGISFeature;
50 @class AGSRelationshipInfo;
52 @class AGSFeatureSubtype;
53 @class AGSGeometry;
54 
55 @protocol AGSCancelable;
56 
66 
67 #pragma mark -
68 #pragma mark initializers
69 
70 #pragma mark -
71 #pragma mark properties
72 
77 @property (nullable, nonatomic, copy, readonly) id defaultSubtypeCode;
78 
82 @property (nonatomic, copy, readonly) NSArray<AGSField*> *editableAttributeFields;
83 
88 @property (nonatomic, copy, readonly) NSArray<AGSFeatureSubtype*> *featureSubtypes;
89 
95 @property (nonatomic, copy, readonly) NSArray<AGSFeatureTemplate*> *featureTemplates;
96 
102 @property (nonatomic, copy, readonly) NSArray<AGSFeatureType*> *featureTypes;
103 
107 @property (nonatomic, copy, readonly) NSString *globalIDField;
108 
112 @property (nonatomic, assign, readonly) BOOL hasAttachments;
113 
114 
118 @property (nonatomic, copy, readonly) NSString *objectIDField;
119 
120 
124 @property (nonatomic, assign, readonly) NSInteger serviceLayerID;
125 
129 @property (nonatomic, copy, readonly) NSString *subtypeField;
130 
131 
135 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureLayerInfo *layerInfo;
136 
141 @property (nonatomic, copy, readonly) NSString *typeIDField;
142 
148 @property (nonatomic, assign, readwrite) BOOL useAdvancedSymbology;
149 
155 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unknownJSON;
156 
162 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unsupportedJSON;
163 
164 #pragma mark -
165 #pragma mark methods
166 
175 -(nullable AGSArcGISFeature *)createFeatureWithSubtype:(AGSFeatureSubtype *)featureSubtype;
176 
185 -(nullable AGSArcGISFeature *)createFeatureWithTemplate:(AGSFeatureTemplate *)featureTemplate;
186 
196 -(nullable AGSArcGISFeature *)createFeatureWithSubtype:(AGSFeatureSubtype *)featureSubtype geometry:(AGSGeometry *)geometry;
197 
207 -(nullable AGSArcGISFeature *)createFeatureWithTemplate:(AGSFeatureTemplate *)featureTemplate geometry:(AGSGeometry *)geometry;
208 
217 -(nullable AGSArcGISFeature *)createFeatureWithType:(AGSFeatureType *)featureType;
218 
228 -(nullable AGSArcGISFeature *)createFeatureWithType:(AGSFeatureType *)featureType geometry:(AGSGeometry *)geometry;
229 
236 -(id<AGSCancelable>)addedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
237 
244 -(id<AGSCancelable>)addedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
245 
252 -(id<AGSCancelable>)deletedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
253 
260 -(id<AGSCancelable>)deletedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
261 
268 -(id<AGSCancelable>)updatedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
269 
276 -(id<AGSCancelable>)updatedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
277 
283 -(nullable AGSFeatureTemplate *)featureTemplateForName:(NSString *)name;
284 
290 -(nullable AGSFeatureType *)featureTypeForName:(NSString *)name;
291 
300 - (BOOL)hasLocalEdits;
301 
309 -(nullable NSArray<AGSArcGISFeatureTable*> *)relatedTablesWithRelationshipInfo:(AGSRelationshipInfo *)relationshipInfo;
310 
316 -(nullable NSArray<AGSArcGISFeatureTable*> *)relatedTables;
317 
326 -(id<AGSCancelable>)queryRelatedFeatureCountForFeature:(AGSArcGISFeature *)feature
327  completion:(void(^)(NSInteger count, NSError * __nullable error))completion;
328 
338 -(id<AGSCancelable>)queryRelatedFeatureCountForFeature:(AGSArcGISFeature *)feature
339  parameters:(AGSRelatedQueryParameters *)parameters
340  completion:(void(^)(NSInteger count, NSError * __nullable error))completion;
341 
353 -(id<AGSCancelable>)queryRelatedFeaturesForFeature:(AGSArcGISFeature *)feature
354  completion:(void(^)(NSArray<AGSRelatedFeatureQueryResult*> * __nullable results, NSError * __nullable error))completion;
355 
368 -(id<AGSCancelable>)queryRelatedFeaturesForFeature:(AGSArcGISFeature *)feature
369  parameters:(AGSRelatedQueryParameters *)parameters
370  completion:(void(^)(NSArray<AGSRelatedFeatureQueryResult*> * __nullable results, NSError * __nullable error))completion;
371 
396 -(id<AGSCancelable>)validateRelationshipConstraintsForFeature:(AGSArcGISFeature *)feature
397  completion:(void(^)(AGSRelationshipConstraintViolationType relationshipConstraintViolationType, NSError * __nullable error))completion;
398 
399 @end
400 
402 
408 
409 @end
410 
411 
AGSRelationshipConstraintViolationType
Definition: AGSArcGISFeatureTable.h:36
@ AGSRelationshipConstraintViolationTypeCardinality
Definition: AGSArcGISFeatureTable.h:38
@ AGSRelationshipConstraintViolationTypeOrphaned
Definition: AGSArcGISFeatureTable.h:39
@ AGSRelationshipConstraintViolationTypeNone
Definition: AGSArcGISFeatureTable.h:37
Definition: AGSArcGISFeatureTable.h:401
AGSRelationshipConstraintViolationType ags_relationshipConstraintViolationTypeValue()
An AGSFeature object stored in an AGSArcGISFeatureTable object.
Definition: AGSArcGISFeature.h:62
Information about an individual layer or table in ArcGIS Feature Service.
Definition: AGSArcGISFeatureLayerInfo.h:52
information about an ArcGIS Feature service
Definition: AGSArcGISFeatureServiceInfo.h:46
An ArcGIS specific source for dataset containing geographic features or non-spatial records.
Definition: AGSArcGISFeatureTable.h:66
NSArray< AGSFeatureSubtype * > * featureSubtypes
Definition: AGSArcGISFeatureTable.h:88
nullable NSArray< AGSArcGISFeatureTable * > * relatedTables()
NSString * typeIDField
Definition: AGSArcGISFeatureTable.h:141
NSArray< AGSFeatureTemplate * > * featureTemplates
Definition: AGSArcGISFeatureTable.h:95
NSString * subtypeField
Definition: AGSArcGISFeatureTable.h:129
AGSArcGISFeatureLayerInfo * layerInfo
Definition: AGSArcGISFeatureTable.h:135
NSArray< AGSField * > * editableAttributeFields
Definition: AGSArcGISFeatureTable.h:82
NSArray< AGSFeatureType * > * featureTypes
Definition: AGSArcGISFeatureTable.h:102
NSInteger serviceLayerID
Definition: AGSArcGISFeatureTable.h:124
BOOL useAdvancedSymbology
Definition: AGSArcGISFeatureTable.h:148
NSString * objectIDField
Definition: AGSArcGISFeatureTable.h:118
NSDictionary< NSString *, id > * unknownJSON
Definition: AGSArcGISFeatureTable.h:155
BOOL hasAttachments
Definition: AGSArcGISFeatureTable.h:112
NSDictionary< NSString *, id > * unsupportedJSON
Definition: AGSArcGISFeatureTable.h:162
id defaultSubtypeCode
Definition: AGSArcGISFeatureTable.h:77
NSString * globalIDField
Definition: AGSArcGISFeatureTable.h:107
Result of queries that return features.
Definition: AGSFeatureQueryResult.h:49
Encapsulates properties of types of features in a feature layer.
Definition: AGSFeatureSubtype.h:41
A source for dataset containing geographic features or non-spatial records.
Definition: AGSFeatureTable.h:66
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
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
Information about a feature table's relationship.
Definition: AGSRelationshipInfo.h:72
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38