arcgis-maps-kotlin/com.arcgismaps.tasks.offlinemaptask/GenerateOfflineMapJob

GenerateOfflineMapJob

class GenerateOfflineMapJob : Job<GenerateOfflineMapResult>

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. 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 OfflineMapTask.getOfflineMapCapabilities.
Create a com.arcgismaps.geometry.Geometry to define the area of interest that you wish to take offline.
Obtain the default GenerateOfflineMapParameters for the area of interest by calling OfflineMapTask.createDefaultGenerateOfflineMapParameters.
Use the GenerateOfflineMapParameters to create a GenerateOfflineMapJob by calling OfflineMapTask.generateOfflineMap. 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 com.arcgismaps.tasks.Job class for full information on how to work with jobs.

Since

200.1.0

Types

Companion

object Companion

Properties

downloadDirectoryPath

val downloadDirectoryPath: String

The download directory used by this job to write the mobile map package result. This property holds the path for the mobile map package which will be generated as a result of running this job.

onlineMap

val onlineMap: ArcGISMap?

The online map used by this job.

parameterOverrides

val parameterOverrides: GenerateOfflineMapParameterOverrides?

The parameter overrides used by this job. Can be null.

parameters

val parameters: GenerateOfflineMapParameters

The parameters used by this job.

Inherited properties

messages

open override val messages: SharedFlow<JobMessage>

The job's messages. Indicates that a new JobMessage was generated.

progress

open override val progress: StateFlow<Int>

The current progress of the job as a percentage complete. This emits updates when the progress value changes.

serverJobId

open override val serverJobId: String

The server job Id of the job.

status

open override val status: StateFlow<JobStatus>

The status of the job.

Inherited functions

cancel

open suspend override fun cancel(): Result<Boolean>

Cancels this Job and waits for any asynchronous, server-side operations to be canceled. The job is canceled and will result in a JobStatus.Failed status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated Job.serverJobId. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:

checkStatus

open suspend override fun checkStatus(): Result<Boolean>

Initiates a request to check the server status. If the job is polling the server for status and is in a time gap, then calling this method will ensure a request is sent right away. The result can be false if the job is not checking server status for example if the job status is paused or uploading.

pause

open override fun pause(): Boolean

Pauses the job.

result

open suspend override fun result(): Result<GenerateOfflineMapResult>

Suspends until this job has completed. Calling this function does not start the job. In order to start the job call start

start

open override fun start(): Boolean

Starts executing the job if the job is not started or paused.

toJson

open override fun toJson(): String

Convert an object to JSON string.