| java.lang.Object | |
| ↳ | com.pspdfkit.signatures.signers.SignerOptions |
Class Overview
Contains all the data needed to perform a signing operation.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | SignerOptions.Builder | A helper class used for building the SignerOptions. |
|||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public final BiometricSignatureData | biometricSignatureData | BiometricSignatureData that will be written to the digital signature. |
|||||||||
| public final OutputStream | destination | Destination where the signed document will be written. | |||||||||
| public final Integer | estimatedSignatureSize | Estimated size of the signature (in bytes). | |||||||||
| public final SignatureAppearance | signatureAppearance | SignatureAppearance that will be used to determine how the signature looks once
signing is done. |
|||||||||
| public final SignatureContents | signatureContents | SignatureContents that contains raw content that will be embedded inside the
"/Contents" key of a signature dictionary. |
|||||||||
| public final SignatureFormField | signatureFormField | Signature form field to be signed. | |||||||||
| public final SignatureMetadata | signatureMetadata | SignatureMetadata that contains additional metadata to add to the signature. |
|||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public final BiometricSignatureData biometricSignatureData
BiometricSignatureData that will be written to the digital signature. May be null.
public final Integer estimatedSignatureSize
Estimated size of the signature (in bytes). The estimated size is the size that will be
reserved in the PDF document before digitally signing it. This size corresponds only to the
/Contents field of the signature field, that is, the signature container. The size of the
signature container mostly depends on the complexity of the certificates used for digital
signatures. PSPDFKit will actually reserve a bigger space to make room for implementation
details (the /ByteRange field, the fact that a signature is hex-encoded in a PDF, etc.). A
big estimated size will possibly make the signed document bigger than necessary, but a too
small one will cause the signing process to fail. If null, reasonable default size
will be used (8 KB that will be around 16 KB in the signed PDF). The returned value will be
clamped between 0 and 256 KB (262144 bytes).
public final SignatureAppearance signatureAppearance
SignatureAppearance that will be used to determine how the signature looks once
signing is done.
public final SignatureContents signatureContents
SignatureContents that contains raw content that will be embedded inside the
"/Contents" key of a signature dictionary.
public final SignatureMetadata signatureMetadata
SignatureMetadata that contains additional metadata to add to the signature.