Obsolete Members for GeodatabaseSyncTask

GeodatabaseSyncTask

The following members of class GeodatabaseSyncTask are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

Signals

Static Public Members

Member Function Documentation

Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::createDefaultGenerateGeodatabaseParameters(const Esri::ArcGISRuntime::Geometry &extent)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to get properly initialized parameters for generating a geodatabase based on the specified extent.

This convenience method populates a GenerateGeodatabaseParameters object with values based on defaults and on what the service supports. The GenerateGeodatabaseParameters is returned to the app through the signal defaultGenerateGeodatabaseParametersCompleted.

• If the service does not support SyncModel::Layer then SyncModel::Geodatabase will be used.
  • All layers from the service will be included.
  • The extent will be the service's full extent.
• Features inside the provided extent are included in the generated geodatabase.
• Output features are in the spatial reference of the given extent.
• Attachments are included.
• Related tables and layers are not included.

Returns a TaskWatcher for the operation. The operation can be canceled.

Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::createDefaultSyncGeodatabaseParameters(Esri::ArcGISRuntime::Geodatabase *geodatabase)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to get properly initialized parameters for syncing a geodatabase with its service.

• geodatabase - The geodatabase that will be synced.

This convenience method will populate the parameters with values matching what the service and the geodatabase support.

• For a geodatabase using SyncModel::Layer, all layers will be included.
• For a read-only service, the sync direction will be SyncDirection::Download. Otherwise, the sync direction will be SyncDirection::Bidirectional.

[since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::createDefaultSyncGeodatabaseParameters(Esri::ArcGISRuntime::Geodatabase *geodatabase, Esri::ArcGISRuntime::SyncDirection syncDirection)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to get properly initialized parameters for syncing a geodatabase with its service using the specified sync direction.

• geodatabase - The geodatabase that will be synced.
• syncDirection - The preferred sync direction.

This convenience method will populate the parameters with values matching what the service and the geodatabase support.

• For a geodatabase using SyncModel::Layer, all layers will be included.
• For a read-only service, the sync direction will be SyncDirection::Download. Otherwise, the sync direction will be set based on the syncDirection parameter.

This function was introduced in Esri::ArcGISRuntime 100.3.

[signal] void GeodatabaseSyncTask::defaultGenerateGeodatabaseParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::GenerateGeodatabaseParameters &defaultGenerateParameters)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that generates the default GenerateGeodatabaseParameters.

• taskId - The ID of the completed task.
• defaultGenerateParameters - The generated parameters.

See also createDefaultGenerateGeodatabaseParameters().

[signal] void GeodatabaseSyncTask::defaultSyncGeodatabaseParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::SyncGeodatabaseParameters &defaultSyncParameters)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that generates the default SyncGeodatabaseParameters.

• taskId - The ID of the completed task.
• defaultSyncParameters - The generated parameters.

See also createDefaultSyncGeodatabaseParameters().

[static, since Esri::ArcGISRuntime 100.10] Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::exportDelta(Esri::ArcGISRuntime::Geodatabase *geodatabase, const QString &outputPath)

This function is deprecated. We strongly advise against using it in new code.

Returns an upload delta geodatabase file containing all the changes since the last sync.

• geodatabase - The geodatabase to generate a delta from.
• outputPath - The path and filename to save the generated delta to.

A delta geodatabase contains the changes that have occurred since a mobile replica Geodatabase was last synchronized with the feature service. See https://developers.arcgis.com/rest/services-reference/enterprise/synchronize-replica.htm for an overview of the delta files used in synchronization. An "upload" delta geodatabase contains the local edits, performed on the user's device, to be sent to the originating feature service.

When you run this task, any local edits in the Geodatabase will be exported to the specified output path. The output path should include the full path and file name (ending in ".geodatabase") for the export.

The delta file created by this method is not sent to the server and has no impact on any subsequent sync job. You can call this method repeatedly without affecting the state of the local geodatabase.

You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local Geodatabase:

• exportDelta
• importDelta
• SyncGeodatabaseJob
• OfflineMapSyncJob.

The task returned by this method has a Boolean result that indicates whether or not a delta geodatabase was created.

Returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also SyncGeodatabaseParameters::isKeepGeodatabaseDeltas.

[signal] void GeodatabaseSyncTask::exportDeltaCompleted(const QUuid &taskId, bool deltaFileCreated)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that imports a geodatabase delta.

• taskId - The ID of the completed task.
• deltaFileCreated - Whether a delta file was successfully exported.

See also exportDelta().

[static, since Esri.ArcGISRuntime 200.0] Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::importDelta(Esri::ArcGISRuntime::Geodatabase *geodatabase, const QString &pathToDeltaFile)

This function is deprecated. We strongly advise against using it in new code.

Imports a geodatabase delta and applies it to the given geodatabase.

• geodatabase - The mobile geodatabase to apply the import to.
• pathToDeltaFile - The path to delta file on the local file system to import the delta from.

A delta geodatabase contains the changes that have occurred since a mobile replica Geodatabase was last-synchronized with the feature service. See https://developers.arcgis.com/rest/services-reference/enterprise/synchronize-replica.htm for an overview of the delta files used in synchronization. A "download" delta geodatabase contains the online edits that will be imported to the local geodatabase.

