ArcGIS Runtime SDK for iOS: AGSArcGISFeatureTable.h Source File
ArcGIS Runtime SDK for iOS  100.14
AGSArcGISFeatureTable.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/AGSFeatureTable.h>
29 #import <ArcGIS/AGSCancelable.h>
30 
31 
32 
37 typedef NS_ENUM(NSInteger, AGSRelationshipConstraintViolationType) {
41 };
42 
49 @class AGSFeatureTemplate;
50 @class AGSFeatureType;
51 @class AGSField;
52 @class AGSArcGISFeature;
54 @class AGSRelationshipInfo;
56 @class AGSFeatureSubtype;
57 @class AGSGeometry;
59 
69 
70 #pragma mark -
71 #pragma mark initializers
72 
73 #pragma mark -
74 #pragma mark properties
75 
83 @property (nonatomic, strong, readonly) AGSContingentValuesDefinition *contingentValuesDefinition;
84 
89 @property (nullable, nonatomic, copy, readonly) id defaultSubtypeCode;
90 
94 @property (nonatomic, copy, readonly) NSArray<AGSField*> *editableAttributeFields;
95 
100 @property (nonatomic, copy, readonly) NSArray<AGSFeatureSubtype*> *featureSubtypes;
101 
107 @property (nonatomic, copy, readonly) NSArray<AGSFeatureTemplate*> *featureTemplates;
108 
114 @property (nonatomic, copy, readonly) NSArray<AGSFeatureType*> *featureTypes;
115 
119 @property (nonatomic, copy, readonly) NSString *globalIDField;
120 
124 @property (nonatomic, assign, readonly) BOOL hasAttachments;
125 
126 
130 @property (nonatomic, copy, readonly) NSString *objectIDField;
131 
132 
136 @property (nonatomic, assign, readonly) NSInteger serviceLayerID;
137 
141 @property (nonatomic, copy, readonly) NSString *subtypeField;
142 
143 
147 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureLayerInfo *layerInfo;
148 
153 @property (nonatomic, copy, readonly) NSString *typeIDField;
154 
160 @property (nonatomic, assign, readwrite) BOOL useAdvancedSymbology;
161 
167 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unknownJSON;
168 
174 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unsupportedJSON;
175 
176 #pragma mark -
177 #pragma mark methods
178 
187 -(nullable AGSArcGISFeature *)createFeatureWithSubtype:(AGSFeatureSubtype *)featureSubtype;
188 
197 -(nullable AGSArcGISFeature *)createFeatureWithTemplate:(AGSFeatureTemplate *)featureTemplate;
198 
208 -(nullable AGSArcGISFeature *)createFeatureWithSubtype:(AGSFeatureSubtype *)featureSubtype geometry:(AGSGeometry *)geometry;
209 
219 -(nullable AGSArcGISFeature *)createFeatureWithTemplate:(AGSFeatureTemplate *)featureTemplate geometry:(AGSGeometry *)geometry;
220 
229 -(nullable AGSArcGISFeature *)createFeatureWithType:(AGSFeatureType *)featureType;
230 
240 -(nullable AGSArcGISFeature *)createFeatureWithType:(AGSFeatureType *)featureType geometry:(AGSGeometry *)geometry;
241 
250 -(id<AGSCancelable>)addedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
251 
260 -(id<AGSCancelable>)addedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
261 
270 -(id<AGSCancelable>)deletedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
271 
280 -(id<AGSCancelable>)deletedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
281 
290 -(id<AGSCancelable>)updatedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult * __nullable result, NSError * __nullable error))completion;
291 
300 -(id<AGSCancelable>)updatedFeaturesCountWithCompletion:(void(^)(NSInteger count, NSError * __nullable error))completion;
301 
307 -(nullable AGSFeatureTemplate *)featureTemplateForName:(NSString *)name;
308 
314 -(nullable AGSFeatureType *)featureTypeForName:(NSString *)name;
315 
325 - (BOOL)hasLocalEdits;
326 
334 -(nullable NSArray<AGSArcGISFeatureTable*> *)relatedTablesWithRelationshipInfo:(AGSRelationshipInfo *)relationshipInfo;
335 
341 -(nullable NSArray<AGSArcGISFeatureTable*> *)relatedTables;
342 
351 -(id<AGSCancelable>)queryRelatedFeatureCountForFeature:(AGSArcGISFeature *)feature
352  completion:(void(^)(NSInteger count, NSError * __nullable error))completion;
353 
363 -(id<AGSCancelable>)queryRelatedFeatureCountForFeature:(AGSArcGISFeature *)feature
364  parameters:(AGSRelatedQueryParameters *)parameters
365  completion:(void(^)(NSInteger count, NSError * __nullable error))completion;
366 
378 -(id<AGSCancelable>)queryRelatedFeaturesForFeature:(AGSArcGISFeature *)feature
379  completion:(void(^)(NSArray<AGSRelatedFeatureQueryResult*> * __nullable results, NSError * __nullable error))completion;
380 
393 -(id<AGSCancelable>)queryRelatedFeaturesForFeature:(AGSArcGISFeature *)feature
394  parameters:(AGSRelatedQueryParameters *)parameters
395  completion:(void(^)(NSArray<AGSRelatedFeatureQueryResult*> * __nullable results, NSError * __nullable error))completion;
396 
421 -(id<AGSCancelable>)validateRelationshipConstraintsForFeature:(AGSArcGISFeature *)feature
422  completion:(void(^)(AGSRelationshipConstraintViolationType relationshipConstraintViolationType, NSError * __nullable error))completion;
423 
433 - (id<AGSCancelable>)localEditsCountWithCompletion:(void(^)(NSInteger result, NSError * _Nullable error))completion;
434 
448 - (id<AGSCancelable>)localEditsWithCompletion:(void(^)(AGSLocalFeatureEditsResult * _Nullable result, NSError * _Nullable error))completion;
449 
465 - (AGSContingentValuesResult *)contingentValuesWithFeature:(AGSArcGISFeature *)feature
466  field:(NSString *)field;
467 
474 - (NSArray<AGSContingencyConstraintViolation *> *)validateContingencyConstraintsWithFeature:(AGSArcGISFeature *)feature;
475 
476 @end
477 
479 
485 
486 @end
487 
488 
AGSRelationshipConstraintViolationType
Definition: AGSArcGISFeatureTable.h:37
@ AGSRelationshipConstraintViolationTypeCardinality
Definition: AGSArcGISFeatureTable.h:39
@ AGSRelationshipConstraintViolationTypeOrphaned
Definition: AGSArcGISFeatureTable.h:40
@ AGSRelationshipConstraintViolationTypeNone
Definition: AGSArcGISFeatureTable.h:38
Definition: AGSArcGISFeatureTable.h:478
AGSRelationshipConstraintViolationType ags_relationshipConstraintViolationTypeValue()
An AGSFeature object stored in an AGSArcGISFeatureTable object.
Definition: AGSArcGISFeature.h:61
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:69
NSArray< AGSFeatureSubtype * > * featureSubtypes
Definition: AGSArcGISFeatureTable.h:100
nullable NSArray< AGSArcGISFeatureTable * > * relatedTables()
AGSContingentValuesDefinition * contingentValuesDefinition
Definition: AGSArcGISFeatureTable.h:83
NSString * typeIDField
Definition: AGSArcGISFeatureTable.h:153
NSArray< AGSFeatureTemplate * > * featureTemplates
Definition: AGSArcGISFeatureTable.h:107
NSString * subtypeField
Definition: AGSArcGISFeatureTable.h:141
AGSArcGISFeatureLayerInfo * layerInfo
Definition: AGSArcGISFeatureTable.h:147
NSArray< AGSField * > * editableAttributeFields
Definition: AGSArcGISFeatureTable.h:94
NSArray< AGSFeatureType * > * featureTypes
Definition: AGSArcGISFeatureTable.h:114
NSInteger serviceLayerID
Definition: AGSArcGISFeatureTable.h:136
BOOL useAdvancedSymbology
Definition: AGSArcGISFeatureTable.h:160
NSString * objectIDField
Definition: AGSArcGISFeatureTable.h:130
NSDictionary< NSString *, id > * unknownJSON
Definition: AGSArcGISFeatureTable.h:167
BOOL hasAttachments
Definition: AGSArcGISFeatureTable.h:124
NSDictionary< NSString *, id > * unsupportedJSON
Definition: AGSArcGISFeatureTable.h:174
id defaultSubtypeCode
Definition: AGSArcGISFeatureTable.h:89
NSString * globalIDField
Definition: AGSArcGISFeatureTable.h:119
An object that defines a contingency constraint violation.
Definition: AGSContingencyConstraintViolation.h:47
An object that defines a contingent values definition.
Definition: AGSContingentValuesDefinition.h:39
An object that defines possible values for a field in the context of the contingent field groups it p...
Definition: AGSContingentValuesResult.h:39
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:65
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
An object that contains an enumerator that can iterate AGSLocalFeatureEdit results in ascending order...
Definition: AGSLocalFeatureEditsResult.h:40
Information about a feature table's relationship.
Definition: AGSRelationshipInfo.h:72
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38