OfflineMapSyncParameters Class

Member Function Documentation

OfflineMapSyncParameters::OfflineMapSyncParameters()

Default constructor.

OfflineMapSyncParameters::OfflineMapSyncParameters(const Esri::ArcGISRuntime::OfflineMapSyncParameters &other)

Copy constructor from other OfflineMapSyncParameters.

OfflineMapSyncParameters::OfflineMapSyncParameters(Esri::ArcGISRuntime::OfflineMapSyncParameters &&other)

Move constructor from other OfflineMapSyncParameters.

OfflineMapSyncParameters::~OfflineMapSyncParameters()

Destructor.

[since Esri::ArcGISRuntime 100.10] bool OfflineMapSyncParameters::isKeepGeodatabaseDeltas() const

Returns 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 https://developers.arcgis.com/rest/services-reference/enterprise/synchronize-replica.htm 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 SyncDirection::Upload or SyncDirection::Bidirectional. The download delta geodatabase will only be available when there are changes to download and the sync direction is SyncDirection::Download or SyncDirection::Bidirectional. The default value is false.

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

This function was introduced in Esri::ArcGISRuntime 100.10.

[since Esri::ArcGISRuntime 200.5] bool OfflineMapSyncParameters::isReconcileBranchVersion() const

Returns true if a geodatabase feature service replica branch version automatically reconciles with the default branch upon sync, false otherwise.

This property only applies to feature services that are branch versioned and have a true value for the SyncCapabilities::isSupportsBranchVersionReconcile property.

The default value is false.

This function was introduced in Esri::ArcGISRuntime 200.5.

bool OfflineMapSyncParameters::isRollbackOnFailure() const

Returns whether geodatabase synchronization should roll back on a failure.

[since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption OfflineMapSyncParameters::preplannedScheduledUpdatesOption() const

Returns whether update packages will be downloaded from an online map area and applied to the map's data.

If your map was taken offline with a DownloadPreplannedOfflineMapParameters::updateMode of PreplannedUpdateMode::downloadScheduledUpdates or PreplannedUpdateMode::downloadScheduledUpdatesAndUploadNewFeatures then you can set this property to PreplannedScheduledUpdatesOption::downloadAllUpdates to download and apply update packages to your offline geodatabases.

The default value is PreplannedScheduledUpdatesOption::downloadAllUpdates.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setPreplannedScheduledUpdatesOption().

[since Esri::ArcGISRuntime 100.10] void OfflineMapSyncParameters::setKeepGeodatabaseDeltas(bool keepGeodatabaseDeltas)

Sets the keepGeodatabaseDeltas to keepGeodatabaseDeltas.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also isKeepGeodatabaseDeltas.

[since Esri::ArcGISRuntime 100.6] void OfflineMapSyncParameters::setPreplannedScheduledUpdatesOption(Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption)

Sets the preplannedScheduledUpdatesOption to preplannedScheduledUpdatesOption.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also preplannedScheduledUpdatesOption.

[since Esri::ArcGISRuntime 200.5] void OfflineMapSyncParameters::setReconcileBranchVersion(bool reconcileBranchVersion)

Sets the reconcileBranchVersion to reconcileBranchVersion.

This function was introduced in Esri::ArcGISRuntime 200.5.

See also isReconcileBranchVersion.

void OfflineMapSyncParameters::setRollbackOnFailure(bool rollbackOnFailure)

Sets whether geodatabase synchronization should roll back on a failure to rollbackOnFailure.

See also isRollbackOnFailure().

void OfflineMapSyncParameters::setSyncDirection(Esri::ArcGISRuntime::SyncDirection syncDirection)

Sets the synchronization direction to syncDirection.

See also syncDirection().

Esri::ArcGISRuntime::SyncDirection OfflineMapSyncParameters::syncDirection() const

Returns the synchronization direction.

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 Esri::ArcGISRuntime::SyncDirection::Bidirectional

If you select Esri::ArcGISRuntime::SyncDirection::Upload, any download only geodatabases (e.g. with FeatureServiceCapabilities::isSupportsUpdate = false) will not be updated and you will receive an Error with an Error::errorType of {Esri::ArcGISRuntime::ErrorType} {ErrorType::MappingSyncDirectionUploadNotSupported} in the associated OfflineMapSyncResult::layerResults.

See also setSyncDirection().

Esri::ArcGISRuntime::OfflineMapSyncParameters &OfflineMapSyncParameters::operator=(const Esri::ArcGISRuntime::OfflineMapSyncParameters &other)

Assignment operator from other OfflineMapSyncParameters.

Esri::ArcGISRuntime::OfflineMapSyncParameters &OfflineMapSyncParameters::operator=(Esri::ArcGISRuntime::OfflineMapSyncParameters &&other)

Move operator from other OfflineMapSyncParameters.