Parameters for electronically seal PDFs using PDFElectronicSealJob.

Implements

Constructors

  • Constructs a new PDFElectronicSealParams instance.

    Parameters

    • params: {
          certificateCredentials: CertificateCredentials;
          documentLevelPermission?: DocumentLevelPermission;
          sealAppearanceOptions?: AppearanceOptions;
          sealFieldOptions: FieldOptions;
          signatureFormat?: SignatureFormat;
          tsaOptions?: TSAOptions;
      }

      The parameters for constructing an instance of PDFElectronicSealParams.

      • certificateCredentials: CertificateCredentials

        The certificate credentials to be used for applying the electronic seal. Cannot be undefined.

      • Optional documentLevelPermission?: DocumentLevelPermission

        The document level permissions for changes allowed after applying electronic seal. Default value is FORM_FILLING.

      • Optional sealAppearanceOptions?: AppearanceOptions

        The appearance options to be used for applying the electronic seal. Default value is [NAME, LABELS].

      • sealFieldOptions: FieldOptions

        The field options to be used for applying the electronic seal. Cannot be undefined.

      • Optional signatureFormat?: SignatureFormat

        The signature format to be used for applying electronic seal. Default value is PKCS7.

      • Optional tsaOptions?: TSAOptions

        The TSA details to be used for timestamping as per RFC3161 standards.

    Returns PDFElectronicSealParams

Properties

_appearanceOptions?: AppearanceOptions
_certificateCredentials: CertificateCredentials
_documentLevelPermission?: DocumentLevelPermission
_fieldOptions: FieldOptions
_signatureFormat?: SignatureFormat
_tsaOptions?: TSAOptions

Accessors

  • get fieldOptions(): FieldOptions
  • Returns FieldOptions

  • get signatureFormat(): undefined | SignatureFormat
  • Returns the signature format to be used for applying electronic seal.

    Returns undefined | SignatureFormat

    the signature format to be used for applying electronic seal.

  • get tsaOptions(): undefined | TSAOptions
  • Returns undefined | TSAOptions

Generated using TypeDoc