In This Topic ▼

abortConvertJob Method

Summary

Aborts the specified job.

Syntax

TypeScript

JavaScript

abortConvertJob = function( 
   userToken, 
   jobToken 
)

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

Parameters

userToken

Value indicating the user token of the job.

jobToken

Value indicating the token of the job.

Return Value

A Promise object that may resolve successfully.

Remarks

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

After a job was aborted, the next call to queryConvertJobStatus will return a StatusJobData with the value of StatusJobData.jobStatus set to aborted.

Example

For an example, refer to StatusJobDataRunner.

Requirements

Target Platforms