DCServicesSDK

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

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

Error :Object

Object containing references to error classes of DCServicesSDK.

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