ArcGIS Runtime SDK for iOS: AGSGenerateLayerOption Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSGenerateLayerOption Class Reference

Description

Options defining what data to include for a layer in a geodatabase.

Instances of this class represent options that define what data is included in a sync-enabled geodatabase for a particular layer or table.

Since
100
See also
AGSGenerateGeodatabaseParameters::layerOptions
Inheritance diagram for AGSGenerateLayerOption:
AGSObject

Instance Methods

(instancetype) - initWithLayerID:
 
(instancetype) - initWithLayerID:includeRelated:
 
(instancetype) - initWithLayerID:whereClause:
 

Class Methods

(instancetype) + generateLayerOption
 
(instancetype) + generateLayerOptionWithLayerID:
 
(instancetype) + generateLayerOptionWithLayerID:includeRelated:
 
(instancetype) + generateLayerOptionWithLayerID:whereClause:
 

Properties

BOOL includeRelated
 
NSInteger layerID
 
AGSGenerateLayerQueryOption queryOption
 
BOOL useGeometry
 
NSString * whereClause
 

Method Documentation

◆ generateLayerOption

+ (instancetype) generateLayerOption

Creates a layer option.

Returns
A new layer option object.
Since
100

◆ generateLayerOptionWithLayerID:

+ (instancetype) generateLayerOptionWithLayerID: (NSInteger)  layerID

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
Returns
A new layer option object.
Since
100

◆ generateLayerOptionWithLayerID:includeRelated:

+ (instancetype) generateLayerOptionWithLayerID: (NSInteger)  layerID
includeRelated: (BOOL)  includeRelated 

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
includeRelatedSpecifies whether to include any data from this layer that is related to data in other layers in the geodatabase. This parameters is only valid if the layer participates in any relationships, and if those related layers are also included in the geodatabase.
Returns
A new layer option object.
Since
100

◆ generateLayerOptionWithLayerID:whereClause:

+ (instancetype) generateLayerOptionWithLayerID: (NSInteger)  layerID
whereClause: (NSString *)  whereClause 

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
whereClauseAn attribute query to specify which features should be included in the geodatabase.
Returns
A new layer option object.
Since
100

◆ initWithLayerID:

- (instancetype) initWithLayerID: (NSInteger)  layerID

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
Since
100

◆ initWithLayerID:includeRelated:

- (instancetype) initWithLayerID: (NSInteger)  layerID
includeRelated: (BOOL)  includeRelated 

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
includeRelatedSpecifies whether to include any data from this layer that is related to data in other layers in the geodatabase. This parameters is only valid if the layer participates in any relationships, and if those related layers are also included in the geodatabase.
Since
100

◆ initWithLayerID:whereClause:

- (instancetype) initWithLayerID: (NSInteger)  layerID
whereClause: (NSString *)  whereClause 

Creates a layer option with provided parameters.

Parameters
layerIDThe ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.
whereClauseAn attribute query to specify which features should be included in the geodatabase.
Since
100

Property Documentation

◆ includeRelated

- (BOOL) includeRelated
readwritenonatomicassign

Specifies whether to include any data from this layer that is related to data in other layers in the geodatabase. This parameters is only valid if the layer participates in any relationships, and if those related layers are also included in the geodatabase.

Note
Only applicable if queryOption is set to AGSGenerateLayerQueryOptionNone.
Since
100

◆ layerID

- (NSInteger) layerID
readwritenonatomicassign

The ID of the layer for which these options are defined. Same as the AGSArcGISFeatureLayerInfo::serverLayerID property.

Since
100

◆ queryOption

- (AGSGenerateLayerQueryOption) queryOption
readwritenonatomicassign

Specifies how features should be included in the sync-enabled geodatabase.

Since
100

◆ useGeometry

- (BOOL) useGeometry
readwritenonatomicassign

Determines whether to filter features based on geometry to include in the geodatabase. Only features that intersect the AGSGenerateGeodatabaseParameters::extent property are considered for inclusion. Default value is YES.

Note
Only applicable if queryOption is set to AGSGenerateLayerQueryOptionUseFilter.
See also
whereClause for additional filtering option.
Since
100

◆ whereClause

- (NSString*) whereClause
readwritenonatomiccopy

An attribute query to filter which features should be included in the geodatabase. Can be empty, in which case features are not filtered based on the where clause.

Note
Only applicable if queryOption is set to AGSGenerateLayerQueryOptionUseFilter.
See also
useGeometry for additional filtering option.
Since
100