OfflineMapUpdatesInfo Class

  • OfflineMapUpdatesInfo
  • class Esri::ArcGISRuntime::OfflineMapUpdatesInfo

    Provides information on the available updates for an offline map. More...

    Header: #include <OfflineMapUpdatesInfo.h>
    Since: Esri::ArcGISRuntime 100.6
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~OfflineMapUpdatesInfo() override
    Esri::ArcGISRuntime::OfflineUpdateAvailability downloadAvailability() const
    bool isMobileMapPackageReopenRequired() const
    qint64 scheduledUpdatesDownloadSize() const
    Esri::ArcGISRuntime::OfflineUpdateAvailability uploadAvailability() const

    Detailed Description

    This type provides high level information on what updates are available for an offline map. Update information covers:

    • Online changes which can be applied to update your offline map.
    • Local changes from your offline map that can be sent back to the online services.

    Member Function Documentation

    [override virtual] OfflineMapUpdatesInfo::~OfflineMapUpdatesInfo()


    Esri::ArcGISRuntime::OfflineUpdateAvailability OfflineMapUpdatesInfo::downloadAvailability() const

    Indicates whether there are changes available to download.

    If this property is OfflineUpdateAvailability::Available then there are online updates to apply to your offline map.

    If this property is OfflineUpdateAvailability::None then there are no online updates available for your offline map.

    Note that the availability of updates to download can only be determined for offline maps that use the scheduled updates workflow. See PreplannedUpdateMode::DownloadScheduledUpdates and PreplannedUpdateMode::DownloadScheduledUpdatesAndUploadNewFeatures. If your offline map is set up to download changes directly from the feature services (for example using PreplannedUpdateMode::SyncWithFeatureServices or created with a GenerateOfflineMapJob), then this property will be OfflineUpdateAvailability::Indeterminate.

    bool OfflineMapUpdatesInfo::isMobileMapPackageReopenRequired() const

    Returns whether the mobile map package must be reopened after applying the available updates.

    In some cases, applying updates may require files, such as mobile geodatabases, to be replaced with a new version. When a reopen will be required after updating, this property will be true - see OfflineMapSyncResult::isMobileMapPackageReopenRequired.

    If your offline map was created using PreplannedUpdateMode::DownloadScheduledUpdatesAndUploadNewFeatures, be aware that immediately following replacement, the new geodatabase will not contain the new features that have been synced up to the feature service. The uploaded features can be downloaded after the next scheduled update has executed and changes are available for download.

    qint64 OfflineMapUpdatesInfo::scheduledUpdatesDownloadSize() const

    The total size in bytes of update files to download for a scheduled updates workflow.

    The scheduled updates workflow allows read-only updates to be stored with the online map area and downloaded to your device at a later time. Updates can cover several sets of changes to the online geodatabase and can cover multiple geodatabases in an offline map. This property is the total download size of all files required to update your offline map.

    You can use this information to determine whether you want to download updates immediately - for example based on available disk space or network availability.

    If there are no updates available, or your offline map does not use a scheduled updates workflow, this property will be 0.

    Esri::ArcGISRuntime::OfflineUpdateAvailability OfflineMapUpdatesInfo::uploadAvailability() const

    Indicates whether there are local changes to upload.

    If your offline map contains local edits that can be uploaded to online feature services, this property will be OfflineUpdateAvailability::Available.

    If there are no local changes, or your offline map does not support syncing with feature services, this property will be OfflineUpdateAvailability::None.

    See also Geodatabase::hasLocalEdits.

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