Class ExportPDFParams

Parameters for exporting a source PDF file to a supported format using ExportPDFJob.

Implements

PDFServicesJobParams

Index

Constructors

Properties

_exportOcrLocale? _exportPDFTargetFormat

Accessors

exportOcrLocale exportPDFTargetFormat

Constructors

constructor

new ExportPDFParams(params): ExportPDFParams
Constructs a new ExportPDFParams instance.
Parameters
- params: {
  ocrLocale?: ExportOCRLocale;
  targetFormat: ExportPDFTargetFormat;
  }
  The parameters for constructing an instance of ExportPDFParams.
  - Optional ocrLocale?: ExportOCRLocale
    The OCR language to be used for exporting the source PDF file. Default value is EN_US.
  - targetFormat: ExportPDFTargetFormat
    The target format to which the source PDF file will be exported. Cannot be undefined.
Returns ExportPDFParams
- Defined in src/pdfjobs/params/exportpdf/ExportPDFParams.ts:32

Properties

`Private` `Optional` `Readonly` _exportOcrLocale

_exportOcrLocale?: ExportOCRLocale

`Private` `Readonly` _exportPDFTargetFormat

_exportPDFTargetFormat: ExportPDFTargetFormat

Accessors

exportOcrLocale

get exportOcrLocale(): undefined | ExportOCRLocale
Returns the OCR language to be used for exporting the source PDF file.

Returns undefined | ExportOCRLocale
The OCR language to be used for exporting the source PDF file.
- Defined in src/pdfjobs/params/exportpdf/ExportPDFParams.ts:52

exportPDFTargetFormat

get exportPDFTargetFormat(): ExportPDFTargetFormat
Returns the target format to which the source PDF file will be exported.

Returns ExportPDFTargetFormat
The target format to which the source PDF file will be exported.
- Defined in src/pdfjobs/params/exportpdf/ExportPDFParams.ts:43

Generated using TypeDoc