Class OfflineMapSyncTask
- All Implemented Interfaces:
RemoteResource
,Loadable
- Since:
- 100.1.0
-
Property Summary
PropertiesTypePropertyDescriptionThe load error.The load status. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an OfflineMapSyncTask for synchronizing the geodatabases used by the given map. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable listener) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.Executes an asynchronous operation to check what updates are available for the offline map that was used to construct this task.Executes an asynchronous operation to create a set of default parameters that can be used to synchronize an offline map's geodatabases with their originating services.Gets the credential used to authenticate the user with this task.Gets the value of the property loadError.Gets the value of the property loadStatus.getMap()
Gets the map associated with this task.Gets the RequestConfiguration object in use by this task.Gets a description of the methods used for obtaining updates to the offline map that was used to create this task.getUri()
Throws an UnsupportedOperationException because OfflineMapSyncTask doesn't have a URI.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable listener) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.void
setCredential
(Credential credential) Sets the credential used to authenticate the user with this task.void
setRequestConfiguration
(RequestConfiguration requestConfiguration) Sets configuration parameters used for network requests sent using this task.syncOfflineMap
(OfflineMapSyncParameters parameters) Creates anOfflineMapSyncJob
that can be used to synchronize an offline map's geodatabases with their originating services.
-
Property Details
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- See Also:
-
-
Constructor Details
-
OfflineMapSyncTask
Constructs an OfflineMapSyncTask for synchronizing the geodatabases used by the given map.- Parameters:
map
- an ArcGISMap to be synchronized- Throws:
IllegalArgumentException
- if map is null- Since:
- 100.1.0
-
-
Method Details
-
setCredential
Sets the credential used to authenticate the user with this task.- Specified by:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the credential used to authenticate the user with this task- Since:
- 100.1.0
-
getCredential
Gets the credential used to authenticate the user with this task.- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the credential, or null if there is none
- Since:
- 100.1.0
-
setRequestConfiguration
Sets configuration parameters used for network requests sent using this task. The global RequestConfiguration is used if no RequestConfiguration is set.- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- contains the configuration parameters to use- Since:
- 100.1.0
-
getRequestConfiguration
Gets the RequestConfiguration object in use by this task.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the RequestConfiguration object, or null if none has been set
- Since:
- 100.1.0
- See Also:
-
getUri
Throws an UnsupportedOperationException because OfflineMapSyncTask doesn't have a URI.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
- Throws:
UnsupportedOperationException
- always- Since:
- 100.1.0
-
getMap
Gets the map associated with this task.- Returns:
- the map
- Since:
- 100.1.0
-
getUpdateCapabilities
Gets a description of the methods used for obtaining updates to the offline map that was used to create this task.You can use this property to determine whether an offline map is configured to use the update packages (see
OfflineMapUpdateCapabilities.isSupportsScheduledUpdatesForFeatures()
) or to sync directly with feature services (seeOfflineMapUpdateCapabilities.isSupportsSyncWithFeatureServices()
)). If the offline map was created usingPreplannedUpdateMode.DOWNLOAD_SCHEDULED_UPDATES_AND_UPLOAD_NEW_FEATURES
, it will support both update modes, but you will only be able to upload newly created features.- Returns:
- the update capabilities, or null if this OfflineMapSyncTask is not loaded
- Since:
- 100.6.0
-
checkForUpdatesAsync
Executes an asynchronous operation to check what updates are available for the offline map that was used to construct this task. The result is an OfflineMapUpdatesInfo object that provides information on:- online changes that can be applied to update your offline map
- local changes from your offline map that can be sent back to the online services
syncOfflineMap(OfflineMapSyncParameters)
immediately, based upon factors such as current disk space and network availability. Examine these properties before starting the potentially time-consuming offline map sync process.The resulting OfflineMapUpdatesInfo provides a snap-shot of available updates when this method was called. To check for new updates you need to call this method again.
- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation
- Since:
- 100.6.0
-
createDefaultOfflineMapSyncParametersAsync
Executes an asynchronous operation to create a set of default parameters that can be used to synchronize an offline map's geodatabases with their originating services. The result is an OfflineMapSyncParameters object.The parameters will be pre-populated with values appropriate for updating the feature data in this offline map.
The default parameters will reflect the mobile geodatabases used by the offline map.
- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation
- Since:
- 100.6.0
- See Also:
-
syncOfflineMap
Creates anOfflineMapSyncJob
that can be used to synchronize an offline map's geodatabases with their originating services.You should not execute more than one sync on a particular geodatabase at the same time. This includes any operations that export or import deltas from the local
Geodatabase
:- Parameters:
parameters
- the parameters to be used to create the OfflineMapSyncJob- Returns:
- the OfflineMapSyncJob; note you must call
Job.start()
to start the Job - Throws:
IllegalArgumentException
- if parameters is null- Since:
- 100.1.0
- See Also:
-
getLoadStatus
Gets the value of the property loadStatus.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
Gets the value of the property loadError.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
cancelLoad
public void cancelLoad()Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
loadAsync
public void loadAsync()Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
. -
retryLoadAsync
public void retryLoadAsync()Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
addDoneLoadingListener
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, add a listener to the
Loadable.loadStatusProperty()
instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- See Also:
-