@adobe/pdfservices-node-sdk/lib/pdfjobs/jobs/PDFAccessibilityCheckerJob.d.ts

The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.

import { Asset } from "../../io/Asset";
import { PDFServicesJob } from "./PDFServicesJob";
import { ExecutionContext } from "../../internal/ExecutionContext";
import { NotifierConfig } from "../../config/notifier/NotifierConfig";
import { PDFAccessibilityCheckerParams } from "../params/pdfaccessibilitychecker/PDFAccessibilityCheckerParams";
/**
 * 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.
 *
 * @example
 * Sample Usage:
 * ```js
 *         const readStream = fs.createReadStream("<SOURCE_PATH>");
 *
 *         const credentials = new ServicePrincipalCredentials({
 *             clientId: process.env.PDF_SERVICES_CLIENT_ID,
 *             clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
 *         });
 *
 *         const pdfServices = new PDFServices({credentials});
 *
 *         const inputAsset = await pdfServices.upload({
 *             readStream,
 *             mimeType: MimeType.PDF
 *         });
 *
 *         const params = new PDFAccessibilityCheckerParams({pageStart:1, pageEnd:3});
 *
 *         const job = new PDFAccessibilityCheckerJob({inputAsset, params});
 *
 *         const pollingURL = await pdfServices.submit({job});
 *
 *         const pdfServicesResponse = await pdfServices.getJobResult({
 *             pollingURL,
 *             resultType: PDFAccessibilityCheckerResult
 *         });
 *
 *         const resultAsset = pdfServicesResponse.result.asset;
 *         const streamAsset = await pdfServices.getContent({asset: resultAsset});
 *
 *         const resultAssetReport = pdfServicesResponse.result.report;
 *         const streamAssetReport = await pdfServices.getContent({asset: resultAssetReport});
 * ```
 */
export declare class PDFAccessibilityCheckerJob extends PDFServicesJob {
    private readonly _inputAsset;
    private readonly _params?;
    private readonly _outputAsset?;
    /**
     * Constructs a new `PDFAccessibilityCheckerJob` instance.
     *
     * @param params The parameters for constructing an instance of `PDFAccessibilityCheckerJob`.
     * @param params.inputAsset The input asset for the job. Cannot be undefined.
     * @param [params.params] {@link PDFAccessibilityCheckerParams} object containing the parameters for PDF Accessibility Checker Operation.
     * @param [params.outputAsset] {@link Asset} object representing the output asset.
     * @remarks External assets can be set as output only when input is external asset as well.
     */
    constructor(params: {
        inputAsset: Asset;
        params?: PDFAccessibilityCheckerParams;
        outputAsset?: Asset;
    });
    /**
     * @hidden
     */
    process(executionContext: ExecutionContext, notifierConfigList?: NotifierConfig[]): Promise<string>;
    private generatePDFServicesAPIRequest;
}