OfflineMapSyncTask class final
A task to synchronize an offline map's geodatabases with its originating sync-enabled ArcGIS feature services.
You can take a map offline from a web map using the OfflineMapTask. This can be an offline map created ahead-of-time or an on-demand map. For more information, see the Ahead-of-time vs on-demand workflows. The offline map is stored on the device so its data can be displayed, queried, and edited whilst the device is offline.
You can update the data content by synchronizing the offline map with its source web map. Edits to offline feature data can be posted to the source web map, and any edits to the source web map's feature data content can be downloaded and applied to the offline map. This brings the source web map content and the offline map content into alignment. Edits to features, non-spatial data, related data, and attachments can be synchronized. A network connection must be present for synchronization. Here are typical steps to synchronize data between the offline map and its source web map:
- Create an OfflineMapSyncTask with the offline map (ArcGISMap).
- Obtain the OfflineMapSyncParameters for the offline map by calling OfflineMapSyncTask.createDefaultOfflineMapSyncParameters. Optionally modify these (for example, to specifying a synchronization direction).
- Create an OfflineMapSyncJob by calling OfflineMapSyncTask.syncOfflineMap.
- Start the OfflineMapSyncJob. Upon job completion, examine the OfflineMapSyncResult from the OfflineMapSyncJob.result to determine whether the synchronization was successful.
If there are attribute or geometry level conflicts on a feature during synchronization, the most recently synchronized edit will be applied. For example, if both user A and user B edit the same feature while offline, if user A synchronizes their edits first, then user B synchronizes their edits, the updated feature will represent the edits made by user B.
Synchronization errors typically occur because of network connectivity issues during the sync process. The synchronization mechanism is robust to these types of errors, however, and they can be resolved by synchronizing again when a reliable network connection becomes available.
If you created the offline map using the ahead-of-time workflow, it may support a synchronization workflow known as update packages. Update packages optimize updating the data contents of a downloaded offline map to the latest contents of the source web map. For more information, see Update packages.
If you want to download and synchronize individual feature services to a single offline geodatabase, instead of taking a map offline, then you can use the GeodatabaseSyncTask.
- Implemented types
- Mixed in types
Constructors
- OfflineMapSyncTask.withMap(ArcGISMap arcGISMap)
-
Creates an offline map sync task for synchronizing the geodatabases used
by a map.
factory
Properties
- arcGISMap → ArcGISMap
-
The map to be synchronized.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the
LoadStatus.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- updateCapabilities → OfflineMapUpdateCapabilities?
-
Describes the methods that can be used to obtain updates to the offline
map.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
checkForUpdates(
) → Future< OfflineMapUpdatesInfo> -
Retrieves
OfflineMapUpdatesInfofor the offline map that was used to construct this task. -
checkForUpdatesCancelable(
) → CancelableOperation< OfflineMapUpdatesInfo> - Cancelable version of checkForUpdates. See that method for more information.
-
createDefaultOfflineMapSyncParameters(
) → Future< OfflineMapSyncParameters> - This populates the parameters with values appropriate for synchronizing the feature data in this offline map.
-
createDefaultOfflineMapSyncParametersCancelable(
) → CancelableOperation< OfflineMapSyncParameters> - Cancelable version of createDefaultOfflineMapSyncParameters. See that method for more information.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
syncOfflineMap(
{required OfflineMapSyncParameters parameters}) → OfflineMapSyncJob - Returns a job to synchronize an offline map's geodatabases with their originating services.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited