Class OfflineMapSyncParameters

    • Constructor Detail

      • OfflineMapSyncParameters

        public OfflineMapSyncParameters()
        Constructs a new OfflineMapSyncParameters instance.
        Since:
        100.1.0
    • Method Detail

      • isKeepGeodatabaseDeltas

        public boolean isKeepGeodatabaseDeltas()
        Indicates whether or not the uploaded or downloaded delta geodatabases should be removed at the end of the sync job.

        A delta geodatabase is a file that contains the changes that have occurred since a mobile replica Geodatabase was last synchronized with its feature service. See Synchronize Replica for an overview of the delta files used in synchronization. There are two types of delta geodatabase:

        • Local edits, performed on the user's device, are exported as an "upload" delta that is applied to the originating feature service.
        • Online edits, performed by other users, are requested as a "download" delta which is then applied to the local replica geodatabase.
        Delta geodatabases allow you to troubleshoot sync problems. For example, you can inspect the geodatabase changes or you could send the file to the administrator of the feature service.
        Returns:
        indicates whether or not the upload or downloaded delta geodatabases should be removed at the end of the sync job
        Since:
        100.10.0
      • setKeepGeodatabaseDeltas

        public void setKeepGeodatabaseDeltas​(boolean keepGeodatabaseDeltas)
        Sets whether or not the uploaded or downloaded delta geodatabases should be removed at the end of the sync job.

        A delta geodatabase is a file that contains the changes that have occurred since a mobile replica Geodatabase was last synchronized with its feature service. See https://developers.arcgis.com/rest/services-reference/synchronize-replica.htm for an overview of the delta files used in synchronization. There are two types of delta geodatabase:

        • Local edits, performed on the user's device, are exported as an "upload" delta that is applied to the originating feature service.
        • Online edits, performed by other users, are requested as a "download" delta which is then applied to the local replica geodatabase.
        Delta geodatabases allow you to troubleshoot sync problems. For example, you can inspect the geodatabase changes or you could send the file to the administrator of the feature service.

        You can choose to retain both the uploaded and downloaded delta geodatabases once the sync job has completed. Set to true to retain both delta geodatabases and set to false to have them deleted at the end of the sync job. Deltas will be retained regardless of whether the job succeeds or fails. Note that when this property is set to true, the upload delta geodatabase will only be available if there are changes to upload and the sync direction is SyncGeodatabaseParameters.SyncDirection.UPLOAD or SyncGeodatabaseParameters.SyncDirection.BIDIRECTIONAL. The download delta geodatabase will only be available when there are changes to download and the sync direction is SyncGeodatabaseParameters.SyncDirection.DOWNLOAD or SyncGeodatabaseParameters.SyncDirection.BIDIRECTIONAL. The default value is false.

        No geodatabase deltas will be retained if your geodatabase uses a scheduled updates workflow.

        Parameters:
        keepGeodatabaseDeltas - indicates whether or not the upload or downloaded delta geodatabases should be removed at the end of the sync job
        Since:
        100.10.0
      • getPreplannedScheduledUpdatesOption

        public PreplannedScheduledUpdatesOption getPreplannedScheduledUpdatesOption()
        Gets the PreplannedScheduledUpdatesOption that determines whether scheduled updates will be downloaded from an online map area and applied to the map's data.
        Returns:
        the PreplannedScheduledUpdatesOption
        Since:
        100.6.0
      • setPreplannedScheduledUpdatesOption

        public void setPreplannedScheduledUpdatesOption​(PreplannedScheduledUpdatesOption preplannedScheduledUpdatesOption)
        Sets the PreplannedScheduledUpdatesOption that determines whether scheduled updates will be downloaded from an online map area and applied to the map's data.

        If the mobile geodatabases in your offline map were not registered for sync you can choose to download and apply those updates by setting this property to PreplannedScheduledUpdatesOption.DOWNLOAD_ALL_UPDATES.

        You specify whether an offline map will make use of scheduled updates by setting the DownloadPreplannedOfflineMapParameters.getUpdateMode() property before downloading.

        The default value is PreplannedScheduledUpdatesOption.DOWNLOAD_ALL_UPDATES.

        Parameters:
        preplannedScheduledUpdatesOption - the PreplannedScheduledUpdatesOption to use
        Throws:
        java.lang.IllegalArgumentException - if preplannedScheduledUpdatesOption is null
        Since:
        100.6.0
      • isRollbackOnFailure

        public boolean isRollbackOnFailure()
        Indicates if geodatabase synchronization should roll back on a failure.
        Returns:
        true if geodatabase synchronization should rollback on failure, false otherwise
        Since:
        100.1.0
        See Also:
        setRollbackOnFailure(boolean)
      • setRollbackOnFailure

        public void setRollbackOnFailure​(boolean rollbackOnFailure)
        Sets whether or not geodatabase synchronization should roll back on a failure. The default is false (no rollback on failure).
        Parameters:
        rollbackOnFailure - true to rollback on failure, false otherwise
        Since:
        100.1.0