CompressPDFOperation

CompressPDFOperation

An operation that reduces the size of a PDF file.

Sample Usage:


 const credentials = PDFToolsSdk.Credentials.serviceAccountCredentialsBuilder()
           .fromFile("pdftools-api-credentials.json")
           .build(),
       executionContext = PDFToolsSdk.ExecutionContext.create(credentials),
       CompressPDF = PDFToolsSdk.CompressPDF,
       compressPdfOperation = CompressPDF.Operation.createNew(),
       input = PDFToolsSdk.FileRef.createFromLocalFile('test/resources/compressInput.pdf', CompressPDF.SupportedSourceFormat.pdf);

 compressPdfOperation.setInput(input);

 compressPdfOperation.execute(executionContext)
     .then(result => result.saveAsFile('output/compressOutput.pdf'))
     .catch(err => console.log(err));

Members

(static, constant) SupportedSourceFormat

Properties:
Name Type Description
pdf string

Represents "application/pdf" media type

Supported source file formats for CompressPDFOperation.

Methods

(static) createNew() → {CompressPDFOperation}

Constructs a CompressPDFOperation instance.

Returns:

A new CompressPDFOperation instance.

Type
CompressPDFOperation

setInput(sourceFileRefnon-null)

Sets an input file.

Parameters:
Name Type Description
sourceFileRef FileRef

An input file.

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

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>