multipaz/org.multipaz.document/AbstractDocumentMetadata

AbstractDocumentMetadata

interface AbstractDocumentMetadata

Interface that all objects returned in Document.metadata must implement.

Most applications will likely just use DocumentMetadata but if there are needs to store application-specific data for each document they may implement this interface by an application specific class.

Inheritors

Properties

Link copied to clipboard
abstract val cardArt: ByteString?

An image that represents this document to the user in the UI. Generally, the aspect ratio of 1.586 is expected (based on ID-1 from the ISO/IEC 7810). PNG format is expected and transparency is supported.

Link copied to clipboard
abstract val displayName: String?

User-facing name of this specific Document instance, e.g. "John's Passport".

Link copied to clipboard
abstract val issuerLogo: ByteString?

An image that represents the issuer of the document in the UI, e.g. passport office logo. PNG format is expected, transparency is supported and square aspect ratio is preferred.

Link copied to clipboard
abstract val other: ByteString?

Additional data the application wishes to store.

Link copied to clipboard
abstract val provisioned: Boolean

Whether the document is provisioned, i.e. issuer is ready to provide credentials.

Link copied to clipboard
abstract val typeDisplayName: String?

User-facing name of this document type, e.g. "Utopia Passport".

Functions

Link copied to clipboard
abstract suspend fun markAsProvisioned()

Marks the document as being provisioned.

Link copied to clipboard
abstract suspend fun setMetadata(displayName: String?, typeDisplayName: String?, cardArt: ByteString?, issuerLogo: ByteString?, other: ByteString?)

Updates the metadata for the document.