ArcGIS Developers

OfflineMapSyncParameters QML Type

Parameters used for creating an OfflineMapSyncJob. More...

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




Detailed Description

Property Documentation

keepGeodatabaseDeltas : bool

Indicates whether or not the upload or downloaded delta geodatabases should be removed at the end of the sync job.

A delta geodatabase is a file that contains the changes that have occurred since a mobile replica Geodatabase was last synchronized with its feature service. See for an overview of the delta files used in synchronization. There are two types of delta geodatabase:

  • Local edits, performed on the user's device, are exported as an "upload" delta delta that is applied to the originating feature service.
  • Online edits, performed by other users are requested as a "download" delta which is then applied to the local replica geodatabase.

Delta geodatabases allow you to troubleshoot sync problems. For example, you can inspect the geodatabase changes or you could send the file to the administrator of the feature service.

You can choose to retain both the uploaded and downloaded delta geodatabases once the sync job has completed. Set to true to retain both delta geodatabases and set to false to have them deleted at the end of the sync job. Deltas will be retained regardless of whether the job succeeds or fails. Note that when this property is set to true, the upload delta geodatabase will only be available if there are changes to upload and the sync direction is Enums.SyncDirectionUpload or Enums.SyncDirectionBidirectional. The download delta geodatabase will only be available when there are changes to download and the sync direction is Enums.SyncDirectionDownload or Enums.SyncDirectionBidirectional. The default value is false.

No geodatabase deltas will be retained if your geodatabase uses a scheduled updates workflow.

This property was introduced in Esri.ArcGISRuntime 100.10.

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 keepGeodatabaseDeltas property changes.

Note: The corresponding handler is onKeepGeodatabaseDeltasChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.


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?