Job QML Type
A base type for types representing a long running job on a server. More...
| Import Statement: | import Esri.ArcGISRuntime 100.9 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | DownloadPreplannedOfflineMapJob, EstimateTileCacheSizeJob, ExportTileCacheJob, ExportVectorTilesJob, GenerateGeodatabaseJob, GenerateOfflineMapJob, GeoprocessingJob, OfflineMapSyncJob, and SyncGeodatabaseJob |
Properties
- checkStatusTaskStatus : Enums.TaskStatus
- credential : Credential
- error : Error
- jobStatus : Enums.JobStatus
- jobType : Enums.JobType
- json : jsobject
- messages : list<JobMessage>
- progress : int
- requestConfiguration : RequestConfiguration
- serverJobId : string
- unknownJson : jsobject
- unsupportedJson : jsobject
- url : url
Signals
- checkStatusTaskStatusChanged()
- credentialChanged()
- jobErrorChanged()
- jobStatusChanged()
- messagesChanged()
- progressChanged()
- requestConfigurationChanged()
Methods
- bool cancel()
- bool cancelTask(taskId)
- string checkStatus()
- bool pause()
- bool start()
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
A job is initiated when it is submitted to the server. When the server accepts the job, it assigns a unique ID to the job which is available in serverJobID. The client then periodically polls for the status of the job on the server. If the job completes successfully, the result of the job is downloaded, otherwise an error is provided when the job fails.
Job instances created by tasks and returned by task methods are returned in a JobStatus::NotStarted state and Job::resume must be called to start the associated operation.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| Credential | credential (since Esri.ArcGISRuntime 100.1) |
| RequestConfiguration | requestConfiguration (since Esri.ArcGISRuntime 100.1) |
See also Cancelable, JsonSerializable, and RemoteResource.
Property Documentation
Returns the current status of the checkStatus method (read-only).
Note: The status indicates if the current job status was retrieved from the service.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Enums.TaskStatus.
[default] credential : Credential |
The Credential for authenticating against a secured service.
This is only applicable if using a service that is secured.
This property was introduced in Esri.ArcGISRuntime 100.1.
error : Error |
Returns the error encountered during job execution, if any (read-only).
Obtain this property after the jobStatusChanged signal emits, and the jobStatus is complete.
Returns the current status of this Job (read-only).
See also Enums.JobStatus.
Returns the JobType of this Job (read-only).
See also Enums.JobType.
The JSON representation of this object.
This JSON can be used to instantiate the type instance.
messages : list<JobMessage> |
The informational messages produced during execution of the job.
Returns the current progress of the job as the percentage complete (read-only).
This property was introduced in Esri.ArcGISRuntime 100.1.
[default] requestConfiguration : RequestConfiguration |
The configuration parameters used for network requests sent by this job.
This property was introduced in Esri.ArcGISRuntime 100.1.
Returns the unique job ID of this Job on the server on which it is executing (read-only).
Returns the unknown JSON from the source JSON.
See also JsonSerializable.
Returns the unsupported data from the source JSON.
See also JsonSerializable.
Signal Documentation
Emitted when the checkStatusTaskStatus property changes.
Note: The corresponding handler is onCheckStatusTaskStatusChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the credential property changes.
Note: The corresponding handler is onCredentialChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the error property of this Job changes.
Note: The corresponding handler is onJobErrorChanged.
Emitted when the jobStatus property of this Job changes.
Note: The corresponding handler is onJobStatusChanged.
Emitted when the messages property of this Job changes.
Note: The corresponding handler is onMessagesChanged.
Emitted when the progress property of this Job changes.
Note: The corresponding handler is onProgressChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Method Documentation
Cancels this Job.
Returns true if the job was successfully cancelled; false if it is already done, or if there is an error.
Cancel the task with the ID taskId.
Returns false if the task cannot be cancelled or there is no task with the specified id taskId.
This method was introduced in Esri.ArcGISRuntime 100.1.
See also Cancelable.
Checks the current job status from the service.
The checkStatusTaskStatusChanged signal will emit once the operation is complete.
The task completes after the status has been checked. If the job is polling the server for status and is in a time gap, then calling this method will ensure a request is sent right away.
Note: It's possible the task can complete successfully and retrieve the same status. In that case, jobStatusChanged will not be emitted.
This method was introduced in Esri.ArcGISRuntime 100.1.
See also jobStatusChanged and checkStatusTaskStatusChanged.
Pauses the job.
Returns true if the job was successfully paused; false if it is already done, or if there is an error.
Starts or resumes this job. Call this method to start the job initially and also to resume it after it is paused.
Returns true if the job was successfully started/resumed; false if it is already done, or if there is an error.