PDFToolsSDK

This module is the single entry point for clients to interact with the PDF Tools SDK. This is the only file that a 3rd party app should require. All the necessary classes and modules required to perform operations via the SDK are exposed through this module.

Members

Credentials :Credentials

Reference to the Credentials class.

Type:

ClientConfig :ClientConfig

Reference to the ClientConfig class.

Type:

ExecutionContext :ExecutionContext

Reference to the ExecutionContext class.

Type:

FileRef :FileRef

Reference to the FileRef class.

Type:

CreatePDF :Object

Object containing references to classes required for creating a PDF.

Properties:
Name Type Description
Operation CreatePDFOperation

Reference to the operation class responsible for creating a PDF
SupportedMediaTypes CreatePDFOperation.SupportedMediaTypes

List of supported media types which can be converted to a PDF. Deprecated since version 1.1.0
SupportedSourceFormat CreatePDFOperation.SupportedSourceFormat

List of supported file formats which can be converted to a PDF
options Object

Contains references to configurable options of the operation

Properties
Name Type Description
html Object

Contains references to html file format specific configurable options

Properties
Name Type Description
CreatePDFFromHtmlOptions CreatePDFFromHtmlOptions

Reference to the configurable options class for converting an HTML web page/archive to PDF.
Type:
  • Object

ExportPDF :Object

Object containing references to classes required for exporting a PDF file.

Properties:
Name Type Description
Operation ExportPDFOperation

Reference to the operation class responsible for exporting a PDF file
SupportedTargetFormats ExportPDFOperation.SupportedExportFormats

Supported Target Formats to which a PDF file can be exported
SupportedSourceFormat ExportPDFOperation.SupportedSourceFormat

List of supported file formats which can be exported to other file formats
Type:
  • Object

CombineFiles :Object

Object containing references to classes required for combining multiple PDF files.

Properties:
Name Type Description
Operation CombineFilesOperation

Reference to the operation class responsible for combining multiple PDF files
SupportedSourceFormat CombineFilesOperation.SupportedSourceFormat

List of supported file formats which can be combined
Type:
  • Object

PageRanges :PageRanges

Reference to PageRanges class.

Type:

OCR :Object

Object containing references to classes required to perform OCR (Optical Character Recognition) operation on a PDF file.

Properties:
Name Type Description
Operation OCROperation

Reference to the operation class responsible to perform OCR (Optical Character Recognition) to convert a PDF file into a searchable PDF file
SupportedSourceFormat OCROperation.SupportedSourceFormat

List of supported file formats on which OCR can be performed
OCROptions OCROptions

Reference to the OCROptions class which provides parameters for converting a PDF to a searchable PDF using OCROperation.
OCRSupportedLocales OCROptions.OCRSupportedLocale

Supported locales for OCROperation
OCRSupportedType OCROptions.OCRSupportedType

Supported OCR types for OCROperation
Type:
  • Object

CompressPDF :Object

Object containing references to classes required to compress the PDF file.

Properties:
Name Type Description
Operation CompressPDFOperation

Reference to the operation class responsible to reduce the PDF file.
SupportedSourceFormat CompressPDFOperation.SupportedSourceFormat

List of supported file format which can be compressed
Type:
  • Object

LinearizePDF :Object

Object containing references to classes required to optimise the PDF for Fast Web View.

Properties:
Name Type Description
Operation LinearizePDFOperation

Reference to the operation class responsible to linearize the input PDF file.
SupportedSourceFormat LinearizePDFOperation.SupportedSourceFormat

List of supported file formats which can be linearized for fast Web View
Type:
  • Object

ProtectPDF :Object

Object containing references to classes required to protect a PDF file with permissions.

Properties:
Name Type Description
Operation ProtectPDFOperation

Reference to the operation class responsible to protect a PDF file.
SupportedSourceFormat ProtectPDFOperation.SupportedSourceFormat

List of supported file formats which can be protected with permissions
options Object

Contains references to configurable options of the operation

Properties
Name Type Description
PasswordProtectOptions PasswordProtectOptions

Reference to the configurable options class which specifies the parameters required to protect a PDF file with permissions.
Type:
  • Object

RotatePages :Object

Object containing references to classes required to rotate specific pages in a PDF file.

Properties:
Name Type Description
Operation RotatePagesOperation

Reference to the operation class responsible for rotating multiple pages in a PDF file
SupportedSourceFormat RotatePagesOperation.SupportedSourceFormat

List of supported file formats for Rotate Pages Operation
Angle RotatePagesOperation.Angle

Angle for rotation for RotatePagesOperation
Type:
  • Object

DeletePages :Object

Object containing references to classes required for deleting a range, subset of pages in a PDF file.

Properties:
Name Type Description
Operation DeletePagesOperation

Reference to the operation class responsible for deleting multiple pages in a PDF file
SupportedSourceFormat DeletePagesOperation.SupportedSourceFormat

List of supported file formats for Delete Pages Operation
Type:
  • Object

ReorderPages :Object

Object containing references to classes required for reordering of pages in a PDF file.

Properties:
Name Type Description
Operation ReorderPagesOperation

Reference to the operation class responsible for reordering pages in a PDF file
SupportedSourceFormat ReorderPagesOperation.SupportedSourceFormat

List of supported file formats for Reorder Pages Operation
Type:
  • Object

InsertPages :Object

Object containing references to classes required for inserting specific pages of multiple PDF files into a single PDF file.

Properties:
Name Type Description
Operation InsertPagesOperation

Reference to the operation class responsible for insertion of specific pages of multiple PDF files into a single PDF file
SupportedSourceFormat InsertPagesOperation.SupportedSourceFormat

List of supported file formats for Insert Pages Operation
Type:
  • Object

ReplacePages :Object

Object containing references to classes required for replacement of specific pages in a PDF file with pages from multiple PDF files.

Properties:
Name Type Description
Operation ReplacePagesOperation

Reference to the operation class responsible for replacing specific pages of a PDF file with pages from multiple PDF files
SupportedSourceFormat ReplacePagesOperation.SupportedSourceFormat

List of supported file formats for Replace Pages Operation
Type:
  • Object

Error :Object

Object containing references to error classes of PDFToolsSDK.

Properties:
Name Type Description
ServiceApiError ServiceApiError

Reference to the ServiceApiError which represents the category of errors which are thrown when an underlying service API call results in an error.
ServiceUsageError ServiceUsageError

Reference to the ServiceApiError which represents the category of errors which are thrown when either service usage limit has been reached or credentials quota has been exhausted.
Type:
  • Object