PDFServicesSDK

This module is the single entry point for clients to interact with the PDF Services 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.

Description:

  • This module is the single entry point for clients to interact with the PDF Services 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:

Region :Region

Object containing the list of supported regions.

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.
word Object

Contains references to word file format specific configurable options

Properties
Name Type Description
CreatePDFFromWordOptions CreatePDFFromWordOptions

Reference to the configurable options class for converting a word file (.doc,.docx, .rtf, .txt) to PDF.
SupportedDocumentLanguage CreatePDFFromWordOptions.SupportedDocumentLanguage

Supported languages for word file conversion.
excel Object

Contains references to excel file format specific configurable options

Properties
Name Type Description
CreatePDFFromExcelOptions CreatePDFFromExcelOptions

Reference to the configurable options class for converting a excel file (.xls, .xlsx) to PDF.
SupportedDocumentLanguage CreatePDFFromExcelOptions.SupportedDocumentLanguage

Supported languages for excel file conversion.
ppt Object

Contains references to ppt file format specific configurable options

Properties
Name Type Description
CreatePDFFromPPTOptions CreatePDFFromPPTOptions

Reference to the configurable options class for converting a ppt file (.ppt, .pptx) to PDF.
SupportedDocumentLanguage CreatePDFFromPPTOptions.SupportedDocumentLanguage

Supported languages for ppt file conversion.
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
ExportPDFOptions ExportPDFOptions

Reference to the ExportPDFOptions class which provides parameters for ExportPDFOperation.
OCRSupportedLocales ExportPDFOptions.OCRSupportedLocale

Supported OCR locales for ExportPDFOperation
Type:
  • Object

ExportPDFToImages :Object

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

Properties:
Name Type Description
Operation ExportPDFToImagesOperation

Reference to the operation class responsible for exporting a PDF file to a list of images
SupportedExportFormats ExportPDFToImagesOperation.SupportedExportFormats

Supported Export Formats to which a PDF file can be exported as a list of images
SupportedSourceFormat ExportPDFToImagesOperation.SupportedSourceFormat

List of supported file formats which can be exported to image formats
OutputType ExportPDFToImagesOperation.OutputType

List of supported output types for ExportPDFToImagesOperation
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
CompressPDFOptions CompressPDFOptions

Reference to the CompressPDFOptions class which provides parameters for reducing file size of a PDF using CompressPDFOperation.
CompressionLevel CompressPDFOptions.CompressionLevel

Supported compression levels for CompressPDFOperation
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 password(s). The password(s) is used for encrypting the PDF document and setting the restriction on certain features like printing, editing and copying in the PDF document.

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
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
Permissions Permissions

Reference to the Permissions class which specifies the set of document access permission
Type:
  • Object

ExtractPDF :Object

Object containing references to classes required for extracting a PDF.

Properties:
Name Type Description
options Object

Contains references to configurable options of the operation

Properties
Name Type Description
ExtractPdfOptions ExtractPdfOptions

Reference to the configurable options class
Operation ExtractPDFOperation

Reference to the operation class responsible to extract a PDF
options.ExtractPDFOperation ExtractPDFOperation

Reference to the operation class responsible for extracting a PDF
SupportedSourceFormat ExtractPDFOperation.SupportedSourceFormat

Supported file formats whose elements can be extracted.
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

RemoveProtection :Object

Object containing references to classes required for removal of password security from a PDF file.

Properties:
Name Type Description
Operation RemoveProtectionOperation

Reference to the operation class responsible for removing password security from a PDF file
SupportedSourceFormat RemoveProtectionOperation.SupportedSourceFormat

List of supported file formats for Remove Protection Operation
Type:
  • Object

SplitPDF :Object

Object containing references to classes required for splitting a PDF document into multiple smaller documents by simply specifying either the number of files, pages per file, or page ranges.

Properties:
Name Type Description
Operation SplitPDFOperation

Reference to the operation class responsible for splitting a PDF file into multiple PDF files
SupportedSourceFormat SplitPDFOperation.SupportedSourceFormat

List of supported file formats for Split PDF Operation
Type:
  • Object

AutotagPDF :Object

Object containing references to classes required for creating PDF documents with enhanced readability from existing PDF documents.

Properties:
Name Type Description
Operation AutotagPDFOperation

Reference to the operation class required for creating PDF documents with enhanced readability from existing PDF documents.
options AutotagPDFOptions

Reference to the AutotagPDFOptions class which provides parameters for creating a tagged PDF using AutotagPDFOperation.
SupportedSourceFormat AutotagPDFOperation.SupportedSourceFormat

List of supported file formats for AutotagPDFOperation.
AutotagPDFOutput AutotagPDFOutput

Reference to the AutotagPDFOutput class which represents output of AutotagPDFOperation.
Type:
  • Object

DocumentMerge :Object

Object containing references to classes required for merging MS Word based document templates with the JSON data to generate output documents in the specified format.

Properties:
Name Type Description
Operation DocumentMergeOperation

Reference to the operation class responsible for merging MS Word based document templates with the JSON data to generate output documents in the specified format.
SupportedSourceFormat DocumentMergeOperation.SupportedSourceFormat

List of supported file formats for Document Merge Operation
options Object

Contains references to configurable options of the operation

Properties
Name Type Description
DocumentMergeOptions DocumentMergeOptions

Reference to the configurable options class which specifies the parameters required for merging MS Word based document templates with the JSON data to generate output documents in the specified format
Type:
  • Object

PDFProperties :Object

Object containing references to classes required for fetching the properties of a PDF File.

Properties:
Name Type Description
Operation PDFPropertiesOperation

Reference to the operation class responsible for fetching properties of a PDF file.
options Object

Contains references to configurable options of the operation

Properties
Name Type Description
PDFPropertiesOptions PDFPropertiesOptions

Reference to the configurable options class which specifies the parameters for PDFPropertiesOperation.
Properties PDFProperties

Reference to the PDFProperties class which specifies the metadata of the specified PDF file.
Type:
  • Object

Error :Object

Object containing references to error classes of PDFServicesSDK.

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

Fragments :Fragments

Reference to Fragments class.

Type: