OfflineMapSyncTask Class

  • 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.h>
    Since: Esri::ArcGISRuntime 100.1
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

    Public Functions

    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 void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual void retryLoad() override


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

    Detailed Description

    Member Function Documentation

    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, since Esri::ArcGISRuntime 100.6] void OfflineMapSyncTask::checkForUpdatesCompleted(const 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, since Esri::ArcGISRuntime 100.6] void OfflineMapSyncTask::createDefaultOfflineMapSyncParametersCompleted(const 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(const 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()


    [override virtual] void OfflineMapSyncTask::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    See Loadable.

    [since Esri::ArcGISRuntime 100.6] 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.

    [since Esri::ArcGISRuntime 100.6] 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] 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] void OfflineMapSyncTask::retryLoad()

    Reimplements: Loadable::retryLoad().

    See Loadable.

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

    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:

    [since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::OfflineMapUpdateCapabilities *OfflineMapSyncTask::updateCapabilities() const

    Returns 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 update packages (see OfflineMapUpdateCapabilities::isSupportsScheduledUpdatesForFeatures) or to sync directly with feature services (see OfflineMapUpdateCapabilities::isSupportsSyncWithFeatureServices). If the offline map was created using PreplannedUpdateMode::DownloadScheduledUpdatesAndUploadNewFeatures, it will support both update modes, but you will only be able to upload newly created features.

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

    This function was introduced in Esri::ArcGISRuntime 100.6.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.