Click or drag to resize

OfflineMapTaskDownloadPreplannedOfflineMap Method (PreplannedMapArea, String)

Note: This API is now obsolete.

Returns a job that is used to download the specified preplanned map area of an online map.

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
)

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.

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.

This method does not support the scheduled updates workflow and will default to use SyncWithFeatureServices. An instance of DownloadPreplannedOfflineMapParameters can be created and populated as required. Alternatively, the recommended workflow is to use CreateDefaultDownloadPreplannedOfflineMapParametersAsync(PreplannedMapArea) and then make any adjustments. This will determine if scheduled updates are present and update the property UpdateMode appropriately.

See Also