arcgis-maps-kotlin/com.arcgismaps.tasks.geodatabase/GenerateGeodatabaseJob

GenerateGeodatabaseJob

class GenerateGeodatabaseJob : Job<Geodatabase>

The GenerateGeodatabaseJob requests that a sync-enabled ArcGIS feature service generates a geodatabase file and downloads it for offline use. To make a GenerateGeodatabaseJob, use the GeodatabaseSyncTask as follows:

Construct and load the GeodatabaseSyncTask with a URL to a sync-enabled ArcGIS feature service.
Create a com.arcgismaps.geometry.Geometry to define the area of interest that you wish to take offline.
Obtain the default GenerateGeodatabaseParameters for the area of interest by calling GeodatabaseSyncTask.createDefaultGenerateGeodatabaseParameters.
Modify the GenerateGeodatabaseParameters as required.
Use the GenerateGeodatabaseParameters to create a GenerateGeodatabaseJob by calling GeodatabaseSyncTask.createGenerateGeodatabaseJob. You must specify a path where the mobile geodatabase (.geodatabase file) is downloaded to.

Start the GenerateGeodatabaseJob and monitor progress. On completion, obtain the com.arcgismaps.data.Geodatabase from the GenerateGeodatabaseJob.result.

Since

200.1.0

Types

Companion

object Companion

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