Show / Hide Table of Contents

Class DownloadPreplannedOfflineMapParameters

The parameters that specify how an offline map area is downloaded from an online map using a DownloadPreplannedOfflineMapJob.

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

The online map must be a web map either on ArcGIS Online or ArcGIS Enterprise. Note that the API refers to an offline map area as a PreplannedMapArea.

To generate default parameters that match the online map's offline settings, call CreateDefaultDownloadPreplannedOfflineMapParametersAsync(PreplannedMapArea). You can then modify the parameters with any desired changes. Alternatively, you can generate an empty set of parameters using DownloadPreplannedOfflineMapParameters() and set the parameters individually. To create a DownloadPreplannedOfflineMapJob, pass the parameters to the DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String) method and provide a path to a folder where the map content is stored on the device.

Constructors

Name Description
DownloadPreplannedOfflineMapParameters()

Initializes a new instance of the DownloadPreplannedOfflineMapParameters class.

DownloadPreplannedOfflineMapParameters(PreplannedMapArea)

Initializes a new instance of the DownloadPreplannedOfflineMapParameters class with the given PreplannedMapArea.

Properties

Name Description
ContinueOnErrors

Gets or sets a value indicating whether or not the DownloadPreplannedOfflineMapJob should continue running in the event of failure to take a layer offline.

IncludeBasemap

Gets or sets a value indicating whether or not a basemap will be included in the offline map.

PreplannedMapArea

Gets or sets the PreplannedMapArea that will be downloaded for offline use.

ReferenceBasemapDirectory

Gets or sets the path to a directory on the device where the local basemap file is located.

ReferenceBasemapFilename

Gets or sets the name of a local basemap file on the device which can be used rather than downloading an online basemap.

UpdateMode

Gets or sets a value that describes how the offline map will obtain feature updates from the online service.

See Also

DownloadPreplannedOfflineMapJob

Applies to

TargetVersions
.NET Standard 2.0100.4 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.4 - 200.7
Xamarin.Android100.4 - 100.15
Xamarin.iOS100.4 - 100.15
UWP100.4 - 200.7
In This Article
Back to top Copyright © 2022 Esri.