Job Class

  • Job
  • class Esri::ArcGISRuntime::Job

    A base class for classes representing a long running job on a server. More...

    This class was introduced in Esri::ArcGISRuntime 100.0.

    Public Functions

    virtual ~Job() override
    bool cancel()
    Esri::ArcGISRuntime::TaskWatcher checkStatus()
    Esri::ArcGISRuntime::Error error() const
    Esri::ArcGISRuntime::JobStatus jobStatus() const
    Esri::ArcGISRuntime::JobType jobType() const
    QList<Esri::ArcGISRuntime::JobMessage> messages() const
    bool pause()
    int progress() const
    QString serverJobId() const
    bool start()

    Reimplemented Public Functions

    virtual Esri::ArcGISRuntime::Credential *credential() const override
    virtual Esri::ArcGISRuntime::RequestConfiguration requestConfiguration() const override
    virtual void setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override
    virtual QString toJson() const override
    virtual QJsonObject unknownJson() const override
    virtual QJsonObject unsupportedJson() const override


    void checkStatusCompleted(QUuid taskId, bool succeeded)
    void jobDone()
    void jobStatusChanged()
    void messagesChanged()
    void progressChanged()

    Static Public Members

    Esri::ArcGISRuntime::Job *fromJson(const QString &json, QObject *parent = nullptr)

    Reimplemented Protected Functions

    virtual QUrl url() const override

    Detailed Description

    A job is a long running operation that is completed by an ArcGIS Server asynchronous service operation. They are submitted to an ArcGIS Server end point, they have regular status updates as the job is completed and a result is then returned. Different types of jobs exist and each can have different stages.

    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. This ID is available in the serverJobId property.

    Job instances created by tasks and returned by task methods are returned in a JobStatus::NotStarted state. For these, call start to start the associated operation.

    After the job is initiated on the server and started, the client listens for the jobDone signal to know when the job is done. While the job is not yet done, the client may listen for the jobStatusChanged signal and examine the jobStatus or progress methods to monitor progress.

    Classes that inherit from this class may implement a property containing the job's results, whose type depends on the type of job.

    If the job fails, information about the failure is available in the error property.

    See also JobStatus.

    Member Function Documentation

    [signal] void Job::checkStatusCompleted(QUuid taskId, bool succeeded)

    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.

    [signal] void Job::jobDone()

    Signal emitted when this Job is done.

    [signal] void Job::jobStatusChanged()

    Signal emitted when the jobStatus property changed.

    [signal] void Job::messagesChanged()

    Signal emitted when the messages for the job change.

    This function was introduced in Esri::ArcGISRuntime 100.11.

    [signal] void Job::progressChanged()

    Signal emitted when the progress complete changes.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] Job::~Job()


    bool Job::cancel()

    Pause this Job.

    Returns true if the job was successfully cancelled; false if it is already done, or if there is an error.

    Esri::ArcGISRuntime::TaskWatcher Job::checkStatus()

    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.

    [override virtual] Esri::ArcGISRuntime::Credential *Job::credential() const

    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.

    Esri::ArcGISRuntime::Error Job::error() const

    Gets the error encountered during execution, if any.

    Returns the Error.

    [static] Esri::ArcGISRuntime::Job *Job::fromJson(const QString &json, QObject *parent = nullptr)

    Creates and returns a new Job object from the provided json, with an optional parent.

    The Job will be in a paused state.

    See also JsonSerializable.

    Esri::ArcGISRuntime::JobStatus Job::jobStatus() const

    Gets the current status of this Job.

    Esri::ArcGISRuntime::JobType Job::jobType() const

    Returns the type of this Job.

    QList<Esri::ArcGISRuntime::JobMessage> Job::messages() const

    Gets the informational messages produced during execution of this job.

    Returns the list of JobMessage objects.

    bool Job::pause()

    Pause this Job.

    Returns true if the job was successfully paused; false if it is already done, or if there is an error.

    int Job::progress() const

    Gets the current progress of the job as the percentage complete.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [override virtual] Esri::ArcGISRuntime::RequestConfiguration Job::requestConfiguration() const

    Reimplements: RemoteResource::requestConfiguration() const.

    Returns the RequestConfiguration in use by this job.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    See also setRequestConfiguration().

    QString Job::serverJobId() const

    Gets the unique job ID of this Job on the server on which it is executing.

    [override virtual] void Job::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

    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().

    bool Job::start()

    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.

    [override virtual] QString Job::toJson() const

    Reimplements: JsonSerializable::toJson() const.

    Returns this job as a JSON representation.

    See also JsonSerializable.

    [override virtual] QJsonObject Job::unknownJson() const

    Reimplements: JsonSerializable::unknownJson() const.

    Gets the unknown JSON of this object.

    See also JsonSerializable.

    [override virtual] QJsonObject Job::unsupportedJson() const

    Reimplements: JsonSerializable::unsupportedJson() const.

    Gets the unsupported JSON of this object.

    See also JsonSerializable.

    [override virtual protected] QUrl Job::url() const

    Reimplements: RemoteResource::url() const.

    Returns the URL to a tiled ArcGIS Map service.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.