A job which exports a source PDF file to a supported format specified by ExportPDFTargetFormat.

For example, a PDF can be exported to a DOCX file as follows:

Example

Sample Usage:

        const readStream = fs.createReadStream("<SOURCE_PATH>");

const credentials = new ServicePrincipalCredentials({
clientId: process.env.PDF_SERVICES_CLIENT_ID,
clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
});

const pdfServices = new PDFServices({credentials});

// Creates an asset(s) from source file(s) and upload
const inputAsset = await pdfServices.upload({
readStream,
mimeType: MimeType.PDF
});

const params = new ExportPDFParams({
targetFormat: ExportPDFTargetFormat.DOCX
});

const job = new ExportPDFJob({inputAsset, params});

const pollingURL = await pdfServices.submit({job});

const pdfServicesResponse = await pdfServices.getJobResult({
pollingURL,
resultType: ExportPDFResult
});

const resultAsset = pdfServicesResponse.result.asset;
const streamAsset = await pdfServices.getContent({asset: resultAsset});

Hierarchy (view full)

Constructors

  • Constructs a new ExportPDFJob instance.

    Parameters

    • params: {
          inputAsset: Asset;
          outputAsset?: Asset;
          params: ExportPDFParams;
      }

      The parameters for constructing an instance of ExportPDFJob.

      • inputAsset: Asset

        Asset object containing the input file. Cannot be undefined.

      • Optional outputAsset?: Asset

        Asset object representing the output asset.

      • params: ExportPDFParams

        ExportPDFParams object containing the export parameters. Cannot be undefined.

    Returns ExportPDFJob

    Remarks

    External assets can be set as output only when input is external asset as well.

Properties

_exportPDFParams: ExportPDFParams
_inputAsset: Asset
_outputAsset?: Asset

Methods

  • Parameters

    Returns PDFServicesApiRequest

  • Parameters

    • executionContext: ExecutionContext

    Returns void

Generated using TypeDoc