DeletePagesOperation

An operation to delete pages in a PDF file.

Sample Usage:


 const credentials = PDFToolsSdk.Credentials.serviceAccountCredentialsBuilder()
           .fromFile("pdftools-api-credentials.json")
           .build(),
       executionContext = PDFToolsSdk.ExecutionContext.create(credentials),
       DeletePages = PDFToolsSdk.DeletePages,
       deletePagesOperation = DeletePages.Operation.createNew(),
       pageRanges = new PDFToolsSdk.PageRanges();

 deletePagesOperation.setInput( PDFToolsSdk.FileRef.createFromLocalFile('~/Documents/deletePagesOperationInput.pdf',
 	DeletePages.SupportedSourceFormat.pdf));
 pageRanges.addSinglePage(1);
 deletePagesOperation.setPageRanges(pageRanges);

 deletePagesOperation.execute(executionContext)
     .then(result => result.saveAsFile('output/deletePagesOperationOutput.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 DeletePagesOperation.

Methods

(static) createNew() → {DeletePagesOperation}

Constructs a DeletePagesOperation instance.

Returns:

A new DeletePagesOperation instance.

Type: DeletePagesOperation

setInput(sourceFileRefnon-null)

Sets an input file.

Parameters:

Name	Type	Description
`sourceFileRef`	FileRef	An input file.

setPageRanges(pageRangesnon-null)

Specifies the pages to delete from the input PDF file.

Parameters:

Name	Type	Description
`pageRanges`	PageRanges	Page ranges for deletion.

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>