AGSExportTileCacheTask Class Reference

Description

A task used to export a tile cache (.tpk or .tpkx). Use this in conjunction with a map or image service to generate and download tile packages.

Instances of this class represent a task that can be used to download tiles (as a tile package, .tpk or .tpkx file) from supporting tiled ArcGIS map or image services. The service could be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS server.

To confirm whether a map or image service supports exporting tiles, check:

• AGSArcGISMapServiceInfo::exportTilesAllowed property for the legacy compact format (.tpk)
• AGSArcGISMapServiceInfo::exportTileCacheCompactV2Allowed property for the compact version 2 format (.tpkx)

See AGSTileCache for information on creating a layer from a local tile cache.

When using Esri provided image basemaps (such as the World Imagery basemap, see AGSBasemapStyleArcGISImagery) an alternative service which supports exporting tiles may be used instead. For example, the World Imagery Service (https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer) will be exported using a corresponding export-enabled service (https://tiledbasemaps.arcgis.com/arcgis/rest/services/World_Imagery/MapServer).

Similarly, when using elevation data from ESRI (such as Terrain 3D), an alternative service that supports exporting tiles may be used instead. For example, the Terrain 3D will be exported using a corresponding export-enabled service. The resulting tile cache can then be used to create an offline AGSArcGISTiledElevationSource in a scene.

Note that these export-enabled services are not intended for use as an online basemap or elevation source, and should only be used for exporting tiles for offline use. The export-enabled services require authentication to export tiles.

See also

- initWithURL: (AGSExportTileCacheTask), AGSCacheStorageFormat

Since

100

Inheritance diagram for AGSExportTileCacheTask:

Instance Methods
(void)	- cancelLoad
(void)	- doCancelLoading
(void)	- doStartLoading:
(AGSEstimateTileCacheSizeJob *)	- estimateTileCacheSizeJobWithParameters:
(AGSExportTileCacheJob *)	- exportTileCacheJobWithParameters:downloadFileURL:
(id< AGSCancelable >)	- exportTileCacheParametersWithAreaOfInterest:minScale:maxScale:completion:
(instancetype)	- initWithURL:
(void)	- loadDidFinishWithError:
(void)	- loadWithCompletion:
(void)	- onLoadStatusChanged
(void)	- retryLoadWithCompletion:

Class Methods
(instancetype)	+ exportTileCacheTaskWithURL:

Properties
NSString *	APIKey
AGSCredential *	credential
NSError *	loadError
AGSLoadStatus	loadStatus
AGSArcGISMapServiceInfo *	mapServiceInfo
AGSRequestConfiguration *	requestConfiguration
NSURL *	URL

Method Documentation

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

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).

estimateTileCacheSizeJobWithParameters:

- (AGSEstimateTileCacheSizeJob*) estimateTileCacheSizeJobWithParameters:

(AGSExportTileCacheParameters *)

parameters

Returns a job which can be used to get a size estimate of the tile package contaning tiles specified by the parameters. The result of the job will be of type AGSEstimateTileCacheSizeResult.

Note

The job is dormant and needs to be explicitly started using startWithStatusHandler:completion: (AGSEstimateTileCacheSizeJob).

Parameters

parameters

A parameters object specifying which tiles to include in the tile package.

Returns

A job representing the progress on the server. The result of the job will be of type AGSEstimateTileCacheSizeResult.

Since

100

exportTileCacheJobWithParameters:downloadFileURL:

- (AGSExportTileCacheJob*) exportTileCacheJobWithParameters:		(AGSExportTileCacheParameters *)	parameters
downloadFileURL:		(NSURL *)	downloadFileURL

Returns a job which can be used to generate and download a tile package containing tiles specified by the parameters.

The resulting job will export tiles from the service, which is referenced by the AGSExportTileCacheTask::URL property (or its export-enabled alternative), to a local tile cache at the downloadFileURL parameter. The format of the tile cache is determined by the file extension supplied in the downloadFileURL parameter.

• If the downloadFileURL ends with ".tpk", the tile cache will use the legacy compact format
• If the downloadFileURL ends with ".tpkx", the tile cache will use the current compact version two format

