Skip To Content ArcGIS for Developers Sign In Dashboard

SyncGeodatabaseParameters Class

(Esri::ArcGISRuntime::SyncGeodatabaseParameters)

The parameters to sync data of a sync-enabled geodatabase. More...

Header: #include <SyncGeodatabaseParameters>
Since: Esri::ArcGISRuntime 100.0

Public Functions

SyncGeodatabaseParameters()
SyncGeodatabaseParameters(const SyncGeodatabaseParameters &other)
SyncGeodatabaseParameters(SyncGeodatabaseParameters &&other)
~SyncGeodatabaseParameters()
SyncDirection geodatabaseSyncDirection() const
bool isEmpty() const
bool isRollbackOnFailure() const
QList<SyncLayerOption> layerOptions() const
void setGeodatabaseSyncDirection(SyncDirection syncDirection)
void setLayerOptions(const QList<SyncLayerOption> &syncLayerOptions)
void setRollbackOnFailure(bool rollbackOnFailure)
SyncGeodatabaseParameters &operator=(const SyncGeodatabaseParameters &other)
SyncGeodatabaseParameters &operator=(SyncGeodatabaseParameters &&other)

Detailed Description

The parameters to sync data of a sync-enabled geodatabase.

SyncGeodatabaseParameters is used with GeodatabaseSyncTask::syncGeodatabase to sync the data of a sync-enabled geodatabase with its originating ArcGIS Feature services.

Note: Rather than constructing one of these directly, consider using the convenience method GeodatabaseSyncTask::GeodatabaseSyncTask::createDefaultSyncGeodatabaseParameters. It will create a SyncGeodatabaseParameters object initialized with appropriate parameters based on the supported capabilities and geodatabase configuration of the ArcGIS Feature Service.

See GeodatabaseSyncTask for details about how to sync the geodatabase. See Geodatabase for details about edit and query operations supported by the geodatabase.

Member Function Documentation

SyncGeodatabaseParameters::SyncGeodatabaseParameters()

Default constructor.

SyncGeodatabaseParameters::SyncGeodatabaseParameters(const SyncGeodatabaseParameters &other)

Copy constructor from other SyncGeodatabaseParameters.

SyncGeodatabaseParameters::SyncGeodatabaseParameters(SyncGeodatabaseParameters &&other)

Move constructor from other SyncGeodatabaseParameters.

SyncGeodatabaseParameters::~SyncGeodatabaseParameters()

Destructor.

SyncDirection SyncGeodatabaseParameters::geodatabaseSyncDirection() const

Returns the direction in which the entire geodatabase must sync changes with the service.

The default value is SyncDirection::None if SyncGeodatabaseParameters is empty or SyncDirection::Bidirectional if it is not empty.

See also setGeodatabaseSyncDirection().

bool SyncGeodatabaseParameters::isEmpty() const

Returns whether this SyncGeodatabaseParameters is empty.

If the SyncGeodatabaseParameters is empty, it is not possible to change any of the properties.

bool SyncGeodatabaseParameters::isRollbackOnFailure() const

Returns whether all edits are rolled back if a failure occurs while importing edits from the geodatabase onto the server.

The default value is false.

QList<SyncLayerOption> SyncGeodatabaseParameters::layerOptions() const

Returns the options specifying the direction in which individual layers in the geodatabase must sync changes with the service.

The default value is an empty list of SyncLayerOption.

See also setLayerOptions().

void SyncGeodatabaseParameters::setGeodatabaseSyncDirection(SyncDirection syncDirection)

Sets the direction in which the entire geodatabase must sync changes with the service.

  • syncDirection - The direction to sync.

This property only applies if the geodatabase uses a sync model of SyncModel::Geodatabase. Otherwise, use the layerOptions property.

The default value is SyncDirection::None if SyncGeodatabaseParameters is empty or SyncDirection::Bidirectional if it is not empty.

See also geodatabaseSyncDirection().

void SyncGeodatabaseParameters::setLayerOptions(const QList<SyncLayerOption> &syncLayerOptions)

Sets the options specifying the direction in which individual layers in the geodatabase must sync changes with the service.

  • syncLayerOptions - The list of sync options for individual layers.

Not all layers need to be included in the sync operation. Some of them can be excluded by leaving them out of this list. This property only applies if the geodatabase uses a sync model of SyncModel::Layer. Otherwise, use the geodatabaseSyncDirection property.

The default value is an empty list of SyncLayerOption.

See also layerOptions().

void SyncGeodatabaseParameters::setRollbackOnFailure(bool rollbackOnFailure)

Sets whether all edits are rolled back if a failure occurs while importing edits from the geodatabase onto the server.

  • rollbackOnFailure - Whether to roll back edits when a failure occurs.

If rollbackOnFailure is false, then failed edits are skipped. Other edits are still applied.

Note: This property only applies to edits uploaded by the client to the server. It does not apply to edits imported by client from the server.

The default value is false.

See also isRollbackOnFailure().

SyncGeodatabaseParameters &SyncGeodatabaseParameters::operator=(const SyncGeodatabaseParameters &other)

Assignment operator from other SyncGeodatabaseParameters.

SyncGeodatabaseParameters &SyncGeodatabaseParameters::operator=(SyncGeodatabaseParameters &&other)

Move operator from other SyncGeodatabaseParameters.


Feedback on this topic?