Namespace Adobe.PDFServicesSDK.pdfjobs.jobs

Classes

AutotagPDFJob

A job that creates PDF documents with enhanced readability from existing PDF documents. An optional tagging report can also be generated which contains the information about the tags that the tagged output PDF document contains. Accessibility tags, used by assistive technology such as screen reader are required to make PDF files compliant. However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as there could be a need to perform further downstream remediation to meet those standards.

CombinePDFJob

A job that combines multiple PDF files into a single PDF file. Allows specifying which pages of the source files to combine.

CompressPDFJob

A job that reduces the size of a PDF file. Allows specifying CompressionLevel for compressing PDF

CreatePDFJob

A job that converts a non-PDF file to a PDF file. Some source formats may have associated conversion parameters which can be set using the CreatePDFParams.

DeletePagesJob

A job that deletes pages from a PDF file.

DocumentMergeJob

A job that enables the clients to produce high fidelity PDF and Word documents with dynamic data inputs. This operation merges the JSON data with the Word template to create dynamic documents for contracts and agreements, invoices, proposals, reports, forms, branded marketing documents and more.

To know more about document generation and document templates, please see the documentation

ExportPDFFormDataJob

A job that exports form data from a PDF and retrieves it in JSON format.

ExportPDFJob

A job which exports a source PDF file to a supported format specified by ExportPDFTargetFormat.

For example, a PDF can be exported to a DOCX file as follows:

ExportPDFToImagesJob

A job which exports a source PDF file to a supported format specified by ExportPDFToImagesTargetFormat.

The result is a list of images or a list containing a zip of images. For example, a PDF file with 15 pages will generate 15 image files. The first file's name ends with "_0" and the last file's name ends with "_14".

ExtractPDFJob

A job that extracts PDF elements such as text, images, tables in a structured format from a PDF.

HTMLToPDFJob

A job that converts a HTML file to a PDF file. Some source formats may have associated conversion parameters which can be set using the {@link HTMLToPDFParams} parameter.

An HTML input can be provided either as a local zip archive or as a static HTML file with inline CSS. Alternatively, an HTML can also be specified via URL.

While creating the corresponding Asset instance, the media type must be:

"application/zip", if the input is a local zip archive.
"text/html", if the input is a static HTML file with inline CSS

In case the input is a local zip archive, it must have the following structure:

The main HTML file must be named "index.html".
"index.html" must exist at the top level of zip archive, not in a folder.

Sample layout:

    html_files.zip
    |__index.html
    |__referenced_file_1.css
    |__referenced_file_2.jpeg
    |__subfolder_1
    |_____referenced_file_3.jpeg

ImportPDFFormDataJob

A job that exports form data from a PDF and retrieves it in JSON format.

InsertPagesPDFJob

A job that can be used to insert pages of multiple PDF files into a base PDF file.

For more complex use cases, refer the CombinePDFJob.

LinearizePDFJob

A job that converts a PDF file into a linearized (also known as "web optimized") PDF file. Such PDF files are optimized for incremental access in network environments.

OCRJob

A job that convert a PDF file into a searchable PDF file. Allows specifying locale( OCRSupportedLocale) and OCR Type (OCRSupportedType) for performing OCR (Optical Character Recognition)

PDFAccessibilityCheckerJob

A job that that will check PDF file to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks.

PDFElectronicSealJob

A job that allows clients to apply an electronic seal onto various PDF documents such as agreements, invoices, and more.

To know more about PDF Electronic Seal, please see the documentation.

PDFPropertiesJob

A job that is used to fetch properties from an input PDF file. The properties are returned in a POJO.

PDFServicesJob

This abstract class represents the basic contract for all the PDF Services Jobs. It imposes no restrictions or particular details on the job execution process and leaves the specifics of setting up the jobs to their individual implementations.

PDFWatermarkJob

A job that applies a watermark to a PDF using the input and watermark assets.

ProtectPDFJob

A job that is used for securing PDF document 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.

The supported algorithm for encrypting the PDF document are listed here. The {@link EncryptionAlgorithm} enum can be used to set the encryption algorithm.

AES-128
AES-256

For AES-128 encryption the password supports LATIN-I characters only. For AES-256 encryption the password supports Unicode character set.