Class DownloadPreplannedOfflineMapJob
A job to download the map area from an online map as part of the preplanned offline workflow.
Namespace: Esri.ArcGISRuntime.Tasks.Offline
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class DownloadPreplannedOfflineMapJob : Job<DownloadPreplannedOfflineMapResult>Remarks
This job is part of the ahead-of-time offline workflow. Use this job to download the offline map to your device so that you can work offline without a network connection. Note that offline map areas may also be referred to as preplanned map areas.
To make a DownloadPreplannedOfflineMapJob, use the OfflineMapTask as follows:
- Construct and load the OfflineMapTask with a web map that is enabled for offline use. For more information about enabling web maps for offline use see Take web maps offline.
- If necessary, check the web map's offline capabilities by using GetOfflineMapCapabilitiesAsync(GenerateOfflineMapParameters).
- Select an offline map area from the collection of offline map areas returned by GetPreplannedMapAreasAsync().
- Obtain the default DownloadPreplannedOfflineMapParameters for the offline map area by calling CreateDefaultDownloadPreplannedOfflineMapParametersAsync(PreplannedMapArea).
- Adjust any parameters, as required.
- Use the DownloadPreplannedOfflineMapParameters to create a DownloadPreplannedOfflineMapJob by calling DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String). You must specify a path to a folder where the map content will be stored on the device.
Start the DownloadPreplannedOfflineMapJob and monitor progress. Upon completion, the job's DownloadPreplannedOfflineMapResult provides the offline map along with the details of any errors incurred during the download process.
See the Job<T> class for full information on how to work with jobs.
Properties
| Name | Description |
|---|---|
| DownloadDirectoryPath | Gets the directory path to the location of the mobile map package. |
| OnlineMap | Gets the online map used by this job. |
| Parameters | Gets the DownloadPreplannedOfflineMapParameters used to create this job. |
Methods
| Name | Description |
|---|---|
| FromJson(String) | Creates a job from JSON. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.7 |
| .NET | 100.13 - 200.7 |
| .NET Windows | 100.13 - 200.7 |
| .NET Android | 200.0 - 200.7 |
| .NET iOS | 200.0 - 200.7 |
| .NET Framework | 100.2.1 - 200.7 |
| Xamarin.Android | 100.2.1 - 100.15 |
| Xamarin.iOS | 100.2.1 - 100.15 |
| UWP | 100.2.1 - 200.7 |