DownloadPreplannedOfflineMapJob Class

  • DownloadPreplannedOfflineMapJob
  • class Esri::ArcGISRuntime::DownloadPreplannedOfflineMapJob

    A job to download an offline map area from an online map as part of the preplanned offline workflow. More...

    Header: #include <DownloadPreplannedOfflineMapJob.h>
    Since: Esri::ArcGISRuntime 100.2
    Inherits: Esri::ArcGISRuntime::Job

    Public Functions

    virtual ~DownloadPreplannedOfflineMapJob() override
    QString downloadDirectoryPath() const
    Esri::ArcGISRuntime::Map *onlineMap() const
    Esri::ArcGISRuntime::DownloadPreplannedOfflineMapParameters parameters() const
    Esri::ArcGISRuntime::DownloadPreplannedOfflineMapResult *result() const

    Detailed Description

    Use this job to download the map content of a map area to your device so that you can work offline without a network connection. Upon completion, the job's DownloadPreplannedOfflineMapResult provides the offline map along with the details of any errors incurred during the download process.

    An object of this type is created by the function OfflineMapTask::downloadPreplannedOfflineMap.

    Member Function Documentation

    [override virtual] DownloadPreplannedOfflineMapJob::~DownloadPreplannedOfflineMapJob()


    QString DownloadPreplannedOfflineMapJob::downloadDirectoryPath() const

    Returns the directory path to the location of the mobile map package.

    The directory path is the path that was supplied as a parameter to the OfflineMapTask::downloadPreplannedOfflineMap(const Esri::ArcGISRuntime::DownloadPreplannedOfflineMapParameters&, const QString&, QObject*). The job will fail if the last directory in the path cannot be created or is not empty.

    Esri::ArcGISRuntime::Map *DownloadPreplannedOfflineMapJob::onlineMap() const

    Returns the online map used by this job.

    [since Esri::ArcGISRuntime 100.4] Esri::ArcGISRuntime::DownloadPreplannedOfflineMapParameters DownloadPreplannedOfflineMapJob::parameters() const

    Returns the preplanned map parameters used to create this job.

    This function was introduced in Esri::ArcGISRuntime 100.4.

    Esri::ArcGISRuntime::DownloadPreplannedOfflineMapResult *DownloadPreplannedOfflineMapJob::result() const

    Returns the result of a download preplanned offline map job that has succeeded.

    Although this job will have succeeded you must confirm whether any of the map content failed to be taken offline. Examine DownloadPreplannedOfflineMapResult::hasErrors and the DownloadPreplannedOfflineMapResult::layerErrors and DownloadPreplannedOfflineMapResult::tableErrors dictionaries to identify layers and tables that could not be taken offline.

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