Show / Hide Table of Contents

Class GenerateOfflineMapJob

A job that generates and downloads the offline map for a specific area of interest from a web map that is enabled for offline use.

Inheritance
System.Object
Job<GenerateOfflineMapResult>
GenerateOfflineMapJob
Job<GenerateOfflineMapResult>.Messages
Job<GenerateOfflineMapResult>.Error
Job<GenerateOfflineMapResult>.GetResultAsync()
Job<GenerateOfflineMapResult>.ServerJobId
Job<GenerateOfflineMapResult>.Status
Job<GenerateOfflineMapResult>.Progress
Job<GenerateOfflineMapResult>.CancelAsync()
Job<GenerateOfflineMapResult>.Pause()
Job<GenerateOfflineMapResult>.Start()
Job<GenerateOfflineMapResult>.ToJson()
Job<GenerateOfflineMapResult>.CheckStatusAsync()
Job<GenerateOfflineMapResult>.ProgressChanged
Job<GenerateOfflineMapResult>.MessageAdded
Job<GenerateOfflineMapResult>.StatusChanged
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 GenerateOfflineMapJob : Job<GenerateOfflineMapResult>
Remarks

This job is part of the on-demand offline workflow. Use this job to generate and download the offline map to your device so that you can work offline without a network connection.

To make a GenerateOfflineMapJob, 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).
  • Create a Geometry to define the area of interest that you wish to take offline.
  • Obtain the default GenerateOfflineMapParameters for the area of interest by calling CreateDefaultGenerateOfflineMapParametersAsync(Geometry).
  • Use the GenerateOfflineMapParameters to create a GenerateOfflineMapJob by calling GenerateOfflineMap(GenerateOfflineMapParameters, String). You must specify a path to a folder where the map content will be stored on the device.

Start the GenerateOfflineMapJob and monitor progress. Upon completion, the job's GenerateOfflineMapResult provides the offline map along with the details of any errors incurred during the generate and download process.

See the Job<T> class for full information on how to work with jobs.

Properties

Name Description
DownloadDirectoryPath

Gets the download directory used by this job to write the mobile map package result.

OnlineMap

Gets the online Map used by this job.

ParameterOverrides

Gets the GenerateOfflineMapParameterOverrides used by this job.

Parameters

Gets the GenerateOfflineMapParameters used by this job.

Methods

Name Description
FromJson(String)

Creates a job from JSON.

Applies to

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