Skip To Content ArcGIS for Developers Sign In Dashboard

OfflineMapSyncTask QML Type

A task with methods related to synchronizing an offline map's geodatabases with their originating services. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.1
Inherits:

Object

Properties

Signals

Methods

Detailed Description

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

See also Loadable and RemoteResource.

Property Documentation

checkForUpdatesResult : OfflineMapUpdatesInfo

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 QML property was introduced in Esri.ArcGISRuntime 100.6.


checkForUpdatesStatus : Enums.TaskStatus

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

This QML property was introduced in Esri.ArcGISRuntime 100.6.


createDefaultOfflineMapSyncParametersResult : OfflineMapSyncParameters

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

This QML property was introduced in Esri.ArcGISRuntime 100.6.


createDefaultOfflineMapSyncParametersStatus : Enums.TaskStatus

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

This QML property was introduced in Esri.ArcGISRuntime 100.6.


[default] credential : Credential

The Credential for authenticating against a secured service.

This is only applicable if using a service that is secured.


loadError : Error

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.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


[default] map : OfflineMapSyncTask

The offline map to synchronize.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this task.


updateCapabilities : OfflineMapUpdateCapabilities

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 the preplanned scheduled updates workflow (see OfflineMapUpdateCapabilities::supportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities::supportsSyncWithFeatureServices).

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

This QML property was introduced in Esri.ArcGISRuntime 100.6.


url : url

This inherited property is unused with OfflineMapSyncTask.


Signal Documentation

checkForUpdatesStatusChanged()

Emitted when the checkForUpdatesStatus property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


createDefaultOfflineMapSyncParametersStatusChanged()

Emitted when the createDefaultOfflineMapSyncParametersStatus property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


credentialChanged()

Emitted when the credential property changes.


loadErrorChanged()

Emitted when the loadError property changes.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

See also Loadable.


mapChanged()

Emitted when the map property changes.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.


updateCapabilitiesChanged()

Emitted when the updateCapabilities property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


urlChanged()

Emitted when the url property changes.


Method Documentation

void cancelLoad()

See also Loadable.


string checkForUpdates()

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 QML method was introduced in Esri::ArcGISRuntime 100.6.


string createDefaultOfflineMapSyncParameters()

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 QML method was introduced in Esri::ArcGISRuntime 100.6.


void load()

See also Loadable.


void retryLoad()

See also Loadable.


void syncOfflineMap(OfflineMapSyncParameters parameters)

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



Feedback on this topic?