ExportPDFOperation

An operation which exports a source PDF file to a supported format specified by ExportPDFOperation.SupportedExportFormats.

Sample Usage:


 const credentials = PDFServicesSdk.Credentials.servicePrincipalCredentialsBuilder()
           .withClientId("PDF_SERVICES_CLIENT_ID")
           .withClientSecret("PDF_SERVICES_CLIENT_SECRET")
           .build(),
       executionContext = PDFServicesSdk.ExecutionContext.create(credentials),
       ExportPDF = PDFServicesSdk.ExportPDF,
       exportPdfOperation = ExportPDF.Operation.createNew(ExportPDF.SupportedTargetFormats.DOCX),
       input = PDFServicesSdk.FileRef.createFromLocalFile('PDF.pdf', ExportPDF.SupportedSourceFormat.pdf);

 exportPdfOperation.setInput(input);

 exportPdfOperation.execute(executionContext)
     .then(result => result.saveAsFile('exportPdf.docx'))
     .catch(err => console.log(err));

Members

(static, constant) SupportedSourceFormat

Description:

Supported source file formats for ExportPDFOperation.

Properties:

Name	Type	Description
`pdf`	string	Represents "application/pdf" media type

Supported source file formats for ExportPDFOperation.

(static, constant) SupportedExportFormats

Description:

List of target formats for ExportPDFOperation.

Properties:

Name	Type	Description
`DOC`	Object	Represents "application/msword" media type.
`DOCX`	Object	Represents "application/vnd.openxmlformats-officedocument.wordprocessingml.document" media type
`PPTX`	Object	Represents "application/vnd.openxmlformats-officedocument.presentationml.presentation" media type
`RTF`	Object	Represents "text/rtf" media type.
`XLSX`	Object	Represents "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" media type

List of target formats for ExportPDFOperation.

Methods

(static) createNew(targetFormatnon-null) → {ExportPDFOperation}

Description:

Constructs an ExportPDFOperation instance.

Parameters:

Name	Type	Description
`targetFormat`	ExportPDFOperation.SupportedExportFormats	Format to which the PDF will be exported to.

Returns:

A new ExportPDFOperation instance

Type: ExportPDFOperation

setInput(sourceFileRefnon-null)

Description:

Sets an input PDF file (media type "application/pdf").

Parameters:

Name	Type	Description
`sourceFileRef`	FileRef	An input PDF file.

setOptions(optionsopt)

Description:

Sets the options for this operation. See ExportPDFOptions for how to specify the options for the different locales.

Parameters:

Name	Type	Attributes	Description
`options`	ExportPDFOptions	<optional>	optional parameters.

execute(contextnon-null) → {Promise.<FileRef>}

Description:

Executes this operation using the supplied context and returns a Promise which resolves to the operation result.

The resulting file may be stored in the system temporary directory (per the os.tempdir(), symlinks are resolved to the actual path). See FileRef for how temporary resources are cleaned up.

Parameters:

Name	Type	Description
`context`	ExecutionContext	The context in which the operation will be executed.

Throws:

if an API call results in an error response.

Type

ServiceApiError
if service usage limits have been reached or credentials quota has been exhausted.

Type

ServiceUsageError

Returns:

A promise which resolves to the operation result.

Type: Promise.<FileRef>