This module is the single entry point for clients to interact with the PDF Tools Extract 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:
ExtractPDF :Object
Object containing references to classes required for extracting a PDF.
Properties:
| Name | Type | Description |
|---|---|---|
Operation |
ExtractPDFOperation | Reference to the operation class responsible for extracting a PDF |
SupportedSourceFormat |
ExtractPDFOperation.SupportedSourceFormat | Supported file formats whose elements can be extracted. |
Type:
- Object
PDFElementType :Object
Object containing supported PDF Element Types for extraction.
Properties:
| Name | Type | Description |
|---|---|---|
Text |
PDFElementType.TEXT | Textual Data |
Tables |
PDFElementType.TABLES | Tabular Data |
Figures |
PDFElementType.FIGURES | Image Data |
Type:
- Object
TableStructureType :Object
Object containing supported Table Structure Types for extraction.
Properties:
| Name | Type | Description |
|---|---|---|
CSV |
TableStructureType.CSV | Table data exported as CSV Data |
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