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

Inheritance

System.Object

PDFServicesJob

PDFAccessibilityCheckerJob

Namespace: Adobe.PDFServicesSDK.pdfjobs.jobs

Assembly: Adobe.PDFServicesSDK.Doc.dll

Syntax

public class PDFAccessibilityCheckerJob : PDFServicesJob

Examples

Sample Usage:

    using Stream inputStream = File.OpenRead("<SOURCE_PATH>");

    ICredentials credentials = new ServicePrincipalCredentials(
        Environment.GetEnvironmentVariable("PDF_SERVICES_CLIENT_ID"),
        Environment.GetEnvironmentVariable("PDF_SERVICES_CLIENT_SECRET"));

    PDFServices pdfServices = new PDFServices(credentials);

    IAsset inputDocumentAsset =
        pdfServices.Upload(inputStream, PDFServicesMediaType.PDF.GetMIMETypeValue());

    PDFAccessibilityCheckerParams pdfAccessibilityCheckerParams = PDFAccessibilityCheckerParams
        .PDFAccessibilityCheckerParamsBuilder()
        .WithPageStart(1)
        .WithPageEnd(3)
        .Build();

    PDFAccessibilityCheckerJob pdfAccessibilityCheckerJob =
    new PDFAccessibilityCheckerJob(inputDocumentAsset).SetParams(pdfAccessibilityCheckerParams);

    string location = pdfServices.Submit(pdfAccessibilityCheckerJob);
    PDFServicesResponse<PDFAccessibilityCheckerResult> pdfServicesResponse =
        pdfServices.GetJobResult<PDFAccessibilityCheckerResult>(location,
            typeof(PDFAccessibilityCheckerResult));

    IAsset outputAsset = pdfServicesResponse.Result.Asset;
    StreamAsset streamAsset = pdfServices.GetContent(outputAsset);
    IAsset outputReportAsset = pdfServicesResponse.Result.Report;
    StreamAsset streamReportAsset = pdfServices.GetContent(outputReportAsset);

Constructors

PDFAccessibilityCheckerJob(IAsset)

Constructs a new PDFAccessibilityCheckerJob instance.

Declaration

public PDFAccessibilityCheckerJob(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	The input IAsset for the job; can not be null.

Methods

SetOutput(IAsset)

Sets the output asset for the job.

Declaration

public PDFAccessibilityCheckerJob SetOutput(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	IAsset object representing the output asset; can not be null.

Returns

Type	Description
PDFAccessibilityCheckerJob	PDFAccessibilityCheckerJob instance

Remarks

External assets can be set as output only when input is external asset as well

SetParams(PDFAccessibilityCheckerParams)

Sets the params for the job.

Declaration

public PDFAccessibilityCheckerJob SetParams(PDFAccessibilityCheckerParams pdfAccessibilityCheckerParams)

Parameters

Type	Name	Description
PDFAccessibilityCheckerParams	pdfAccessibilityCheckerParams	PDFAccessibilityCheckerParams for the job.

Returns

Type	Description
PDFAccessibilityCheckerJob	PDFAccessibilityCheckerJob instance