Obsolete Members for Job

Job

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

Signals

Member Function Documentation

[since Esri::ArcGISRuntime 100.14] 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:

• ExportTileCacheJob
• ExportVectorTilesJob
• GenerateGeodatabaseJob
• GeoprocessingJob

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] 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] 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] 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.