@adobe/pdfservices-node-sdk/lib/pdfjobs/params/autotagpdf/AutotagPDFParams.js

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

"use strict";
/*
 * Copyright 2024 Adobe
 * All Rights Reserved.
 *
 * NOTICE: Adobe permits you to use, modify, and distribute this file in
 * accordance with the terms of the Adobe license agreement accompanying
 * it. If you have received this file from a source other than Adobe,
 * then your use, modification, or distribution of it requires the prior
 * written permission of Adobe.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.AutotagPDFParams = void 0;
const ValidationUtil_1 = require("../../../internal/util/ValidationUtil");
/**
 * Parameters for creating a tagged PDF using {@link AutotagPDFJob}.
 */
class AutotagPDFParams {
    /**
     * Constructs a new `AutotagPDFParams` instance.
     *
     * @param params - The parameters for constructing an instance of `AutotagPDFParams`.
     * @param [params.generateReport] - Whether to generate an additional tagging report which contains the
     * information about the tags that the tagged output PDF document contains. The default value is `false`.
     * @param [params.shiftHeadings] - Whether to shift headings in the output PDF document.
     * The default value is `false`.
     */
    constructor(params) {
        ValidationUtil_1.ValidationUtil.validateAutotagPDFParams(params);
        this._generateReport = params.generateReport;
        this._shiftHeadings = params.shiftHeadings;
    }
    /**
     * Returns a boolean value specifying whether an additional tagging report needs to be generated.
     *
     * @returns `true` if tagging report will be generated, `false` otherwise
     */
    get generateReport() {
        return this._generateReport;
    }
    /**
     * Returns a boolean value specifying whether headings need to be shifted in the tagged PDF.
     *
     * @returns `true` if headings will be shifted in the tagged PDF, `false` otherwise
     */
    get shiftHeadings() {
        return this._shiftHeadings;
    }
}
exports.AutotagPDFParams = AutotagPDFParams;
//# sourceMappingURL=AutotagPDFParams.js.map