Click or drag to resize

OfflineMapTaskDownloadPreplannedOfflineMap Method (PreplannedMapArea, String, Boolean)

Note: This API is now obsolete.

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

Namespace:  Esri.ArcGISRuntime.Tasks.Offline
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
[ObsoleteAttribute("Use DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, string)")]
public DownloadPreplannedOfflineMapJob DownloadPreplannedOfflineMap(
	PreplannedMapArea preplannedMapArea,
	string downloadDirectoryPath,
	bool excludeBasemap
)

Parameters

preplannedMapArea
Type: Esri.ArcGISRuntime.Tasks.OfflinePreplannedMapArea
The PreplannedMapArea to be downloaded.
downloadDirectoryPath
Type: SystemString
The path to a folder where the map content is stored on the device.
excludeBasemap
Type: SystemBoolean
A boolean indicating whether to exclude the basemap from the offline map.

Return Value

Type: 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.
See Also