Show / Hide Table of Contents

Class ExportTileCacheTask

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.

Inheritance
System.Object
ExportTileCacheTask
Implements
IApiKeyResource
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Esri.ArcGISRuntime.Tasks.Offline
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ExportTileCacheTask : IApiKeyResource
Remarks

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

  • ExportTilesAllowed property for the legacy compact format (.tpk).
  • ExportTileCacheCompactV2Allowed property for the compact version 2 format (.tpkx).

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

When using Esri provided image basemaps (such as the World Imagery basemap, ArcGISImagery) an alternative service which supports exporting tiles may be used instead. For example, the World Imagery Service () will be exported using a corresponding export-enabled service ().

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

Properties

Name Description
ApiKey

Gets or sets the API key that allows your app to access ArcGIS location services and private portal items.

ServiceInfo

Gets the ArcGISMapServiceInfo object associated with this task.

Uri

Gets the map service Uri associated with this task.

Methods

Name Description
CreateAsync(Uri)

Creates an export tile cache task from a map or image service URI.

CreateAsync(Uri, String)

Creates an export tile cache task from a map or image service URI.

CreateDefaultExportTileCacheParametersAsync(Geometry, Double, Double)

Creates and returns new ExportTileCacheParameters instance.

EstimateTileCacheSize(ExportTileCacheParameters)

Starts and returns a new estimate tile cache size job.

ExportTileCache(ExportTileCacheParameters, String)

Start and return a new export tile cache job.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.0 - 200.7
Xamarin.Android100.0 - 100.15
Xamarin.iOS100.0 - 100.15
UWP100.0 - 200.7

Relevant samples

Export tiles: Download tiles to a local tile cache file stored on the device.
In This Article
Back to top Copyright © 2022 Esri.