MetadataSignOptions
Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions
public class MetadataSignOptions extends SignOptions
Represents Metadata signature options.
| Constructor | Description |
|---|---|
| MetadataSignOptions() | Initializes a new instance of the SignMetadataOptions class with default values. |
| MetadataSignOptions(ArrayList |
Initializes a new instance of the SignMetadataOptions class with Metadata. |
| Method | Description |
|---|---|
| getSignatures() | Gets or sets the Metadata of signature. |
| setSignatures(MetadataSignatureCollection value) | Gets or sets the Metadata of signature. |
| getDataEncryption() | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| setDataEncryption(IDataEncryption value) | Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
| addPdfSignature(String name, Object value, String tag) | Creates new PdfMetadataSignature with passed arguments and adds it to collection. |
| addImageSignature(int id, Object value) | Creates new ImageMetadataSignature with passed arguments and adds it to collection. |
| add(MetadataSignature metadataSignature) | Add existing MetadataSignature instance to collection. |
| validate() | Internal method to validate the options parameters. |
| toString() | Override string conversion. |
| signature() |
public MetadataSignOptions()
Initializes a new instance of the SignMetadataOptions class with default values.
public MetadataSignOptions(ArrayList<MetadataSignature> signatures)
Initializes a new instance of the SignMetadataOptions class with Metadata.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| signatures | java.util.ArrayList<com.groupdocs.signature.domain.signatures.metadata.MetadataSignature> | Collection of Metadata Signatures MetadataSignature. |
public final MetadataSignatureCollection getSignatures()
Gets or sets the Metadata of signature.
Returns: MetadataSignatureCollection
public final void setSignatures(MetadataSignatureCollection value)
Gets or sets the Metadata of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MetadataSignatureCollection |
public final IDataEncryption getDataEncryption()
Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
Returns: IDataEncryption
public final void setDataEncryption(IDataEncryption value)
Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IDataEncryption |
public final PdfMetadataSignature addPdfSignature(String name, Object value, String tag)
Creates new PdfMetadataSignature with passed arguments and adds it to collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name of Metadata signature object |
| value | java.lang.Object | Value of Metadata signature |
| tag | java.lang.String | Prefix tag of Metadata signature |
Returns: PdfMetadataSignature - Newly created signature that was added to MetadataSignatures collection
public final ImageMetadataSignature addImageSignature(int id, Object value)
Creates new ImageMetadataSignature with passed arguments and adds it to collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| id | int | Unique identifier Image Metadata Signature name. See references for Exif tags specifications for possible id values |
| value | java.lang.Object | Metadata value |
Returns: ImageMetadataSignature - Newly created signature that was added to MetadataSignatures collection
public final MetadataSignOptions add(MetadataSignature metadataSignature)
Add existing MetadataSignature instance to collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| metadataSignature | MetadataSignature | The existing MetadataSignature instance to be added |
Returns: MetadataSignOptions - Instance itself
public void validate()
Internal method to validate the options parameters.
public String toString()
Override string conversion.
Returns: java.lang.String -
public BaseSignature signature()
Returns: BaseSignature
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.