Show / Hide Table of Contents

Method DownloadPreplannedOfflineMap

DownloadPreplannedOfflineMap(PreplannedMapArea, String, Boolean)

Returns a job that is used to download the specified preplanned map area of an online map but excludes the map's basemap.

Declaration
[Obsolete("Use DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, string)")]
public DownloadPreplannedOfflineMapJob DownloadPreplannedOfflineMap(PreplannedMapArea preplannedMapArea, string downloadDirectoryPath, bool excludeBasemap)
Parameters
Type Name Description
PreplannedMapArea preplannedMapArea

The PreplannedMapArea to be downloaded.

String downloadDirectoryPath

The path to a folder where the map content is stored on the device. For example, to create a new mobile map package "my_mobile_map_package" in a parent directory "[my root path]/my_mobile_maps", this property would be "[my root path]/my_mobile_maps/my_mobile_map_package".

Boolean excludeBasemap

A boolean indicating whether to exclude the basemap from the offline map.

Returns
Type Description
DownloadPreplannedOfflineMapJob

A DownloadPreplannedOfflineMapJob for downloading the preplanned map area.

Remarks

The job that is returned is dormant and needs to be explicitly started. The job will fail if the last directory in the downloadDirectoryPath cannot be created or is not empty. Specifying excludeBasemap: true will override the authored settings of the preplanned map area and always exclude the basemap content.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 100.14
.NET 6.0100.13 - 100.14
.NET 6.0 Windows100.13 - 100.14
.NET Framework100.2.1 - 100.14
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Xamarin.Android100.2.1 - 100.14
Xamarin.iOS100.2.1 - 100.14
UWP100.2.1 - 100.14

DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String)

Returns a job that is used to download the PreplannedMapArea specified by the given parameters object.

Declaration
public DownloadPreplannedOfflineMapJob DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters parameters, string downloadDirectoryPath)
Parameters
Type Name Description
DownloadPreplannedOfflineMapParameters parameters

Specifies parameters for the job including the PreplannedMapArea to be downloaded.

String downloadDirectoryPath

The path to a folder where the map content is stored on the device. For example, to create a new mobile map package "my_mobile_map_package" in a parent directory "[my root path]/my_mobile_maps", this property would be "[my root path]/my_mobile_maps/my_mobile_map_package".

Returns
Type Description
DownloadPreplannedOfflineMapJob

A DownloadPreplannedOfflineMapJob for downloading the preplanned map area.

Remarks

The job that is returned is dormant and needs to be explicitly started. The job will fail if the last directory in the download directory path cannot be created or is not empty.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.4 - 100.14
.NET 6.0100.13 - 100.14
.NET 6.0 Windows100.13 - 100.14
.NET Framework100.4 - 100.14
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Xamarin.Android100.4 - 100.14
Xamarin.iOS100.4 - 100.14
UWP100.4 - 100.14
In This Article
Back to top Copyright © 2021 Esri.