@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
38 lines (37 loc) • 1.75 kB
TypeScript
import { PDFServicesJobParams } from "../PDFServicesJobParams";
import { ExportPDFToImagesOutputType } from "./ExportPDFToImagesOutputType";
import { ExportPDFToImagesTargetFormat } from "./ExportPDFToImagesTargetFormat";
/**
* Parameters for exporting a source PDF file to images using {@link ExportPDFToImagesJob}.
*/
export declare class ExportPDFToImagesParams implements PDFServicesJobParams {
private readonly _exportPDFToImagesOutputType;
private readonly _exportPDFToImagesTargetFormat;
/**
* Constructs a new `ExportPDFToImagesParams` instance.
*
* @param params - The parameters for constructing an instance of `ExportPDFToImagesParams`.
* @param params.outputType - The output type for the exported images. If it is set to
* {@link ExportPDFToImagesOutputType#ZIP_OF_PAGE_IMAGES zip of page images} then the response will be provided
* as a zip response, otherwise if set as
* {@link ExportPDFToImagesOutputType#LIST_OF_PAGE_IMAGES list of page images} the response will be provided
* as list of images as specified in the targetFormat. Cannot be undefined.
* @param params.targetFormat - The target format for the exported images. Cannot be undefined.
*/
constructor(params: {
outputType: ExportPDFToImagesOutputType;
targetFormat: ExportPDFToImagesTargetFormat;
});
/**
* Returns the output type for the exported images.
*
* @returns The output type for the exported images.
*/
get outputType(): ExportPDFToImagesOutputType;
/**
* Returns the target format for the exported images.
*
* @returns The target format for the exported images.
*/
get targetFormat(): ExportPDFToImagesTargetFormat;
}