If the service does not support exporting tiles, the job will fail with AGSErrorCodeMappingTileExportNotEnabled.

If a .tpkx format was requested, but the format is not supported by the service, the job will fail with AGSErrorCodeMappingTileCacheCompactV2ExportNotEnabled.

Note

The job is dormant and needs to be explicitly started using startWithStatusHandler:completion: (AGSExportTileCacheJob)

Parameters

parameters	A parameters object specifying which tiles to include in the tile package.
downloadFileURL	Downloaded tile cache file URL that ends with .tpk or .tpkx, depending on the desired format.

Returns

A job representing the progress on the server. The result of the job will be of type AGSTileCache.

Since

100

exportTileCacheParametersWithAreaOfInterest:minScale:maxScale:completion:

- (id<AGSCancelable>) exportTileCacheParametersWithAreaOfInterest:		(AGSGeometry *)	areaOfInterest
minScale:		(double)	minScale
maxScale:		(double)	maxScale
completion:		(void(^)(AGSExportTileCacheParameters *__nullable exportTileCacheParameters, NSError *__nullable error))	completion

A convenience method to get properly initialized parameters for exporting tiles. It will calculate the levels of detail (LODs) required based on the specified min and max scale and the tiling scheme of the service.

Parameters

areaOfInterest	A polygon or envelope geometry representing the geographic area for which tiles are needed. Point and polyline geometries are not supported.
minScale	The minimum map scale for which tiles are needed. There won't be any tiles when the map is zoomed out beyond this scale.
maxScale	The maximum map scale for which tiles are needed. There won't be any tiles when the map is zoomed in beyond this scale.
completion	A block that is invoked when the operation is complete with either the results or an error.

Returns

An operation which can be canceled.

Since

100

exportTileCacheTaskWithURL:

+ (instancetype) exportTileCacheTaskWithURL:

(NSURL *)

URL

Creates a task with a URL to a tiled ArcGIS map or image service

Parameters

URL	A URL to a tiled ArcGIS map or image service.

Returns

A new task.

Since

100

initWithURL:

- (instancetype) initWithURL:

(NSURL *)

URL

Creates a task with a URL to a tiled ArcGIS map or image service.

Parameters

URL	A URL to a tiled ArcGIS map or image service.

Since

100

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

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).

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:

1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
2. the server was down earlier when it failed and you want to retry
3. 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

Property Documentation

APIKey

- (NSString*) APIKey

readwriterequirednonatomiccopyinherited

The API key to access API key enabled services and resources in ArcGIS Online.

An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.

In addition to setting an API key at a global level for your application using the AGSArcGISRuntimeEnvironment::APIKey property, you can set an AGSAPIKeyResource::APIKey property on any ArcGIS Runtime class that implements AGSAPIKeyResource. When you set an individual AGSAPIKeyResource::APIKey property on an AGSAPIKeyResource it will override the default key at the global level (on the AGSArcGISRuntimeEnvironment::APIKey property, in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app. Classes that expose an API key property by implementing AGSAPIKeyResource include:

• AGSBasemap
• AGSArcGISSceneLayer
• AGSArcGISTiledLayer
• AGSArcGISVectorTiledLayer
• AGSServiceFeatureTable
• AGSExportVectorTilesTask
• AGSLocatorTask
• AGSGeodatabaseSyncTask
• AGSClosestFacilityTask
• AGSRouteTask
• AGSServiceAreaTask
• AGSExportTileCacheTask

  Since

  100.10

credential

- (AGSCredential*) credential

readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

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

mapServiceInfo

- (AGSArcGISMapServiceInfo*) mapServiceInfo

readnonatomicstrong

The task's AGSArcGISMapServiceInfo.

If created with a URL, this property will be populated after the task has been loaded. Before then, nil will be returned.

In the case of ESRI provided image basemaps or elevation sources, the meta-data will be for the export-enabled version of the service.

Since

100

requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration

readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since

100

URL

- (NSURL*) URL

readrequirednonatomicstronginherited

The URL of the remote resource.

Since

100