In This Topic ▼

abortCompareJob Method

Summary

Aborts the specified compare job.

Syntax

TypeScript

JavaScript

abortCompareJob = function( 
   userToken, 
   jobToken 
)

static abortCompareJob( 
   userToken: string, 
   jobToken: string 
): JQueryPromise<void>;

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.

Remarks

abortCompareJob can be called at any time to abort the running job with the specified user and job tokens. If no such job was found, then this method will return.

After a job was aborted, the next call to queryCompareJobStatus will return a CompareJobData with the value of compareJobData.jobStatus set to Aborted.

Requirements

Target Platforms