@adobe/pdfservices-node-sdk/lib/pdfjobs/params/electronicseal/FieldOptions.d.ts

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

import { FieldLocation } from "./FieldLocation";
/**
 * Parameters specifying options related to the seal field required for {@link PDFElectronicSealParams}.
 */
export declare class FieldOptions {
    private readonly _fieldLocation?;
    private readonly _pageNumber?;
    private readonly _fieldName;
    private readonly _visible?;
    /**
     * Constructs a `FieldOptions` instance.
     *
     * @param params - The parameters for constructing an instance of `FieldOptions`.
     * @param [params.visible] - The intended visibility flag for the electronic seal. Default value is `true`.
     * @param [params.location] - A {@link FieldLocation} instance specifying coordinates for the electronic seal.
     * The location is only required for visible signatures if the signature field does not already exist in the
     * PDF document. If location is provided along with the existing signature field then it is ignored.
     * @param params.fieldName - The name of the field to be used for applying the electronic seal.
     * If signature field with this field name already exist, that field will be used.
     * If it does not exist, a signature field with this field name will be created. Cannot be undefined.
     * @param [params.pageNumber] - The page number to which the signature field should be attached.
     * Page numbers are 1-based. The page number is only required for visible signatures if the signature field
     * does not already exist in the PDF document. If page number is provided along with the existing signature
     * field then the page number should be same on which signature field is present in the document,
     * else an error is thrown.
     */
    constructor(params: {
        visible?: boolean;
        location?: FieldLocation;
        fieldName: string;
        pageNumber?: number;
    });
    /**
     * Returns the name of the field to be used for applying the electronic seal.
     *
     * @returns the field name for the electronic seal.
     */
    get fieldName(): string;
    /**
     * Returns the intended visibility flag for the electronic seal.
     *
     * @returns the visibility flag for the electronic seal.
     */
    get visible(): boolean | undefined;
    /**
     * Returns the intended page number for the electronic seal.
     *
     * @returns the page number for the electronic seal.
     */
    get pageNumber(): number | undefined;
    /**
     * Returns a {@link FieldLocation} instance specifying coordinates for the electronic seal.
     *
     * @returns the seal field location coordinates.
     */
    get fieldLocation(): FieldLocation | undefined;
}