Skip To Content ArcGIS for Developers Sign In Dashboard

OfflineMapSyncTask Class

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: Esri::ArcGISRuntime::Object, Esri::ArcGISRuntime::Loadable, and Esri::ArcGISRuntime::RemoteResource

This class was introduced in Esri::ArcGISRuntime 100.1.

Public Functions

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

Reimplemented Public Functions

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

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)

Detailed Description

Member Function Documentation

OfflineMapSyncTask::OfflineMapSyncTask(Esri::ArcGISRuntime::Map *map, Esri::ArcGISRuntime::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(Esri::ArcGISRuntime::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.

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

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

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

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

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] OfflineMapSyncTask::~OfflineMapSyncTask()

Destructor.

[override virtual] void OfflineMapSyncTask::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

Esri::ArcGISRuntime::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.

Esri::ArcGISRuntime::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.

[override virtual] Esri::ArcGISRuntime::Credential *OfflineMapSyncTask::credential() const

Reimplements: RemoteResource::credential() const.

Returns the Credential used to connect to a secured service.

[override virtual] void OfflineMapSyncTask::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error OfflineMapSyncTask::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus OfflineMapSyncTask::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

Esri::ArcGISRuntime::Map *OfflineMapSyncTask::map() const

Returns the offline map to synchronize.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration OfflineMapSyncTask::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

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

See also setRequestConfiguration().

[override virtual] void OfflineMapSyncTask::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

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

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

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

See also requestConfiguration().

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

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

Esri::ArcGISRuntime::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?