In This Topic ▼

queryCompareJobStatus Method

Summary

Retrieves the status of the specified job.

Syntax

TypeScript

JavaScript

queryCompareJobStatus = function( 
   userToken, 
   jobToken 
)

static queryCompareJobStatus( 
   userToken: string, 
   jobToken: string 
): JQueryPromise<CompareJobData>;

Parameters

userToken

Value indicating the user token of the job.

jobToken

Value indicating the job token of the job.

Return Value

A Promise object that may resolve successfully to one of the following: A CompareJobData object containing the last status of this job if found; or null if no such job was found.

Remarks

queryCompareJobStatus is the main method of communication between the application and the runner to obtain the status of the job. The CompareJobData returned from this method contains a clone of the object found in the cache and can be changed or stored by the application.

Requirements

Target Platforms