Skip To Content ArcGIS for Developers Sign In Dashboard

OfflineMapSyncParameters QML Type

Parameters used for creating an OfflineMapSyncJob. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.1




Detailed Description

Property Documentation

preplannedScheduledUpdatesOption : Enums.PreplannedScheduledUpdatesOption

Whether scheduled updates will be downloaded from an online map area and applied to the map's data.

If the mobile geodatabases in your offline map were not registered for sync you can choose to download and apply those updates by setting this property to Enums.PreplannedScheduledUpdatesOptionDownloadAllUpdates.

You specify whether an offline map will make use of scheduled updates by setting the DownloadPreplannedOfflineMapParameters::updateMode property before downloading.

The default value is Enums.PreplannedScheduledUpdatesOptionDownloadAllUpdates.

This property was introduced in Esri.ArcGISRuntime 100.6.

See also Enums.PreplannedScheduledUpdatesOption.

rollbackOnFailure : bool

Whether geodatabase synchronization should roll back on a failure.

syncDirection : Enums.SyncDirection

The synchronization direction for geodatabases registered with feature services.

This property applies to any geodatabases that are registered for feature service synchronization. It does not apply to geodatabases which use scheduled updates.

The default value is Enums.SyncDirectionBidirectional

If you select Enums.SyncDirectionUpload, any download only geodatabases (e.g. with FeatureServiceCapabilities::supportsUpdate = false) will not be updated and you will receive an Error with an Error::code of 7023 in the associated OfflineMapSyncResult::layerResults.

See also Enums.SyncDirection.

Signal Documentation


Emitted when the preplannedScheduledUpdatesOption property changes.

Note: The corresponding handler is onPreplannedScheduledUpdatesOptionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


Emitted when the rollbackOnFailure property changes.

Note: The corresponding handler is onRollbackOnFailureChanged.


Emitted when the syncDirection property changes.

Note: The corresponding handler is onSyncDirectionChanged.

Feedback on this topic?