You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local Geodatabase:

• exportDelta
• importDelta
• SyncGeodatabaseJob
• OfflineMapSyncJob.

Returns a TaskWatcher for the operation. The operation can be canceled.

auto importDeltaFuture = GeodatabaseSyncTask::importDeltaAsync(&geodatabase, deltaPath, &localParent).then(this, [&syncLayerResults](QList<SyncLayerResult*> results)
{
  syncLayerResults = results;
});
VERIFY(spyWaitForFuture(importDeltaFuture));

This function was introduced in Esri.ArcGISRuntime 200.0.

[signal, since Esri.ArcGISRuntime 200.0] void GeodatabaseSyncTask::importDeltaCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::SyncLayerResult *> &syncLayerResults)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that imports a geodatabase delta.

• taskId - The ID of the completed task.
• syncLayerResults - The list of SyncLayerResult objects per layer that indicate the results of importing this delta.

The returned SyncLayerResult objects have the GeodatabaseSyncTask as their parent.

This function was introduced in Esri.ArcGISRuntime 200.0.

See also Returned QObjects Parenting and importDelta().

[static] Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::importGeodatabaseDelta(Esri::ArcGISRuntime::Geodatabase *geodatabase, const QString &pathToDeltaFile)

This function is deprecated. We strongly advise against using it in new code.

Imports a geodatabase delta and applies it to the given geodatabase.

• geodatabase - The mobile geodatabase to apply the import to.
• pathToDeltaFile - The path to delta file on the local file system to import the delta from.

A delta geodatabase contains the changes that have occurred since a mobile replica Geodatabase was last-synchronized with the feature service. See https://developers.arcgis.com/rest/services-reference/enterprise/synchronize-replica.htm for an overview of the delta files used in synchronization. A "download" delta geodatabase contains the online edits that will be imported to the local geodatabase.

You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local Geodatabase:

• exportDelta
• importGeodatabaseDelta
• SyncGeodatabaseJob
• OfflineMapSyncJob.

Returns a TaskWatcher for the operation. The operation can be canceled.

This is deprecated at 200.0. Use Esri::ArcGISRuntime::GeodatabaseSyncTask::importDeltaAsync instead

[signal] void GeodatabaseSyncTask::importGeodatabaseDeltaCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::SyncLayerResult *> &syncLayerResults)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that imports a geodatabase delta.

• taskId - The ID of the completed task.
• syncLayerResults - The list of SyncLayerResult objects per layer that indicate the results of importing this delta.

The returned SyncLayerResult objects have the GeodatabaseSyncTask as their parent.

This is deprecated at 200.0. Use importDeltaCompleted(const QUuid& taskId, const QList<Esri::ArcGISRuntime::SyncLayerResult*>& syncLayerResults) instead

See also Returned QObjects Parenting and importGeodatabaseDelta().

Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::registerSyncEnabledGeodatabase(Esri::ArcGISRuntime::Geodatabase *geodatabase)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to register a copy of a sync enabled geodatabase with a service so the copy can sync to the service.

The local geodatabase file is typically a copy of another original geodatabase file. The original geodatabase must already be known to the service and have a replica ID. A successful register will give the local geodatabase its own replica ID and separate it from the original. It can then be synchronized with the service to receive updates. After taking copies of the original database, do not sync changes to the original until all copies have been registered. This operation is not related to GeodatabaseSyncTask::unregisterGeodatabase which removes the geodatabase from the service.

[signal] void GeodatabaseSyncTask::registerSyncEnabledGeodatabaseCompleted(const QUuid &taskId)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that registers the mobile geodatabase.

• taskId - The ID of the completed task.

See also registerSyncEnabledGeodatabase.

Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::unregisterGeodatabase(Esri::ArcGISRuntime::Geodatabase *geodatabase)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to unregister an existing sync-enabled mobile geodatabase from the service.

• geodatabase - The mobile geodatabase to unregister.

This removes the geodatabase's replica ID from the service, which means the geodatabase can no longer be synchronized with the service. The local geodatabase is not deleted and remains on the local file system.

Returns a TaskWatcher for the operation. The operation can be canceled.

[since Esri::ArcGISRuntime 100.2] Esri::ArcGISRuntime::TaskWatcher GeodatabaseSyncTask::unregisterGeodatabase(const QUuid &syncId)

This function is deprecated. We strongly advise against using it in new code.

Starts a task to unregister an existing sync-enabled mobile geodatabase from the service.

• syncId - The sync ID of the geodatabase - obtained from Geodatabase::syncId.

This removes the geodatabase's replica ID from the service, which means the geodatabase can no longer be synchronized with the service. The local geodatabase remains on the local file system.

Returns a TaskWatcher for the operation. The operation can be canceled.

This function was introduced in Esri::ArcGISRuntime 100.2.

[signal] void GeodatabaseSyncTask::unregisterGeodatabaseCompleted(const QUuid &taskId)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when the task completes that unregisters the mobile geodatabase.

• taskId - The ID of the completed task.

See also unregisterGeodatabase.