Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.offlinemap

Enum Class PreplannedUpdateMode

java.lang.Object
java.lang.Enum<PreplannedUpdateMode>
com.esri.arcgisruntime.tasks.offlinemap.PreplannedUpdateMode
All Implemented Interfaces:
Serializable, Comparable<PreplannedUpdateMode>, Constable
public enum PreplannedUpdateMode extends Enum<PreplannedUpdateMode>
Defines the various modes that control how updates are obtained for a preplanned offline map area.
Since:
100.6.0

  • Enum Constant Details

    • NO_UPDATES

      public static final PreplannedUpdateMode NO_UPDATES
      No feature updates will be performed.
      Since:
      100.6.0

    • SYNC_WITH_FEATURE_SERVICES

      public static final PreplannedUpdateMode SYNC_WITH_FEATURE_SERVICES
      Changes, including local edits, will be synced directly with the underlying feature services.

      This mode gives you full control over when you upload and download changes. However, performing a download sync places additional load on the backing feature service, so this approach does not scale well for larger deployments.

      This mode is available when the PreplannedMapArea.getUpdateCapabilities() include OfflineMapUpdateCapabilities.isSupportsSyncWithFeatureServices().

      Since:
      100.6.0

    • DOWNLOAD_SCHEDULED_UPDATES

      public static final PreplannedUpdateMode DOWNLOAD_SCHEDULED_UPDATES
      Scheduled, read-only updates will be downloaded from the online map area and applied to the local mobile geodatabases.

      Updates are prepared on a regular schedule and cached for download by all users of the offline map area. Sharing a single set of cached updates, rather than performing individual sync operations, reduces the load on the back-end services. This approach is scalable for large deployments but does not support offline editing.

      This mode is available when the PreplannedMapArea.getUpdateCapabilities() include OfflineMapUpdateCapabilities.isSupportsScheduledUpdatesForFeatures().

      Since:
      100.6.0

    • DOWNLOAD_SCHEDULED_UPDATES_AND_UPLOAD_NEW_FEATURES

      public static final PreplannedUpdateMode DOWNLOAD_SCHEDULED_UPDATES_AND_UPLOAD_NEW_FEATURES
      Scheduled, read-only updates are downloaded from the online map area and applied to the local mobile geodatabases. Newly added features can also be uploaded to the feature service.

      This is an advanced workflow that improves the scalability of feature services. When available, applicable scheduled update packages are downloaded and merged into a local geodatabase. This allows for efficient downloading of changes. New features are uploaded using feature sync, which is an efficient operation in the feature service.

      Note that when the required update packages are not available, the local geodatabase will be replaced with a new copy. OfflineMapUpdatesInfo.isMobileMapPackageReopenRequired() indicates that a new copy of a geodatabase will be downloaded. Local adds on your device must be uploaded to the feature service before the database can safely be replaced.

      Be aware that immediately following replacement, the new geodatabase may not contain the new features that have been synced up to the feature service, as this relies on a subsequent scheduled update to download to the client. The new features will be retrieved when the next scheduled update is downloaded and applied.

      This mode is available when the PreplannedMapArea.getUpdateCapabilities() include both OfflineMapUpdateCapabilities.isSupportsSyncWithFeatureServices() and OfflineMapUpdateCapabilities.isSupportsScheduledUpdatesForFeatures() and the feature services in your map support creating new features.

      Since:
      100.14.0

  • Method Details

    • values

      public static PreplannedUpdateMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PreplannedUpdateMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null