SyncGeodatabaseJob class final
The SyncGeodatabaseJob synchronizes changes between a local geodatabase and its sync-enabled ArcGIS feature service.
To make a SyncGeodatabaseJob, use the GeodatabaseSyncTask as follows:
- Create and load the GeodatabaseSyncTask with the Geodatabase.serviceUri.
- Obtain the default SyncGeodatabaseParameters for the geodatabase by calling GeodatabaseSyncTask.createDefaultSyncGeodatabaseParameters.
- Modify the SyncGeodatabaseParameters as required. For example, specify the synchronization direction.
- Use the SyncGeodatabaseParameters to create a SyncGeodatabaseJob by calling GeodatabaseSyncTask.syncGeodatabase).
Start the SyncGeodatabaseJob and monitor progress. On completion, examine the SyncLayerResult from the SyncGeodatabaseJob.result to determine whether the synchronization was successful.
- Inheritance
-
- Object
- Job<
List< SyncLayerResult> > - SyncGeodatabaseJob
Properties
- error → ArcGISException?
-
Contains an error if the job fails, otherwise null.
no setterinherited
- geodatabaseDeltaInfo → GeodatabaseDeltaInfo?
-
Returns information on geodatabase upload and download delta files.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messages
→ List<
JobMessage> -
The job's messages.
no setterinherited
-
onJobDone
→ Stream<
void> -
Sets the function that will be called when the job is done.
no setterinherited
-
onMessageAdded
→ Stream<
JobMessage> -
Indicates that a new JobMessage was added to Job.messages.
no setterinherited
-
onProgressChanged
→ Stream<
int> -
Sets the function that will be called when the job's progress has changed.
no setterinherited
-
onStatusChanged
→ Stream<
JobStatus> -
Indicates that the Job.status property has changed.
no setterinherited
- progress → int
-
The current progress of the job as a percentage complete.
no setterinherited
-
result
→ List<
SyncLayerResult> -
For a successfully completed job, an array of SyncLayerResult is
returned. If all edits to the geodatabase's tables and layers are synced
successfully, an empty array is returned.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverJobId → String
-
The server job Id of the job.
no setterinherited
- status → JobStatus
-
The status of the job.
no setterinherited
Methods
-
cancel(
) → Future< bool> -
Cancels this Job and waits for any asynchronous, server-side operations
to be canceled.
inherited
-
checkStatus(
) → Future< bool> -
Initiates a request to check the server status.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → bool -
Pauses the job.
inherited
-
run(
) → Future< List< SyncLayerResult> > -
Starts the job and returns a Future that completes with either the result
of the job or an error if the job did not finish successfully.
inherited
-
start(
) → bool -
Starts the job if the job is not started or paused.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited