DigitalSigning Class

Namespace:
@gembox/pdfviewer
Assembly:
@gembox/pdfviewer

Provides functionality for digitally signing PDF documents.

export declare class DigitalSigning implements EventElement<DigitalSigningEventMap>
Inheritance:
DigitalSigning
Implements
Remarks

This class handles the digital signing process, including communication with a signing server, event handling for signing operations, and management of signing appearance options.

Fields

serverUrl

Gets or sets the URL of the digital signing server.

serverUrl: string;
Remarks

This property specifies the endpoint where PDF documents will be sent for digital signing.

apiPassword

Gets or sets the API password used to authenticate with the digital signing server.

apiPassword?: string;
Remarks

This password is sent as a Bearer token in the Authorization header when making requests to the signing server. If not set, the user will be prompted to enter a password during the signing process.

autoDownload

Gets or sets whether the signed document should be automatically downloaded after successful signing.

autoDownload: boolean;
Remarks

When set to true, the signed PDF will be downloaded to the user's device upon completion of the signing process. Defaults to true.

appearance

Gets or sets the appearance annotation for the digital signature.

appearance?: Annotation;
Field Value
Annotation
Remarks

This property allows customization of how the digital signature appears in the PDF document.

Methods

addEventListener(K, (event: DigitalSigningEventMap[K]) => void)

Adds an event listener for the specified event type.

addEventListener<K extends keyof DigitalSigningEventMap>(type: K, listener: (event: DigitalSigningEventMap[K]) => void): void;
Parameters
type

The event type/name to listen for.

listener

The callback function that will be invoked when the event is emitted.

sign(string)

Initiates the digital signing process for the current PDF document.

sign(password?: string): Promise<void>;
Parameters
password

Optional password to override the default API password for this signing operation.

Remarks
  • Extracts the current PDF document data.
  • Emits a digitalSigning event to allow customization.
  • Sends the document to the signing server.
  • Handles the signed document response.
  • Loads the signed PDF back into the viewer.

Implements