Class ExportPDFToImagesParams

Parameters for exporting a source PDF file to images using ExportPDFToImagesJob.

Implements

PDFServicesJobParams

Index

Constructors

Properties

_exportPDFToImagesOutputType _exportPDFToImagesTargetFormat

Accessors

outputType targetFormat

Constructors

constructor

new ExportPDFToImagesParams(params): ExportPDFToImagesParams
Constructs a new ExportPDFToImagesParams instance.
Parameters
- params: {
  outputType: ExportPDFToImagesOutputType;
  targetFormat: ExportPDFToImagesTargetFormat;
  }
  The parameters for constructing an instance of ExportPDFToImagesParams.
  - outputType: ExportPDFToImagesOutputType
    The output type for the exported images. If it is set to zip of page images then the response will be provided as a zip response, otherwise if set as list of page images the response will be provided as list of images as specified in the targetFormat. Cannot be undefined.
  - targetFormat: ExportPDFToImagesTargetFormat
    The target format for the exported images. Cannot be undefined.
Returns ExportPDFToImagesParams
- Defined in src/pdfjobs/params/exportpdftoimages/ExportPDFToImagesParams.ts:35

Properties

`Private` `Readonly` _exportPDFToImagesOutputType

_exportPDFToImagesOutputType: ExportPDFToImagesOutputType

`Private` `Readonly` _exportPDFToImagesTargetFormat

_exportPDFToImagesTargetFormat: ExportPDFToImagesTargetFormat

Accessors

outputType

get outputType(): ExportPDFToImagesOutputType
Returns the output type for the exported images.

Returns ExportPDFToImagesOutputType
The output type for the exported images.
- Defined in src/pdfjobs/params/exportpdftoimages/ExportPDFToImagesParams.ts:46

targetFormat

get targetFormat(): ExportPDFToImagesTargetFormat
Returns the target format for the exported images.

Returns ExportPDFToImagesTargetFormat
The target format for the exported images.
- Defined in src/pdfjobs/params/exportpdftoimages/ExportPDFToImagesParams.ts:55

Generated using TypeDoc