The following members of class Job are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.
Public Functions
(since Esri Esri | cancel |
(since Esri Esri | check |
Signals
(since Esri void | cancel |
(since Esri void | check |
Member Function Documentation
[since Esri::ArcGISRuntime 100.14, deprecated] Esri::ArcGISRuntime::TaskWatcher Job::cancelAsync ()
This function is deprecated. We strongly advise against using it in new code.
Cancels this Job and waits for any asynchronous, server-side operations to be canceled.
The job is canceled and will result in a JobStatus::Failed status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated serverJobId. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:
In addition, the GenerateOfflineMapJob is composed of several server-side jobs, depending on the types of layers in your Map. Canceling this high-level job will also send a cancel request to the underlying server jobs.
Upon calling this method, the jobStatus is immediately set to JobStatus::Canceling.
This method returns a TaskWatcher for the asynchronous operation.
This function was introduced in Esri::ArcGISRuntime 100.14.
[signal, since Esri::ArcGISRuntime 100.14, deprecated] void Job::cancelAsyncCompleted (const QUuid &taskId , bool succeeded)
This function is deprecated. We strongly advise against using it in new code.
Signal emitted when the cancelJobAsync operation completes.
- taskId - The task ID of the asynchronous operation.
- succeeded - Whether the cancel operation was successful.
This function was introduced in Esri::ArcGISRuntime 100.14.
[since Esri::ArcGISRuntime 100.1, deprecated] Esri::ArcGISRuntime::TaskWatcher Job::checkStatus ()
This function is deprecated. We strongly advise against using it in new code.
Checks the current job status from the service and returns a TaskWatcher for the asynchronous task.
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.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also checkStatusCompleted.
[signal, since Esri::ArcGISRuntime 100.1, deprecated] void Job::checkStatusCompleted (const QUuid &taskId , bool succeeded)
This function is deprecated. We strongly advise against using it in new code.
Signal emitted when checking the status has completed.
The result can be false if the job is not checking server status for example if the job status is paused or uploading.
- taskId - The task ID of the asynchronous task.
- succeeded - Whether the current status of the job was checked from the service.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also jobStatus.
[override virtual, deprecated] Esri::ArcGISRuntime::Credential *Job::credential() const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::credential() const.
Returns the security credential used to access the tiled ArcGIS map Service.
This is only applicable if using a service that is secured.
[override virtual, since Esri::ArcGISRuntime 100.1, deprecated] Esri::ArcGISRuntime::RequestConfiguration Job::requestConfiguration () const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::requestConfiguration() const.
Returns the RequestConfiguration in use by this job.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also setRequestConfiguration().
[override virtual, since Esri::ArcGISRuntime 100.1, deprecated] void Job::setRequestConfiguration (const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration )
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).
Sets configuration parameters used for network requests sent by this job to requestConfiguration.
This function was introduced in Esri::ArcGISRuntime 100.1.
See also requestConfiguration().
[override virtual, deprecated] QJsonObject Job::unknownJson () const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: JsonSerializable::unknownJson() const.
Returns the unknown data from the source JSON.
Unknown JSON is a dictionary of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, all unknown JSON data is persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.
See also JsonSerializable.
[override virtual, deprecated] QJsonObject Job::unsupportedJson () const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: JsonSerializable::unsupportedJson() const.
Returns the unsupported data from the source JSON.
Unsupported JSON is a dictionary of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.
See also JsonSerializable.
[override virtual protected, deprecated] QUrl Job::url() const
This function is deprecated. We strongly advise against using it in new code.
Reimplements: RemoteResource::url() const.
Returns the URL to a tiled ArcGIS Map service.