OfflineMapSyncTask QML Type

Returns the results of the checkForUpdates task, providing information about available updates for the map that was used to construct this task (read-only).

This property was introduced in Esri.ArcGISRuntime 100.6.

Returns a Enums.TaskStatus of the checkForUpdates task (read-only).

This property was introduced in Esri.ArcGISRuntime 100.6.

Returns the default parameters for syncing the map that was used to construct this task (read-only).

This property was introduced in Esri.ArcGISRuntime 100.6.

Returns a Enums.TaskStatus of the createDefaultOfflineMapSyncParameters task (read-only).

This property was introduced in Esri.ArcGISRuntime 100.6.

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.

The offline map to synchronize.

Describes the methods used for obtaining updates to the offline map that was used to create this task (read-only).

You can use this property to determine whether an offline map is configured to use update packages (see OfflineMapUpdateCapabilities::supportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities::supportsSyncWithFeatureServices). If the offline map was created using Enums.PreplannedUpdateModeDownloadScheduledUpdatesAndUploadNewFeatures, it will support both update modes, but you will only be able to upload newly created features.

This property will return null until the offline map sync task is loaded.

This property was introduced in Esri.ArcGISRuntime 100.6.

This inherited property is unused with OfflineMapSyncTask.

Emitted when the checkForUpdatesStatus property changes.

Note: The corresponding handler is onCheckForUpdatesStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the createDefaultOfflineMapSyncParametersStatus property changes.

Note: The corresponding handler is onCreateDefaultOfflineMapSyncParametersStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the loadError property changes.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.

Emitted when the map property changes.

Note: The corresponding handler is onMapChanged.

Emitted when the updateCapabilities property changes.

Note: The corresponding handler is onUpdateCapabilitiesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.

See also Loadable.

Cancel the task with the ID taskId.

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

This method was introduced in Esri.ArcGISRuntime 100.6.

See also Cancelable.

Gets OfflineMapUpdatesInfo for the map that was used to create this task.

This method returns a string representing the task ID of the task.

Uses an asynchronous task to get the updates information, which is returned in the checkForUpdatesResult property when the task completes. Wait for the checkForUpdatesStatusChanged signal to emit and the checkForUpdatesStatus to be Enums.TaskStatusCompleted before retrieving the result.

The returned OfflineMapUpdatesInfo provides high level information on what updates are available for this offline map. Information is provided on:

• Online changes which that be applied to update your offline map.
• Local changes from your offline map that can be sent back to the online services.

Calling this method before calling syncOfflineMap provides high-level information on available updates before starting a potentially time-consuming offline map sync process. It can help you to determine whether you should call syncOfflineMap immediately, based upon factors such as current disk space and network availability.

The resulting OfflineMapUpdatesInfo provides a snap-shot of available updates when this method was called. To check for new updates you need to call this method again.

This method was introduced in Esri::ArcGISRuntime 100.6.

Gets OfflineMapSyncParameters for the map that was used to create this task.

This method returns a string representing the task ID of the task.

Uses an asynchronous task to get the default parameters, which are returned in the createDefaultOfflineMapSyncParametersResult property when the task completes. Wait for the createDefaultOfflineMapSyncParametersStatusChanged signal to emit and the createDefaultOfflineMapSyncParametersStatus to be Enums.TaskStatusCompleted before retrieving the result.

The parameters will be pre-populated with values appropriate for updating the feature data in this offline map.

The default parameters will reflect the mobile geodatabases used by the offline map.

This method was introduced in Esri::ArcGISRuntime 100.6.

See also Loadable.

See also Loadable.

Returns an OfflineMapSyncJob to use to run this OfflineMapSyncTask with the given parameters.

The resulting job will synchronize an offline map's geodatabases with their originating services.

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.