multipaz/org.multipaz.document/DocumentMetadata

DocumentMetadata

class DocumentMetadata : AbstractDocumentMetadata

Implementation of AbstractDocumentMetadata suitable for most use-cases.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override 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
open override val displayName: String?

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

Link copied to clipboard
open override 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
open override val other: ByteString?

Additional data the application wishes to store.

Link copied to clipboard
open override val provisioned: Boolean

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

Link copied to clipboard
open override val typeDisplayName: String?

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

Functions

Link copied to clipboard
open suspend override fun markAsProvisioned()

Marks the document as being provisioned.

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

Updates the metadata for the document.