Description

An ArcGIS specific source for dataset containing geographic features or non-spatial records.

Subclasses represent an ArcGIS-specific source for dataset that could include either geographic features or non-spatial records. You can query the dataset using attribute or spatial criteria, and if permitted, also edit the data. Edits are tracked, so you can later retrieve a list of edits. If the dataset contains geographic features you can display them on a map using AGSFeatureLayer.

Since: 100

Inheritance diagram for AGSArcGISFeatureTable:

Instance Methods
(id< AGSCancelable >)	- addedFeaturesCountWithCompletion:

(id< AGSCancelable >)	- addedFeaturesWithCompletion:

(id< AGSCancelable >)	- addFeature:completion:

(id< AGSCancelable >)	- addFeatures:completion:

(void)	- cancelLoad

(BOOL)	- canDeleteFeature:

(BOOL)	- canUpdateFeature:

(AGSContingentValuesResult *)	- contingentValuesWithFeature:field:

(AGSFeature *)	- createFeature

(AGSFeature *)	- createFeatureWithAttributes:geometry:

(nullable AGSArcGISFeature *)	- createFeatureWithSubtype:

(nullable AGSArcGISFeature *)	- createFeatureWithSubtype:geometry:

(nullable AGSArcGISFeature *)	- createFeatureWithTemplate:

(nullable AGSArcGISFeature *)	- createFeatureWithTemplate:geometry:

(nullable AGSArcGISFeature *)	- createFeatureWithType:

(nullable AGSArcGISFeature *)	- createFeatureWithType:geometry:

(id< AGSCancelable >)	- deletedFeaturesCountWithCompletion:

(id< AGSCancelable >)	- deletedFeaturesWithCompletion:

(id< AGSCancelable >)	- deleteFeature:completion:

(id< AGSCancelable >)	- deleteFeatures:completion:

(void)	- doCancelLoading

(void)	- doStartLoading:

(nullable AGSFeatureTemplate *)	- featureTemplateForName:

(nullable AGSFeatureType *)	- featureTypeForName:

(nullable AGSField *)	- fieldForName:

(BOOL)	- hasLocalEdits

(void)	- loadDidFinishWithError:

(void)	- loadWithCompletion:

(id< AGSCancelable >)	- localEditsCountWithCompletion:

(id< AGSCancelable >)	- localEditsWithCompletion:

(void)	- onLoadStatusChanged

(id< AGSCancelable >)	- queryExtentWithParameters:completion:

(id< AGSCancelable >)	- queryFeatureCountWithParameters:completion:

(id< AGSCancelable >)	- queryFeaturesWithParameters:completion:

(id< AGSCancelable >)	- queryRelatedFeatureCountForFeature:completion:

(id< AGSCancelable >)	- queryRelatedFeatureCountForFeature:parameters:completion:

(id< AGSCancelable >)	- queryRelatedFeaturesForFeature:completion:

(id< AGSCancelable >)	- queryRelatedFeaturesForFeature:parameters:completion:

(id< AGSCancelable >)	- queryStatisticsWithParameters:completion:

(nullable NSArray< AGSArcGISFeatureTable * > *)	- relatedTables

(nullable NSArray< AGSArcGISFeatureTable * > *)	- relatedTablesWithRelationshipInfo:

(void)	- retryLoadWithCompletion:

(id< AGSCancelable >)	- updatedFeaturesCountWithCompletion:

(id< AGSCancelable >)	- updatedFeaturesWithCompletion:

(id< AGSCancelable >)	- updateFeature:completion:

(id< AGSCancelable >)	- updateFeatures:completion:

(NSArray< AGSContingencyConstraintViolation * > *)	- validateContingencyConstraintsWithFeature:

(id< AGSCancelable >)	- validateRelationshipConstraintsForFeature:completion:

Properties
BOOL	canAddFeature

BOOL	canEditGeometry

AGSContingentValuesDefinition *	contingentValuesDefinition

id	defaultSubtypeCode

NSString *	displayName

BOOL	editable

NSArray< AGSField * > *	editableAttributeFields

AGSEnvelope *	extent

AGSFeatureLayer *	featureLayer

NSArray< AGSFeatureSubtype * > *	featureSubtypes

NSArray< AGSFeatureTemplate * > *	featureTemplates

NSArray< AGSFeatureType * > *	featureTypes

NSArray< AGSField * > *	fields

AGSGeometryType	geometryType

NSString *	globalIDField

BOOL	hasAttachments

BOOL	hasGeometry

BOOL	hasM

BOOL	hasZ

AGSLayer *	layer

AGSArcGISFeatureLayerInfo *	layerInfo

NSError *	loadError

AGSLoadStatus	loadStatus

NSInteger	numberOfFeatures

NSString *	objectIDField

AGSPopupDefinition *	popupDefinition

BOOL	popupEnabled

NSInteger	serviceLayerID

AGSSpatialReference *	spatialReference

NSString *	subtypeField

NSString *	tableName

NSString *	typeIDField

NSDictionary< NSString , id >	unknownJSON

NSDictionary< NSString , id >	unsupportedJSON

BOOL	useAdvancedSymbology

Method Documentation

◆ addedFeaturesCountWithCompletion:

- (id<AGSCancelable>) addedFeaturesCountWithCompletion: (void(^)(NSInteger count, NSError *__nullable error)) completion

Retrieves the number of features that have been locally added to the dataset, but not yet to the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves 0 because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The count parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ addedFeaturesWithCompletion:

- (id<AGSCancelable>) addedFeaturesWithCompletion: (void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error)) completion

Retrieves the features that have been locally added to the dataset, but not yet to the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves no features because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ cancelLoad

- (void) cancelLoad

requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since: 100

◆ canDeleteFeature:

- (BOOL) canDeleteFeature: (AGSFeature *) feature

Indicates whether the source allows this particular feature to be deleted. The method first checks to verify if the source is capable of deleting any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to delete this particular feature.

Parameters

feature Can be nil, in which case, this method only checks if the source is capable of deleting any features in general

Returns: A boolean value

Since: 100

◆ canUpdateFeature:

- (BOOL) canUpdateFeature: (AGSFeature *) feature

Indicates whether the source allows updating this particular feature. The method first checks to verify if the source is capable of updating any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to edit this patricular feature.

Parameters

feature Can be nil, in which case, this method only checks if the source is capable of updating any features in general

Returns: A boolean value

Since: 100

◆ contingentValuesWithFeature:field:

- (AGSContingentValuesResult *) contingentValuesWithFeature:	(AGSArcGISFeature *)	feature
field:	(NSString *)	field

Returns possible values for the specified field, in the context of defined contingencies.

This method iterates over all the field groups that the input field participates in. For each, it looks at the input feature's field values for the other fields participating in that field group. Contingencies that are satisfied by the other fields are identified, and their values for the input field are aggregated. These are returned in an AGSContingentValuesResult, which contains a dictionary of field group names to an array of AGSContingentValue objects accessed via AGSContingentValuesResult::contingentValuesByFieldGroup, specifying possible values for the input field that will satisfy a contingency in that field group. If the feature participates in multiple field groups and there are values that will satisfy all groups, they will be returned by AGSContingentValuesResult::contingentValuesAllGroups.

Parameters

feature	The feature.
field	The name of the field for which to get possible values.

Returns: An AGSContingentValuesResult.

Since: 100.13

◆ createFeature

- (AGSFeature *) createFeature

Create a new, empty feature. Note, the new feature is only available in memory at this point, it is not committed to the dataset.

Returns: empty feature

Since: 100

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ createFeatureWithAttributes:geometry:

- (AGSFeature *) createFeatureWithAttributes:	(NSDictionary< NSString , id > )	attributes
geometry:	(nullable AGSGeometry *)	geometry

Create a new feature with the provided attribute values and, optionally, geometry. Note, the new feature is only available in memory at this point, it is not committed to the dataset.

Parameters

attributes	for the feature
geometry	for the feature

Returns: feature

Since: 100

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ createFeatureWithSubtype:

- (nullable AGSArcGISFeature *) createFeatureWithSubtype: (AGSFeatureSubtype *) featureSubtype

Creates a new feature based on the specified feature subtype. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureSubtype The subtype of feature to create.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100.3

◆ createFeatureWithSubtype:geometry:

- (nullable AGSArcGISFeature *) createFeatureWithSubtype:	(AGSFeatureSubtype *)	featureSubtype
geometry:	(AGSGeometry *)	geometry

Creates a new feature based on the specified feature subtype and geoemtry. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureSubtype	The type of feature to create.
geometry	The geometry for the feature.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100.3

◆ createFeatureWithTemplate:

- (nullable AGSArcGISFeature *) createFeatureWithTemplate: (AGSFeatureTemplate *) featureTemplate

Creates a new feature based on the specified feature template. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureTemplate The feature template to use while creating the feature.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100

◆ createFeatureWithTemplate:geometry:

- (nullable AGSArcGISFeature *) createFeatureWithTemplate:	(AGSFeatureTemplate *)	featureTemplate
geometry:	(AGSGeometry *)	geometry

Creates a new feature based on the specified feature template and geometry. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureTemplate	The feature template to use while creating the feature.
geometry	The geometry for the feature.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100

◆ createFeatureWithType:

- (nullable AGSArcGISFeature *) createFeatureWithType: (AGSFeatureType *) featureType

Creates a new feature based on the specified feature type. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureType The type of feature to create.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100

◆ createFeatureWithType:geometry:

- (nullable AGSArcGISFeature *) createFeatureWithType:	(AGSFeatureType *)	featureType
geometry:	(AGSGeometry *)	geometry

Creates a new feature based on the specified feature type and geoemtry. Note, the new feature is only available in memory at this point, it is not commited to the dataset.

Parameters

featureType	The type of feature to create.
geometry	The geometry for the feature.

Returns: The new feature.

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion: (AGSFeatureTable)

Since: 100

◆ deletedFeaturesCountWithCompletion:

- (id<AGSCancelable>) deletedFeaturesCountWithCompletion: (void(^)(NSInteger count, NSError *__nullable error)) completion

Retrieves the number of features that have been locally deleted from the dataset, but not yet from the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves 0 because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The count parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ deletedFeaturesWithCompletion:

- (id<AGSCancelable>) deletedFeaturesWithCompletion: (void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error)) completion

Retrieves the features that have been locally deleted from the dataset, but not yet from the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves no features because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL) retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters

retrying flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ featureTemplateForName:

- (nullable AGSFeatureTemplate *) featureTemplateForName: (NSString *) name

Convenience method to retrieve a feature template given its name.

Parameters

name	The name of a feature template.

Returns: The feature template.

Since: 100

◆ featureTypeForName:

- (nullable AGSFeatureType *) featureTypeForName: (NSString *) name

Convenience method to retrieve a feature type given its name.

Parameters

name	The name of a feature type.

Returns: The feature type.

Since: 100

◆ fieldForName:

- (nullable AGSField *) fieldForName: (NSString *) fieldName

Convenience method to getting a field object given its name

Parameters

fieldName The name of the field.

Returns: field

Since: 100

◆ hasLocalEdits

- (BOOL) hasLocalEdits

Checks whether the feature table has local edits.

For AGSServiceFeatureTable, local edits are edits that have not yet been applied to the feature service. For AGSGeodatabaseFeatureTable, local edits are edits that have been made since the last acknowledged upload. For mobile geodatabases created by ArcGIS Pro, this method returns NO because there is no concept of uploading or applying edits. For mobile geodatabases, use AGSGeodatabaseFeatureTable::hasLocalEditsSinceWithDate:.

Returns: Whether the table has local edits.

Since: 100.9

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *) error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

See also: - cancelLoad to cancel loading; - retryLoadWithCompletion: to force reload

◆ localEditsCountWithCompletion:

- (id<AGSCancelable>) localEditsCountWithCompletion: (void(^)(NSInteger result, NSError *_Nullable error)) completion

Fetches the number of features that were added, updated, or deleted since the last sync.

For mobile geodatabases created by ArcGIS Pro, this method returns a count of 0 because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The result parameter is zero or more if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100.12

◆ localEditsWithCompletion:

- (id<AGSCancelable>) localEditsWithCompletion: (void(^)(AGSLocalFeatureEditsResult *_Nullable result, NSError *_Nullable error)) completion

Fetches a AGSLocalFeatureEditsResult object which contains an enumerator property that can iterate over the feature edits that were added, updated, or deleted since the last sync.

For a mobile geodatabase created by ArcGIS Pro, there are no feature edits as there is no concept of syncing.

Note that edits inside a transaction (between calls to beginTransaction: (AGSGeodatabase) and either commitTransaction: (AGSGeodatabase) or rollbackTransaction: (AGSGeodatabase)) share a common AGSLocalFeatureEdit::editDate and may not be returned in a consistent order.

Parameters

completion A block that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100.12

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ queryExtentWithParameters:completion:

- (id<AGSCancelable>) queryExtentWithParameters:	(AGSQueryParameters *)	parameters
completion:	(void(^)(AGSEnvelope __nullable extent, NSError __nullable error))	completion

Query the dataset to find the geographic extent covering matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryFeatureCountWithParameters:completion:

- (id<AGSCancelable>) queryFeatureCountWithParameters:	(AGSQueryParameters *)	parameters
completion:	(void(^)(NSInteger count, NSError *__nullable error))	completion

Query the dataset to find the number of matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryFeaturesWithParameters:completion:

- (id<AGSCancelable>) queryFeaturesWithParameters:	(AGSQueryParameters *)	parameters
completion:	(nullable void(^)(AGSFeatureQueryResult __nullable result, NSError __nullable error))	completion

Query the dataset to find specific features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100

◆ queryRelatedFeatureCountForFeature:completion:

- (id<AGSCancelable>) queryRelatedFeatureCountForFeature:	(AGSArcGISFeature *)	feature
completion:	(void(^)(NSInteger count, NSError *__nullable error))	completion

Performs a query that returns the number of related features to the supplied feature.

Parameters

feature	The feature which should be queried for the number of related features.
completion	Block that is invoked when the operation finishes. The `result` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryRelatedFeatureCountForFeature:parameters:completion:

- (id<AGSCancelable>) queryRelatedFeatureCountForFeature:	(AGSArcGISFeature *)	feature
parameters:	(AGSRelatedQueryParameters *)	parameters
completion:	(void(^)(NSInteger count, NSError *__nullable error))	completion

Performs a query that returns the number of related features to supplied feature based on the parameters.

Parameters

feature	The feature which should be queried for the number of related features.
parameters	The parameters to the query.
completion	Block that is invoked when the operation finishes. The `result` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryRelatedFeaturesForFeature:completion:

- (id<AGSCancelable>) queryRelatedFeaturesForFeature:	(AGSArcGISFeature *)	feature
completion:	(void(^)(NSArray< AGSRelatedFeatureQueryResult * > __nullable results, NSError __nullable error))	completion

Performs a query that returns all features (spatial or non-spatial) that are related to the specified feature. The related features must belong to a feature table that is related to this feature table. Also, the related tables must be part of either the map's operational layers collection (AGSGeoModel::operationalLayers) through a feature layer if they are spatial, or the map's tables collection (AGSGeoModel::tables) directly if they are non-spatial.

Parameters

feature	A feature to find related features (spatial and non-spatial).
completion	A block that is invoked when the operation finishes. The `results` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

See also: AGSFeatureServiceSessionType

Since: 100.1

◆ queryRelatedFeaturesForFeature:parameters:completion:

- (id<AGSCancelable>) queryRelatedFeaturesForFeature:	(AGSArcGISFeature *)	feature
parameters:	(AGSRelatedQueryParameters *)	parameters
completion:	(void(^)(NSArray< AGSRelatedFeatureQueryResult * > __nullable results, NSError __nullable error))	completion

Performs a query that returns features (spatial or non-spatial) that are related to the specified feature based on the provided parameters. The related features must belong to a feature table that is related to this feature table. Also, the related tables must be part of either the map's operational layers collection (AGSGeoModel::operationalLayers) through a feature layer if they are spatial, or the map's tables collection (AGSGeoModel::tables) directly if they are non-spatial.

Parameters

feature	A feature to find related features (spatial and non-spatial).
parameters	Parameters specifying which related features to query.
completion	A block that is invoked when the operation finishes. The `results` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

See also: AGSFeatureServiceSessionType

Since: 100.1

◆ queryStatisticsWithParameters:completion:

- (id<AGSCancelable>) queryStatisticsWithParameters:	(AGSStatisticsQueryParameters *)	parameters
completion:	(void(^)(AGSStatisticsQueryResult __nullable result, NSError __nullable error))	completion

Query the dataset to compute statistics on matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ relatedTables

- (nullable NSArray<AGSArcGISFeatureTable*> *) relatedTables

All feature tables (spatial or non-spatial) that are related to this feature table. The related tables must be part of either the map's operational layers collection (AGSGeoModel::operationalLayers) through a feature layer if they are spatial, or the map's tables collection (AGSGeoModel::tables) directly if they are non-spatial.

Since: 100.1

◆ relatedTablesWithRelationshipInfo:

- (nullable NSArray<AGSArcGISFeatureTable*> *) relatedTablesWithRelationshipInfo: (AGSRelationshipInfo *) relationshipInfo

The feature tables (spatial or non-spatial) that are related to this feature table through the specified relationship. The related feature tables must be a part of either the map's operational layers collection (AGSGeoModel::operationalLayers) through a feature layer if they are spatial, or the map's tables collection (AGSGeoModel::tables) directly if they are non-spatial.

Parameters

relationshipInfo Relationship information for specifying the relationship based on which results should be returned.

Returns: An array of feature table objects that are related to this table through the specified relationship.

Since: 100.1

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
the server was down earlier when it failed and you want to retry
the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

◆ updatedFeaturesCountWithCompletion:

- (id<AGSCancelable>) updatedFeaturesCountWithCompletion: (void(^)(NSInteger count, NSError *__nullable error)) completion

Retrieves the number of features that have been locally updated in the dataset, but not yet in the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves 0 because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The count parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ updatedFeaturesWithCompletion:

- (id<AGSCancelable>) updatedFeaturesWithCompletion: (void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error)) completion

Retrieves the features that have been locally updated in the dataset, but not yet in the originating source.

For mobile geodatabases created by ArcGIS Pro, this method retrieves no features because there is no concept of syncing.

Parameters

completion A block that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.

Returns: An operation which can be canceled.

Since: 100

◆ validateContingencyConstraintsWithFeature:

- (NSArray<AGSContingencyConstraintViolation *> *) validateContingencyConstraintsWithFeature: (AGSArcGISFeature *) feature

Returns an array of contingency constraint violations based on the input feature. An empty array indicates that all contingencies associated with the feature are valid.

Parameters

feature The feature.

Returns: An array of AGSContingencyConstraintViolation.

Since: 100.13

◆ validateRelationshipConstraintsForFeature:completion:

- (id<AGSCancelable>) validateRelationshipConstraintsForFeature:	(AGSArcGISFeature *)	feature
completion:	(void(^)(AGSRelationshipConstraintViolationType relationshipConstraintViolationType, NSError *__nullable error))	completion

Checks to see if performing edit operations (addFeature:completion: (AGSFeatureTable) or updateFeature:completion: (AGSFeatureTable)) with the provided feature could lead to a relationship constraint violation. This method makes network calls to query for the related features if they are not present locally

Note: Edit operations such as addFeature:completion: (AGSFeatureTable), updateFeature:completion: (AGSFeatureTable) do not error due to relationship constraint violations. Rather, it is the responsibility of the developer to use this method to explicitly check for violations after the edit is performed. Alternatively, you can recover from violations in a back office operation after applying edits or syncing with the service, if you choose to do so. See ArcGIS Desktop Validate Features process.

The following are types of violations that may be reported:

AGSRelationshipConstraintViolationTypeOrphaned : In a composite relationship, adding an orphan feature to the destination table without relating it to an origin feature. To recover from this violation, relate the feature to a valid origin feature.
AGSRelationshipConstraintViolationTypeCardinality - cardinality violations:
In 1:1 relationships, if an origin feature is already related to a destination feature, it is a violation to relate another feature to either of them. To recover from this violation, unrelate the feature from the origin feature.
In 1:n relationships, it is a violation to relate a destination feature to more than one origin feature. To recover from this violation, unrelate the feature from the origin feature.

Parameters

feature	A feature for which relationship constraints need to be validated.
completion	A block that is invoked when the operation finishes. The `relationshipConstraintViolationType` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

Since: 100.1

See also: - relateToFeature: (AGSArcGISFeature) to relate two features.; - unrelateToFeature: (AGSArcGISFeature) to unrelate two features.

Property Documentation

◆ canAddFeature

- (BOOL) canAddFeature

readnonatomicassigninherited

Indicates whether the source supports adding new features.

Since: 100

◆ canEditGeometry

- (BOOL) canEditGeometry

readnonatomicassigninherited

Indicates whether the source supports updating geometry of existing features.

Since: 100

◆ contingentValuesDefinition

- (AGSContingentValuesDefinition*) contingentValuesDefinition

readnonatomicstrong

The table's contingent values definition.

The contingent values definition must be loaded after the table has loaded. If the list of field groups is empty after loading, then no contingent values are defined for this table.

Since: 100.13

◆ defaultSubtypeCode

- (id) defaultSubtypeCode

readnonatomiccopy

The code for the default feature subtype. This value is for the field specified in the subtypeField property.

See also: #featureSubTypes for the list of feature subtypes available.

Since: 100.3

◆ displayName

- (NSString*) displayName

readwritenonatomiccopyinherited

User-friendly name that can be displayed in the UI (for example in a Table of Contents)

Since: 100.3

◆ editable

- (BOOL) editable

readnonatomicassigninherited

Indicates whether the dataset can be edited. For details on which fine-grained editing capabilites are supported, refer to canUpdateFeature: and canDeleteFeature:

Since: 100

◆ editableAttributeFields

- (NSArray<AGSField*>*) editableAttributeFields

readnonatomiccopy

Array of AGSField objects representing the subset of fields (columns) in the dataset that are editable.

Since: 100

◆ extent

- (AGSEnvelope*) extent

readnonatomicstronginherited

The extent of the dataset.

Since: 100

◆ featureLayer

- (AGSFeatureLayer*) featureLayer

readnonatomicweakinherited

The feature layer this table is associated with, or created from, if any. nil if this table is not associated with a feature layer. This property is populated when the AGSFeatureLayer is created from the AGSFeatureTable.

Since: 100.0

Deprecated:: 100.7.0. Use AGSFeatureTable::layer instead

Provided by category AGSFeatureTable(AGSDeprecated).

◆ featureSubtypes

- (NSArray<AGSFeatureSubtype*>*) featureSubtypes

readnonatomiccopy

An array of AGSFeatureSubtype objects representing feature sub-types in the layer. For example, a roads layer may contain 2 feature sub-types : highways and streets.

Since: 100.3

◆ featureTemplates

- (NSArray<AGSFeatureTemplate*>*) featureTemplates

readnonatomiccopy

An array of AGSFeatureTemplate objects representing feature templates for the layer. Usually only present if the layer does not contain feature sub-types. Only applicable if this dataset is based on an ArcGIS feature service.

Since: 100

◆ featureTypes

- (NSArray<AGSFeatureType*>*) featureTypes

readnonatomiccopy

An array of AGSFeatureType objects representing feature sub-types in the layer. For example, a roads layer may contain 2 feature sub-types : highways and streets.

Availability:: This feature is only available with services from ArcGIS Server 10.0 or above

Since: 100

◆ fields

- (NSArray<AGSField*>*) fields

readnonatomiccopyinherited

Array of AGSField objects representing the fields (columns) in the dataset.

See also: AGSField

Since: 100

◆ geometryType

- (AGSGeometryType) geometryType

readnonatomicassigninherited

The type of geometry used by geographic feautres. Only applicable if hasGeometry is true.

Since: 100

◆ globalIDField

- (NSString*) globalIDField

readnonatomiccopy

The name of field which contains the GLOBALID for each feature.

Since: 100

◆ hasAttachments

- (BOOL) hasAttachments

readnonatomicassign

Indicates whether features may have attachments.

Since: 100

◆ hasGeometry

- (BOOL) hasGeometry

readnonatomicassigninherited

Indicates whether the dataset contains a geometry field (column). If YES, the dataset contains geographic features. If NO, the dataset contains non-spatial records, similar to a database table.

Since: 100

◆ hasM

- (BOOL) hasM

readnonatomicassigninherited

Indicates whether features may contain M values

Since: 100.2

◆ hasZ

- (BOOL) hasZ

readnonatomicassigninherited

Indicates whether features may contain Z values

Since: 100.2

◆ layer

- (AGSLayer*) layer

readnonatomicweakinherited

The layer this table is associated with, or created from, if any. This can be an AGSAnnotationLayer, an AGSDimensionLayer, an AGSFeatureLayer, or nil if this table is not associated with a layer. This property is populated when the layer is created from the AGSFeatureTable.

Since: 100.7

◆ layerInfo

- (AGSArcGISFeatureLayerInfo*) layerInfo

readnonatomicstrong

Information about the source this dataset originates from.

Since: 100

◆ loadError

- (NSError*) loadError

readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since: 100

◆ loadStatus

- (AGSLoadStatus) loadStatus

readrequirednonatomicassigninherited

Status of the load operation.

Since: 100

◆ numberOfFeatures

- (NSInteger) numberOfFeatures

readnonatomicassigninherited

The total number of features or records in the dataset.

Since: 100

◆ objectIDField

- (NSString*) objectIDField

readnonatomiccopy

The name of field which contains the OBJECTID for each feature.

Since: 100

◆ popupDefinition

- (AGSPopupDefinition*) popupDefinition

readwritenonatomicstronginherited

