Skip To Content ArcGIS for Developers Sign In 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 isRollbackOnFailure() const
Esri::ArcGISRuntime::PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption() const
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::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::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 a Error::code of 7023 in the associated OfflineMapSyncResult::layerResults.

See also setSyncDirection().


Feedback on this topic?