FoxitPDFSDKforWeb v11.0.1
Foxit PDF SDK for Web
|
Interface representing a signature field in a PDF document. More...
Public Member Functions | |
Promise< Array< number >|undefined > | getByteRange () |
Retrieves the byte range of the current signature. More... | |
Promise< string|undefined > | getFilter () |
Retrieves the filter of the current signature. More... | |
string | getName () |
Retrieves the signature field name. More... | |
Promise< string > | getSigner () |
Gets the name of the signer. More... | |
Promise< SignatureInfo > | getSignInfo () |
Retrieves the signature information for the field. More... | |
Promise< string|undefined > | getSubfilter () |
Retrieves the subfilter of the current signature. More... | |
Promise< boolean > | isSigned () |
Checks whether the current signature is signed. More... | |
Promise< number > | verify () |
Verifies the signature, returning the result of the verification. More... | |
Public Attributes | |
readonly boolean | isFormField |
Indicates if the signature field is a form field. | |
readonly boolean | isXFAField |
Indicates if the signature field is part of an XFA form. | |
readonly number | verifiedResult |
The verification result of the current signature. If the signature has not been verified, this property is undefined. More... | |
Interface representing a signature field in a PDF document.
This is a common interface used to represent the common properties and methods of XFA signature fields and form signature fields in a PDF document. For methods that use this interface as a parameter, it indicates that the method can support both XFA and Form signature fields.
Promise<Array<number>|undefined> ISignatureField::getByteRange | ( | ) |
Retrieves the byte range of the current signature.
Implemented in PDFSignature.
Promise<string|undefined> ISignatureField::getFilter | ( | ) |
Retrieves the filter of the current signature.
Filter and subfilter specify which registered signature callback object will be used to sign/verify the current signature.
Implemented in PDFSignature.
string ISignatureField::getName | ( | ) |
Retrieves the signature field name.
Promise<string> ISignatureField::getSigner | ( | ) |
Gets the name of the signer.
Implemented in PDFSignature.
Promise<SignatureInfo> ISignatureField::getSignInfo | ( | ) |
Retrieves the signature information for the field.
Implemented in PDFSignature, IFormSignatureField, and IXFASignatureField.
Promise<string|undefined> ISignatureField::getSubfilter | ( | ) |
Retrieves the subfilter of the current signature.
Filter and subfilter specify which registered signature callback object will be used to sign/verify the current signature.
Implemented in PDFSignature.
Promise<boolean> ISignatureField::isSigned | ( | ) |
Checks whether the current signature is signed.
Implemented in PDFSignature.
Promise<number> ISignatureField::verify | ( | ) |
Verifies the signature, returning the result of the verification.
force | boolean - Whether to force verification even if a result is already cached. |
readonly number ISignatureField::verifiedResult |
The verification result of the current signature. If the signature has not been verified, this property is undefined.