A task to synchronize an offline map's geodatabases with its originating sync-enabled ArcGIS feature services. You can take a map offline from a web map using the OfflineMapTask. This can be an offline map created ahead-of-time or an on-demand map. For more information, see the Ahead-of-time vs on-demand[] workflows. The offline map is stored on the device so its data can be displayed, queried, and edited whilst the device is offline.

You can update the data content by synchronizing the offline map with its source web map. Edits to offline feature data can be posted to the source web map, and any edits to the source web map's feature data content can be downloaded and applied to the offline map. This brings the source web map content and the offline map content into alignment. Edits to features, non-spatial data, related data, and attachments can be synchronized. A network connection must be present for synchronization. Here are typical steps to synchronize data between the offline map and its source web map:

If there are attribute or geometry level conflicts on a feature during synchronization, the most recently synchronized edit will be applied. For example, if both user A and user B edit the same feature while offline, if user A synchronizes their edits first, then user B synchronizes their edits, the updated feature will represent the edits made by user B.

Synchronization errors typically occur because of network connectivity issues during the sync process. The synchronization mechanism is robust to these types of errors, however, and they can be resolved by synchronizing again when a reliable network connection becomes available.

If you created the offline map using the ahead-of-time workflow, it may support a synchronization workflow known as update packages. Update packages optimize updating the data contents of a downloaded offline map to the latest contents of the source web map. For more information, see

If you want to download and synchronize individual feature services to a single offline geodatabase, instead of taking a map offline, then you can use the GeodatabaseSyncTask.




Link copied to clipboard
constructor(map: ArcGISMap)

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


Link copied to clipboard

The map to be synchronized.

Link copied to clipboard

Describes the methods that can be used to obtain updates to the offline map. 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.


Link copied to clipboard

Retrieves 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

This populates the parameters with values appropriate for synchronizing the feature data in this offline map. The default parameters will reflect the mobile geodatabases used by the offline map.

Link copied to clipboard

Returns a job to synchronize an offline map's geodatabases with their originating services. You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local Geodatabase:

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.