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

Description

Represents a key associated with a generate offline map parameters override.

Instances of this class represent a key associated with a generate offline map parameters overrides, used to get the specific parameters, for a given online service, from one of the dictionaries exposed by an AGSGenerateOfflineMapParameterOverrides object.

Generate offline map parameters overrides consist of instances of AGSGenerateGeodatabaseParameters, AGSExportTileCacheParameters and AGSExportVectorTilesParameters. Each instance is associated with the service URL that the parameters will be sent to for taking the given data offline. The data type specific parameters can be retrieved from their respective dictionaries on AGSGenerateOfflineMapParameterOverrides with an instance of AGSOfflineMapParametersKey. A key instance for a particular layer can be constructed by calling initWithLayer: (AGSOfflineMapParametersKey). For a service feature table, call initWithServiceFeatureTable: (AGSOfflineMapParametersKey). For a utility network, call initWithUtilityNetwork: (AGSOfflineMapParametersKey). Use the key with the dictionary returned by one of these properties: AGSGenerateOfflineMapParameterOverrides::generateGeodatabaseParameters, AGSGenerateOfflineMapParameterOverrides::exportVectorTilesParameters, AGSGenerateOfflineMapParameterOverrides::exportTileCacheParameters. The particular method to call will be determined by the AGSOfflineMapParametersKey::type property. Note that a given parameters key/value pair may be shared by multiple layers in the map: for example, a single AGSGenerateGeodatabaseParameters object could represent the online settings for multiple feature layers which all access the same underlying feature service.

Since
100.4
Inheritance diagram for AGSOfflineMapParametersKey:
AGSObject

Instance Methods

(instancetype) - initWithLayer:
 
(instancetype) - initWithServiceFeatureTable:
 
(nullable instancetype) - initWithUtilityNetwork:
 
(BOOL) - isEqualToOfflineMapParametersKey:
 

Class Methods

(instancetype) + offlineMapParametersKeyWithLayer:
 
(instancetype) + offlineMapParametersKeyWithServiceFeatureTable:
 
(nullable instancetype) + offlineMapParametersKeyWithUtilityNetwork:
 

Properties

NSURL * serviceURL
 
AGSOfflineMapParametersType type
 

Method Documentation

◆ initWithLayer:

- (instancetype) initWithLayer: (AGSLayer *)  layer

Creates an offline map parameters key with a layer.

Parameters
layerThe layer that you want the offline map parameters key for.
Since
100.4

◆ initWithServiceFeatureTable:

- (instancetype) initWithServiceFeatureTable: (AGSServiceFeatureTable *)  serviceFeatureTable

Creates an offline map parameters key with a service feature table.

Parameters
serviceFeatureTableThe service feature table that you want the offline map parameters key for.
Since
100.4

◆ initWithUtilityNetwork:

- (nullable instancetype) initWithUtilityNetwork: (AGSUtilityNetwork *)  utilityNetwork

Creates an offline map parameters key for the specified AGSUtilityNetwork object.

An AGSUtilityNetwork with URL that points to a feature service which returns YES for AGSSyncCapabilities::supportsUtilityNetworkSystem is supported for offline use.

The returned key can be used to retrieve a data type specific parameter object from the dictionary returned by the AGSGenerateOfflineMapParameterOverrides::generateGeodatabaseParameters property.

If the AGSUtilityNetwork does not support taking Utility Network data offline, nil is returned.

Parameters
utilityNetworkAGSUtilityNetwork that is to be used to access dictionaries in AGSGenerateOfflineMapParameterOverrides object.
Since
100.11

◆ isEqualToOfflineMapParametersKey:

- (BOOL) isEqualToOfflineMapParametersKey: (AGSOfflineMapParametersKey *)  other

Compares whether this offline map parameters key is equal to another.

Parameters
otherThe key to compare this one to.
Returns
Whether the two keys are equal.
Since
100.4

◆ offlineMapParametersKeyWithLayer:

+ (instancetype) offlineMapParametersKeyWithLayer: (AGSLayer *)  layer

Creates an offline map parameters key with a layer.

Parameters
layerThe layer that you want the offline map parameters key for.
Returns
A new parameters key.
Since
100.4

◆ offlineMapParametersKeyWithServiceFeatureTable:

+ (instancetype) offlineMapParametersKeyWithServiceFeatureTable: (AGSServiceFeatureTable *)  serviceFeatureTable

Creates an offline map parameters key with a service feature table.

Parameters
serviceFeatureTableThe service feature table that you want the offline map parameters key for.
Returns
A new parameters key.
Since
100.4

◆ offlineMapParametersKeyWithUtilityNetwork:

+ (nullable instancetype) offlineMapParametersKeyWithUtilityNetwork: (AGSUtilityNetwork *)  utilityNetwork

Creates an offline map parameters key for the specified AGSUtilityNetwork object.

An AGSUtilityNetwork object with URL that points to a feature service which returns YES for AGSSyncCapabilities::supportsUtilityNetworkSystem is supported for offline use.

The returned key can be used to retrieve a data type specific parameter object from the dictionary returned by the AGSGenerateOfflineMapParameterOverrides::generateGeodatabaseParameters property.

If the AGSUtilityNetwork does not support taking Utility Network data offline, nil is returned.

Parameters
utilityNetworkAGSUtilityNetwork that is to be used to access dictionaries in AGSGenerateOfflineMapParameterOverrides object.
Since
100.11

Property Documentation

◆ serviceURL

- (NSURL*) serviceURL
readnonatomicstrong

Get service URL of this key. The service URL is the URL associated with a data specific parameter object in one of the dictionaries owned by an AGSGenerateOfflineMapParameterOverrides instance.

Since
100.4

◆ type

- (AGSOfflineMapParametersType) type
readnonatomicassign

Get the parameter type of this key. The type of this key indicates which AGSGenerateOfflineMapParameterOverrides dictionary this key belongs to.

Since
100.4