A job represents a long running asynchronous action.
A job can be paused and re-started. A job can involve multiple network requests.
- Implemented types
- Mixed in types
- Implementers
Constructors
-
Job.fromJson(Map<
String, dynamic> json) -
factory
- Job.fromJsonString(String jsonString)
-
factory
Properties
- error → ArcGISException?
-
Contains an error if the job fails, otherwise null.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messages
→ List<
JobMessage> -
The job's messages.
no setter
-
onJobDone
→ Stream<
void> -
Sets the function that will be called when the job is done.
no setter
-
onMessageAdded
→ Stream<
JobMessage> -
Indicates that a new
JobMessagewas added to Job.messages.no setter -
onProgressChanged
→ Stream<
int> -
Sets the function that will be called when the job's progress has changed.
no setter
-
onStatusChanged
→ Stream<
JobStatus> -
Indicates that the Job.status property has changed.
no setter
- progress → int
-
The current progress of the job as a percentage complete.
no setter
- result → T?
-
The result of a job that has succeeded.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverJobId → String
-
The server job Id of the job.
no setter
- status → JobStatus
-
The status of the job.
no setter
Methods
-
cancel(
) → Future< bool> - Cancels this Job and waits for any asynchronous, server-side operations to be canceled.
-
cancelCancelable(
) → CancelableOperation< bool> - Cancelable version of cancel. See that method for more information.
-
checkStatus(
) → Future< bool> - Initiates a request to check the server status.
-
checkStatusCancelable(
) → CancelableOperation< bool> - Cancelable version of checkStatus. See that method for more information.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → bool - Pauses the job.
-
run(
) → Future< T> - 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.
-
start(
) → bool - Starts the job if the job is not started or paused.
-
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.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited