Skip To Content ArcGIS for Developers Sign In Dashboard

OfflineMapSyncTask Class

(Esri::ArcGISRuntime::OfflineMapSyncTask)

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

Header: #include <OfflineMapSyncTask>
Since: Esri::ArcGISRuntime 100.1
Inherits: Object, Loadable, and RemoteResource

Public Functions

OfflineMapSyncTask(Map *map, QObject *parent = nullptr)
OfflineMapSyncTask(Map *map, Credential *credential, QObject *parent = nullptr)
~OfflineMapSyncTask()
TaskWatcher checkForUpdates()
TaskWatcher createDefaultOfflineMapSyncParameters()
Map *map() const
OfflineMapSyncJob *syncOfflineMap(const OfflineMapSyncParameters &parameters)
OfflineMapUpdateCapabilities *updateCapabilities() const

Reimplemented Public Functions

virtual void cancelLoad()
virtual Credential *credential() const
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual RequestConfiguration requestConfiguration() const
virtual void retryLoad()
virtual void setRequestConfiguration(const RequestConfiguration &requestConfiguration)

Signals

void checkForUpdatesCompleted(QUuid taskId, Esri::ArcGISRuntime::OfflineMapUpdatesInfo *updatesInfo)
void createDefaultOfflineMapSyncParametersCompleted(QUuid taskId, const Esri::ArcGISRuntime::OfflineMapSyncParameters &parameters)
void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

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

Member Function Documentation

OfflineMapSyncTask::OfflineMapSyncTask(Map *map, QObject *parent = nullptr)

Constructor that accepts an online map and a parent object.

  • map - The offline map to synchronize.
  • parent - The parent object of this OfflineMapTask.

OfflineMapSyncTask::OfflineMapSyncTask(Map *map, Credential *credential, QObject *parent = nullptr)

Constructor that accepts an online map, a credential, and a parent object.

  • map - The map to synchronize.
  • credential - The Credential to use to connect to a secured service.
  • parent - The parent object of this OfflineMapTask.

OfflineMapSyncTask::~OfflineMapSyncTask()

Destructor.

[virtual] void OfflineMapSyncTask::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

TaskWatcher OfflineMapSyncTask::checkForUpdates()

Asynchronously retrieves an OfflineMapUpdatesInfo for the map that was used to construct this task.

Returns a TaskWatcher for this asynchronous operation.

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

  • Online changes that can 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 returned 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 function was introduced in Esri::ArcGISRuntime 100.6.

See also checkForUpdatesCompleted.

[signal] void OfflineMapSyncTask::checkForUpdatesCompleted(QUuid taskId, Esri::ArcGISRuntime::OfflineMapUpdatesInfo *updatesInfo)

Emitted when the checkForUpdates operation completes.

  • taskId - The task ID of the asynchronous operation.
  • updatesInfo - Information on available updates for the map that was used to construct this task.

The returned OfflineMapUpdatesInfo object has the OfflineMapSyncTask as its parent.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also Returned QObjects Parenting.

TaskWatcher OfflineMapSyncTask::createDefaultOfflineMapSyncParameters()

Asynchronously retrieves an OfflineMapSyncParameters for the map that was used to construct this task.

Returns a TaskWatcher for this asynchronous operation.

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

See also createDefaultOfflineMapSyncParametersCompleted.

[signal] void OfflineMapSyncTask::createDefaultOfflineMapSyncParametersCompleted(QUuid taskId, const Esri::ArcGISRuntime::OfflineMapSyncParameters &parameters)

Emitted when the createDefaultOfflineMapSyncParameters operation completes.

  • taskId - The task ID of the asynchronous operation.
  • parameters - The default parameters for the map that was used to construct this task.

This function was introduced in Esri::ArcGISRuntime 100.6.

[virtual] Credential *OfflineMapSyncTask::credential() const

Reimplemented from RemoteResource::credential().

Returns the Credential used to connect to a secured service.

[signal] void OfflineMapSyncTask::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[virtual] void OfflineMapSyncTask::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error OfflineMapSyncTask::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus OfflineMapSyncTask::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

[signal] void OfflineMapSyncTask::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

Map *OfflineMapSyncTask::map() const

Returns the offline map to synchronize.

[virtual] RequestConfiguration OfflineMapSyncTask::requestConfiguration() const

Reimplemented from RemoteResource::requestConfiguration().

Returns the configuration parameters used for network requests sent by this task.

See also setRequestConfiguration().

[virtual] void OfflineMapSyncTask::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

[virtual] void OfflineMapSyncTask::setRequestConfiguration(const RequestConfiguration &requestConfiguration)

Reimplemented from RemoteResource::setRequestConfiguration().

Sets configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().

OfflineMapSyncJob *OfflineMapSyncTask::syncOfflineMap(const OfflineMapSyncParameters &parameters)

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

OfflineMapUpdateCapabilities *OfflineMapSyncTask::updateCapabilities() const

Describes the methods used for obtaining updates to the offline map that was used to create this task.

You can use this property to determine whether an offline map is configured to use the preplanned scheduled updates workflow (see OfflineMapUpdateCapabilities::isSupportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities::isSupportsSyncWithFeatureServices).

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

This function was introduced in Esri::ArcGISRuntime 100.6.


Feedback on this topic?