Class Signature

Implements

SignatureType

Index

Constructors

Methods

clearSignatureByIndex clearSignatureByName getDocSignatureCount getSignatureInfoByIndex getSignatureInfoByName signatureSign signatureSignByName create

Constructors

constructor

new Signature(options?: Options): Signature
No longer use 'new' to create, but use create instead.
Parameters
- Optionaloptions: Options
  Configuration options containing necessary initialization information.
Returns Signature
Example
```
 const signature = await Signature.create();
```

Methods

clearSignatureByIndex

clearSignatureByIndex(doc: DocType, index: number): Promise<boolean>
Clear the signature.
Parameters
- doc: DocType
  The document.
- index: number
  The index of the signature.
Returns Promise<boolean>
- Whether the operation is successful.
Implementation of SignatureType.clearSignatureByIndex

clearSignatureByName

clearSignatureByName(doc: DocType, fieldName: string): Promise<boolean>
Clear the signature by name.
Parameters
- doc: DocType
  The document.
- fieldName: string
  The name of the signature field.
Returns Promise<boolean>
- Whether the operation is successful.
Implementation of SignatureType.clearSignatureByName

getDocSignatureCount

getDocSignatureCount(doc: DocType): Promise<number>
Gets the signature count of the document.
Parameters
- doc: DocType
  The document, In general, it is the current document.
Returns Promise<number>
- The signature count.
Implementation of SignatureType.getDocSignatureCount

getSignatureInfoByIndex

getSignatureInfoByIndex(doc: DocType, index: number): Promise<SignatureInfoType>
Gets the signature base information.
Parameters
- doc: DocType
  The document, In general, it is the current document.
- index: number
  The index of the signature.
Returns Promise<SignatureInfoType>
- The signature base information.
Implementation of SignatureType.getSignatureInfoByIndex

getSignatureInfoByName

getSignatureInfoByName(doc: DocType, name: string): Promise<SignatureInfoType>
Gets the signature information by name.
Parameters
- doc: DocType
  The document, In general, it is the current document.
- name: string
  The name of the signature.
Returns Promise<SignatureInfoType>
- The signature information.
Implementation of SignatureType.getSignatureInfoByName

signatureSign

signatureSign(
    signatureInfo: SignatureBaseInfoType,
    signaturePosInfo: SignaturePosInfoType,
    signatureExInfo: SignatureExtendInfoType,
    openSignDoc: boolean,
): Promise<boolean>
Sign the document.
Parameters
- signatureInfo: SignatureBaseInfoType
  The signature information.
- signaturePosInfo: SignaturePosInfoType
  The signature position information.
- signatureExInfo: SignatureExtendInfoType
  The signature extend information.
- openSignDoc: boolean
  Whether to open the signed document.
Returns Promise<boolean>
- Whether the operation is successful.
Implementation of SignatureType.signatureSign

signatureSignByName

signatureSignByName(
    fieldName: string,
    doc: DocType,
    signatureInfo: SignatureBaseInfoType,
    saveSignFilePath: string,
    openSignDoc: boolean,
): Promise<boolean>
Sign a field.
Parameters
- fieldName: string
  The name of the field.
- doc: DocType
  The document.
- signatureInfo: SignatureBaseInfoType
  The signature information.
- saveSignFilePath: string
  The path to save the signed file.
- openSignDoc: boolean
  Whether to open the signed document.
Returns Promise<boolean>
- Whether the operation is successful.
Implementation of SignatureType.signatureSignByName

`Static`create

create(options?: Options): Promise<SignatureType>
Creates a new instance of the Signature class.
Parameters
- Optionaloptions: Options
  Configuration options containing necessary initialization information.
Returns Promise<SignatureType>
- A promise that resolves with a new instance of the Signature class.