DigitalSignature
DigitalSignature class
Signature in file.
class DigitalSignature;
Constructors
| Name | Description |
|---|---|
| constructor(number[], string, string, Date) | Constructor of DigitalSignature. |
| constructor(string, string, string, Date) | Constructor of DigitalSignature. |
Methods
| Method | Description |
|---|---|
| getComments() | The purpose to signature. |
| setComments(string) | The purpose to signature. |
| getSignTime() | The time when the document was signed. |
| setSignTime(Date) | The time when the document was signed. |
| getText() | Specifies the text of actual signature in the digital signature. Default value is Empty. |
| setText(string) | Specifies the text of actual signature in the digital signature. Default value is Empty. |
| getImage() | Specifies an image for the digital signature. Default value is null. |
| setImage(number[]) | Specifies an image for the digital signature. Default value is null. |
| isValid() | If this digital signature is valid and the document has not been tampered with, this value will be true. |
| getXAdESType() | XAdES type. Default value is None(XAdES is off). |
| setXAdESType(XAdESType) | XAdES type. Default value is None(XAdES is off). |
| isNull() | Checks whether the implementation object is null. |
constructor(number[], string, string, Date)
Constructor of DigitalSignature.
constructor(rawData: number[], password: string, comments: string, signTime: Date);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rawData | number[] | A byte array containing data from an X.509 certificate. |
| password | string | The password required to access the X.509 certificate data. |
| comments | string | The purpose to signature. |
| signTime | Date | The utc time when the document was signed. |
constructor(string, string, string, Date)
Constructor of DigitalSignature.
constructor(fileName: string, password: string, comments: string, signTime: Date);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileName | string | The name of a certificate file. |
| password | string | The password required to access the X.509 certificate data. |
| comments | string | The purpose to signature. |
| signTime | Date | The utc time when the document was signed. |
getComments()
The purpose to signature.
getComments() : string;
setComments(string)
The purpose to signature.
setComments(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getSignTime()
The time when the document was signed.
getSignTime() : Date;
setSignTime(Date)
The time when the document was signed.
setSignTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
getText()
Specifies the text of actual signature in the digital signature. Default value is Empty.
getText() : string;
setText(string)
Specifies the text of actual signature in the digital signature. Default value is Empty.
setText(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getImage()
Specifies an image for the digital signature. Default value is null.
getImage() : number[];
Returns
number[]
setImage(number[])
Specifies an image for the digital signature. Default value is null.
setImage(value: number[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number[] | The value to set. |
isValid()
If this digital signature is valid and the document has not been tampered with, this value will be true.
isValid() : boolean;
getXAdESType()
XAdES type. Default value is None(XAdES is off).
getXAdESType() : XAdESType;
Returns
setXAdESType(XAdESType)
XAdES type. Default value is None(XAdES is off).
setXAdESType(value: XAdESType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | XAdESType | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;