ArcGIS Developers
Dashboard

GeodatabaseSyncTaskUtility QML Type

A utility that contains methods to sync a sync-enabled mobile geodatabase. More...

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.3
Inherits:

Object

Properties

Signals

Methods

Detailed Description

Use this singleton type to access helper methods that can be used in conjunction with a GeodatabaseSyncTask.

Note: You cannot declare or create a component of this type in QML code. Rather, an instance is automatically created and only that single instance is available for use in the application.

See also Cancelable.

Property Documentation

exportDeltaStatus : Enums.TaskStatus

Returns the current status of the exportDelta() method (read-only).

See also Enums.TaskStatus.


importGeodatabaseDeltaResults : list<SyncLayerResult>

Returns the list of SyncLayerResult objects that are the result of importing a geodatabase delta (read-only).


importGeodatabaseDeltaStatus : Enums.TaskStatus

Returns the current status of the importGeodatabaseDelta method (read-only).

See also Enums.TaskStatus.


Signal Documentation

importGeodatabaseDeltaStatusChanged()

Emitted when the importGeodatabaseDeltaStatus property of this GeodatabaseSyncTaskUtility changes.

Note: The corresponding handler is onImportGeodatabaseDeltaStatusChanged.


Method Documentation

bool cancelTask(string taskId)

Cancel the task with the ID taskId.

Returns false if the task cannot be cancelled or there is no task with the specified id taskId.

See also Cancelable.


string exportDelta(Geodatabase geodatabase, string outputPath)

Generates 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/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:

The status for this task indicates whether or not a delta geodatabase was created.

Returns a string representing the task ID of the asynchronous task.

This method was introduced in Esri::ArcGISRuntime 100.10.

See also SyncGeodatabaseParameters::keepGeodatabaseDeltas.


string importGeodatabaseDelta(Geodatabase geodatabase, string pathToDeltaFile)

Starts a task to import a geodatabase delta and applies it to the given geodatabase.

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

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

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:

Returns the task ID for the new task.



Feedback on this topic?