runConvertJob Method

Summary

Runs the conversion job.

Syntax
TypeScript
JavaScript
runConvertJob = function( 
   documentId, 
   jobData 
) 
static runConvertJob( 
   documentId: string, 
   jobData: DocumentConverterJobData 
): JQueryPromise<RunConvertJobResult>; 

Parameters

documentId

Input document ID. This must contain the ID of an existing document in the cache to act as the input (or source) document for the conversion.

jobData

Information and options for the job to run. This value must not be null.

Return Value

A Promise object that may resolve successfully to a RunConvertJobResult object containing the user and job tokens of the job.

Remarks

runConvertJob will perform the following:

  1. Runs the job specified in the StatusJobData object.

  2. Monitors and updates the status in the cache.

  3. Checks if the user aborts the job.

Example

For an example, refer to StatusJobDataRunner.

Requirements

Target Platforms

Help Version 20.0.2019.4.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly