Class OfflineMapTask

A task used to take a map offline.

Inheritance

object

OfflineMapTask

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Esri.ArcGISRuntime.Tasks.Offline

Assembly: Esri.ArcGISRuntime.dll

Syntax

public sealed class OfflineMapTask

Remarks

Taking a map offline involves downloading an online map and its data, including all the supported layers, tables, renderers, web map configuration etc. so that it can be used offline without a network connection. There are two workflows available for taking maps offline:

• The ahead-of-time workflow (also sometimes referred to as the preplanned workflow).
• The on-demand workflow.

Ahead-of-time workflow. In this workflow the author of a web map defines geographical areas (offline map areas) to take offline.ArcGIS Online, or ArcGIS Enterprise, uses these to prepare offline map content that is stored online. Download the offline map content to a device using the DownloadPreplannedOfflineMapJob. Note that this API refers to an offline map area as a PreplannedMapArea. For more information about authoring offline map areas, see Take web maps offline.

On-demand workflow. Here the app passes a specific area of interest to a GenerateOfflineMapJob to generate and download the map content to the device. Using this workflow, you can choose to keep online only services (e.g. those that require a network connection) in your offline map. Be aware that an offline map which uses online only services will require a network connection and may require authentication.

Properties

Name	Description
OnlineMap	Gets the online Map to be taken offline.
PortalItem	Gets the PortalItem specifying the map to be take offline.

Methods

Name	Description
CreateAsync(Map)	Initializes a new instance of the OfflineMapTask class for the provided online map.
CreateAsync(PortalItem)	Initializes a new instance of the OfflineMapTask class from the specified PortalItem. The portal item must represent a webmap.
CreateDefaultDownloadPreplannedOfflineMapParametersAsync(PreplannedMapArea)	Generates default DownloadPreplannedOfflineMapParameters that are specific to the PreplannedMapArea.
CreateDefaultGenerateOfflineMapParametersAsync(Geometry)	Generates default GenerateOfflineMapParameters that are specific to the specified area of interest.
CreateDefaultGenerateOfflineMapParametersAsync(Geometry, double, double)	Generates GenerateOfflineMapParameters from the specified area of interest, min scale, and max scale.
CreateGenerateOfflineMapParameterOverridesAsync(GenerateOfflineMapParameters)	GenerateOfflineMapParameterOverrides created from the specified GenerateOfflineMapParameters parameters.
DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, string)	Returns a job that is used to download the PreplannedMapArea specified by the given parameters object.
GenerateOfflineMap(GenerateOfflineMapParameters, string)	Returns a job that is used to generate an offline map using the specified parameters.
GenerateOfflineMap(GenerateOfflineMapParameters, string, GenerateOfflineMapParameterOverrides)	Returns a job that is used to generate an offline map using the specified parameters and overrides.
GetOfflineMapCapabilitiesAsync(GenerateOfflineMapParameters)	Obtains information on which layers will be included in an offline map.
GetPreplannedMapAreasAsync()	Obtains a list of preplanned map areas, if there are any.

Applies to

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.0 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.1 - 200.8
Xamarin.Android	100.1 - 100.15
Xamarin.iOS	100.1 - 100.15
UWP	100.1 - 200.8