nutrient/com.pspdfkit.signatures/DigitalSignatureInfo

DigitalSignatureInfo

A digital signature stored inside a PDF document. This can be retrieved by calling getSignatureInfo. As a convenience to check the signing status of a document, you can retrieve the DocumentSignatureInfo by calling getDocumentSignatureInfoAsync.

Types

BuildData

open class BuildData

Build data dictionary of a software that created the digital signature.

Reference

open class Reference

Signature reference dictionary.

ReferenceTransformMethod

enum ReferenceTransformMethod

List of possible transformation methods of a Reference.

Properties

BUILD_DATA_APP_KEY

@NonNull

val BUILD_DATA_APP_KEY: String = "App"

Key of a BuildData entry for the PDF/SigQ Conformance Checker that was used to create the signature.

BUILD_DATA_FILTER_KEY

@NonNull

val BUILD_DATA_FILTER_KEY: String = "Filter"

Key of a BuildData entry for the filter (i.e.

BUILD_DATA_PUB_SEC_KEY

@NonNull

val BUILD_DATA_PUB_SEC_KEY: String = "PubSec"

Key of a BuildData entry for the PubSec software that created the signature.

BUILD_DATA_SIGQ_KEY

@NonNull

val BUILD_DATA_SIGQ_KEY: String = "SigQ"

Key of a BuildData entry for the PDF/SigQ Specification and Conformance Checker that was used to create the signature.

buildProperties

@NonNull

@get:NonNull

val buildProperties: Map<String, DigitalSignatureInfo.BuildData>

The map of build properties describing the software that created this signature.

byteRange

@Nullable

@get:Nullable

val byteRange: List<Long>

The byte range this signature covers in the PDF file.

contents

@Nullable

@get:Nullable

val contents: Array<Byte>

The actual byte content of the signature.

creationDate

@Nullable

@get:Nullable

val creationDate: Calendar

The date when this signature was created.

filter

@Nullable

@get:Nullable

val filter: String

The name of the filter used for signing.

location

@Nullable

@get:Nullable

val location: String

The location where the document was signed.

name

@Nullable

@get:Nullable

val name: String

The name of the signer of this signature.

reason

@Nullable

@get:Nullable

val reason: String

The reason for signing the document.

references

@NonNull

@get:NonNull

val references: List<DigitalSignatureInfo.Reference>

The list of signature reference dictionaries.

subFilter

@Nullable

@get:Nullable

val subFilter: String

The name of the subfilter used for signing.

Functions

getDocument

@NonNull

open fun getDocument(): PdfDocument

Returns the document with which the signature info is associated.

isSigned

open fun isSigned(): Boolean

Returns if form field is actually signed.

toString

open fun toString(): String

Returns a string representation of this digital signature info for debugging purposes.

validate

@NonNull

@WorkerThread

open fun validate(): DigitalSignatureValidationResult

Checks the actual validity of the signature and returns DigitalSignatureValidationResult.