OfflineMapSyncTask

A task with methods related to synchronizing an offline map's geodatabases with their originating services.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(map: ArcGISMap)

Creates an offline map sync task for synchronizing the geodatabases used by a map.

Properties

Link copied to clipboard

The map to be synchronized.

Link copied to clipboard

Describes the methods used for obtaining updates to the offline map that was used to create this task. You can use this property to determine whether an offline map is configured to use the update packages (see OfflineMapUpdateCapabilities.supportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities.supportsSyncWithFeatureServices). If the offline map was created using PreplannedUpdateMode.DownloadScheduledUpdatesAndUploadNewFeatures, it will support both update modes, but you will only be able to upload newly created features.

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

Link copied to clipboard

Returns a Result of OfflineMapUpdatesInfo for the offline map that was used to construct this task. The returned OfflineMapUpdatesInfo provides high level information on what updates are available for this offline map. Information is provided on:

Link copied to clipboard

Returns a Result of OfflineMapSyncParameters for the map that was used to construct this task. The parameters will be pre-populated with values appropriate for updating the feature data in this offline map.

Link copied to clipboard

Returns an offline map sync job. The resulting job will synchronize an offline map's geodatabases with their originating services.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.