The AGSPopupDefinition associated with the popup source. This property will be nil if an error occurs or if the popup source is not associated with a popup definition.

Since: 100

◆ popupEnabled

- (BOOL) popupEnabled

readwriterequirednonatomicassigninherited

Indicates whether popups are enabled on this source.

Since: 100

◆ serviceLayerID

- (NSInteger) serviceLayerID

readnonatomicassign

The ID of the layer this table corresponds to in the service.

Since: 100

◆ spatialReference

- (AGSSpatialReference*) spatialReference

readnonatomicstronginherited

The spatial reference of the dataset.

Since: 100

◆ subtypeField

- (NSString*) subtypeField

readnonatomiccopy

The name of the field which contains the sub-type information for each feature.

Since: 100.3

◆ tableName

- (NSString*) tableName

readnonatomiccopyinherited

Name of the dataset.

Since: 100

◆ typeIDField

- (NSString*) typeIDField

readnonatomiccopy

The name of the field which contains the sub-type information for each feature.

Availability:: This feature is only available with services from ArcGIS Server 10.0 or above

Since: 100

◆ unknownJSON

- (NSDictionary<NSString *, id>*) unknownJSON

readnonatomiccopy

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was not parsed by the Runtime.

See also: NSDictionary

Since: 100.8

◆ unsupportedJSON

- (NSDictionary<NSString *, id>*) unsupportedJSON

readnonatomiccopy

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through the native Runtime API.

See also: NSDictionary

Since: 100.8

◆ useAdvancedSymbology

- (BOOL) useAdvancedSymbology

readwritenonatomicassign

Indicates whether the dataset should be visualized using advanced CIM symbols. The default is NO. Servers which don't support this simply ignore the parameter and return regular symbols instead.

Since: 100

Note: You cannot change this after the table is successfully loaded.

Description

Instance Methods

Properties

Method Documentation

◆ addedFeaturesCountWithCompletion:

◆ addedFeaturesWithCompletion:

◆ cancelLoad

◆ canDeleteFeature:

◆ canUpdateFeature:

◆ contingentValuesWithFeature:field:

◆ createFeature

◆ createFeatureWithAttributes:geometry:

◆ createFeatureWithSubtype:

◆ createFeatureWithSubtype:geometry:

◆ createFeatureWithTemplate:

◆ createFeatureWithTemplate:geometry:

◆ createFeatureWithType:

◆ createFeatureWithType:geometry:

◆ deletedFeaturesCountWithCompletion:

◆ deletedFeaturesWithCompletion:

◆ doCancelLoading

◆ doStartLoading:

◆ featureTemplateForName:

◆ featureTypeForName:

◆ fieldForName:

◆ hasLocalEdits

◆ loadDidFinishWithError:

◆ loadWithCompletion:

◆ localEditsCountWithCompletion:

◆ localEditsWithCompletion:

◆ onLoadStatusChanged

◆ queryExtentWithParameters:completion:

◆ queryFeatureCountWithParameters:completion:

◆ queryFeaturesWithParameters:completion:

◆ queryRelatedFeatureCountForFeature:completion:

◆ queryRelatedFeatureCountForFeature:parameters:completion:

◆ queryRelatedFeaturesForFeature:completion:

◆ queryRelatedFeaturesForFeature:parameters:completion:

◆ queryStatisticsWithParameters:completion:

◆ relatedTables

◆ relatedTablesWithRelationshipInfo:

◆ retryLoadWithCompletion:

◆ updatedFeaturesCountWithCompletion:

◆ updatedFeaturesWithCompletion:

◆ validateContingencyConstraintsWithFeature:

◆ validateRelationshipConstraintsForFeature:completion:

Property Documentation

◆ canAddFeature

◆ canEditGeometry

◆ contingentValuesDefinition

◆ defaultSubtypeCode

◆ displayName

◆ editable

◆ editableAttributeFields

◆ extent

◆ featureLayer

◆ featureSubtypes

◆ featureTemplates

◆ featureTypes

◆ fields

◆ geometryType

◆ globalIDField

◆ hasAttachments

◆ hasGeometry

◆ hasM

◆ hasZ

◆ layer

◆ layerInfo

◆ loadError

◆ loadStatus

◆ numberOfFeatures

◆ objectIDField

◆ popupDefinition

◆ popupEnabled

◆ serviceLayerID

◆ spatialReference

◆ subtypeField

◆ tableName

◆ typeIDField

◆ unknownJSON