wallet/org.multipaz.wallet.provisioning/WalletDocumentMetadata

WalletDocumentMetadata

class WalletDocumentMetadata : AbstractDocumentMetadata

AbstractDocumentMetadata implementation for the Wallet app.

Types

data class Data(var provisioned: Boolean = false, var issuingAuthorityIdentifier: String? = null, var documentIdentifier: String? = null, var numDocumentConfigurationsDownloaded: Long = 0, var documentConfiguration: DocumentConfiguration? = null, var issuingAuthorityConfiguration: IssuingAuthorityConfiguration? = null, var state: DocumentState? = null, var documentSlot: Int? = null, var other: ByteString? = null)

Properties

cardArt

open override val cardArt: ByteString

directAccessDocumentSlot

var directAccessDocumentSlot: Int

displayName

open override val displayName: String

documentConfiguration

val documentConfiguration: DocumentConfiguration

The most recent DocumentConfiguration received from the issuer

documentIdentifier

val documentIdentifier: String

The identifier for the document, as assigned by the issuer

issuerLogo

open override val issuerLogo: ByteString

issuingAuthorityConfiguration

val issuingAuthorityConfiguration: IssuingAuthorityConfiguration

The most recent IssuingAuthorityConfiguration received from the issuer

issuingAuthorityIdentifier

val issuingAuthorityIdentifier: String?

The identifier for the IssuingAuthority the credential belongs to

numDocumentConfigurationsDownloaded

val numDocumentConfigurationsDownloaded: Long

The number of times a DocumentConfiguration has been downloaded from the issuer.

other

open override val other: Nothing?

provisioned

open override val provisioned: Boolean

state

val state: DocumentState?

The most recent DocumentState received from the issuer.

typeDisplayName

open override val typeDisplayName: String

Functions

incrementNumDocumentConfigurationsDownloaded

suspend fun incrementNumDocumentConfigurationsDownloaded()

initialize

suspend fun initialize(issuingAuthorityIdentifier: String, documentIdentifier: String, documentConfiguration: DocumentConfiguration, issuingAuthorityConfiguration: IssuingAuthorityConfiguration)

markAsProvisioned

open suspend override fun markAsProvisioned()

refreshState

suspend fun refreshState(walletServerProvider: WalletServerProvider)

Gets the document state from the Issuer and updates the .state property with the value.

setDocumentConfiguration

suspend fun setDocumentConfiguration(documentConfiguration: DocumentConfiguration)

setDocumentSlot

suspend fun setDocumentSlot(documentSlot: Int)

setIssuingAuthorityConfiguration

suspend fun setIssuingAuthorityConfiguration(issuingAuthorityConfiguration: IssuingAuthorityConfiguration)

setMetadata

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