[]
        
(Showing Draft Content)

PdfSignature

Class: PdfSignature

Represents a PDF signature object.

Extends

Accessors

contactInfo

Get Signature

get contactInfo(): string;

Gets the information provided by the signer to enable a recipient to contact the signer to verify the signature (for example, a phone number).

Returns

string


contents

Get Signature

get contents(): Uint8Array<ArrayBufferLike>;

Gets the raw signature contents.

Returns

Uint8Array<ArrayBufferLike>

The signature value as a Uint8Array, or null if not present.


doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this signature.

Returns

PdfDocument


filter

Get Signature

get filter(): string;

Gets the name of the preferred signature handler to use when validating this signature.

Returns

string


id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id


location

Get Signature

get location(): string;

Gets the CPU host name or physical location of the signing.

Returns

string


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om


reason

Get Signature

get reason(): string;

Gets the reason for the signing, such as "I agree...".

Returns

string


signerName

Get Signature

get signerName(): string;

Gets the name of the person or authority signing the document. This value should be used only when it is not possible to extract the name from the signature; for example, from the certificate of the signer.

Returns

string


signingTime

Get Signature

get signingTime(): PdfDateTime;

Gets the time of signing. Depending on the signature handler, this may be a normal unverified computer time or a time generated in a verifiable way from a secure time server. This value should be used only when the time of signing is not available in the signature; for example, a time stamp can be embedded in a PKCS#7 binary data object (see PDF specification for more details).

Returns

PdfDateTime


subFilter

Get Signature

get subFilter(): string;

Gets a name that describes the encoding of the signature value and key information in the signature dictionary.

Returns

string


type

Get Signature

get type(): string;

Gets the signature type, if present, shall be "Sig" for a signature dictionary or "DocTimeStamp" for a time-stamp signature dictionary.

Returns

string

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free


parseContent()

parseContent(): Pkcs7Content;

Parses the signature contents and returns a structured representation.

Returns

Pkcs7Content

A Pkcs7Content object created by parsing the value of PdfSignature#contents.


rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind