ArcGIS Developers
Dashboard

OfflineMapSyncParameters Class

class Esri::ArcGISRuntime::OfflineMapSyncParameters

Parameters used for creating an OfflineMapSyncJob. More...

Header: #include <OfflineMapSyncParameters>
Since: Esri::ArcGISRuntime 100.1

This class was introduced in Esri::ArcGISRuntime 100.1.

Public Functions

OfflineMapSyncParameters(Esri::ArcGISRuntime::OfflineMapSyncParameters &&other)
OfflineMapSyncParameters(const Esri::ArcGISRuntime::OfflineMapSyncParameters &other)
OfflineMapSyncParameters()
Esri::ArcGISRuntime::OfflineMapSyncParameters &operator=(Esri::ArcGISRuntime::OfflineMapSyncParameters &&other)
Esri::ArcGISRuntime::OfflineMapSyncParameters &operator=(const Esri::ArcGISRuntime::OfflineMapSyncParameters &other)
~OfflineMapSyncParameters()
bool isKeepGeodatabaseDeltas() const
bool isRollbackOnFailure() const
Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption() const
void setKeepGeodatabaseDeltas(bool keepGeodatabaseDeltas)
void setPreplannedScheduledUpdatesOption(Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption)
void setRollbackOnFailure(bool rollbackOnFailure)
void setSyncDirection(Esri::ArcGISRuntime::SyncDirection syncDirection)
Esri::ArcGISRuntime::SyncDirection syncDirection() const

Detailed Description

Member Function Documentation

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

Move constructor from other OfflineMapSyncParameters.

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

Copy constructor from other OfflineMapSyncParameters.

OfflineMapSyncParameters::OfflineMapSyncParameters()

Default constructor.

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

Move operator from other OfflineMapSyncParameters.

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

Assignment operator from other OfflineMapSyncParameters.

OfflineMapSyncParameters::~OfflineMapSyncParameters()

Destructor.

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/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.

bool OfflineMapSyncParameters::isRollbackOnFailure() const

Returns whether geodatabase synchronization should roll back on a failure.

Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption OfflineMapSyncParameters::preplannedScheduledUpdatesOption() const

Returns 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 PreplannedScheduledUpdatesOption::DownloadAllUpdates.

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

The default value is PreplannedScheduledUpdatesOption::downloadAllUpdates.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setPreplannedScheduledUpdatesOption().

void OfflineMapSyncParameters::setKeepGeodatabaseDeltas(bool keepGeodatabaseDeltas)

Sets the keepGeodatabaseDeltas to keepGeodatabaseDeltas.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also isKeepGeodatabaseDeltas.

void OfflineMapSyncParameters::setPreplannedScheduledUpdatesOption(Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption)

Sets the preplannedScheduledUpdatesOption to preplannedScheduledUpdatesOption.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also preplannedScheduledUpdatesOption.

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().


Feedback on this topic?