abstract class DigitalCredentialEntry

Known direct subclasses
MdocEntry

Mdoc entry, a mobile document entry whose format follows the ISO/IEC 18013-5:2021 specification.

A digital credential entry to be registered.

This entry contains information that serves two major purposes:

  1. Credential metadata for filtering / request matching purpose. When another app makes a CredentialManager.getCredential request, it will specify the specific credential properties it is looking for. The Credential Manager will use the info stored for the given entry and the registry matcher you registered to determine whether this entry can fulfill an incoming request.

  2. Display metadata that will be rendered as part of the Credential Manager selector UI. The selector UI, post filtering, will display to the user their qualified, available credential candidates, in order for the user to make an informed choice.

    All display metadata will be contained in the entryDisplayData property.

Summary

Public constructors
DigitalCredentialEntry(
    id: String,
    entryDisplayPropertySet: Set<EntryDisplayProperties>
)

Public properties
Set<EntryDisplayProperties>

the display properties associated with the given entry
String

the provider unique identifier of this credential entry, which can be used to identify the exact credential that the user has chosen

Public constructors

DigitalCredentialEntry

DigitalCredentialEntry(
    id: String,
    entryDisplayPropertySet: Set<EntryDisplayProperties>
)

Public properties

entryDisplayPropertySet

Added in 1.0.0-alpha01
val entryDisplayPropertySet: Set<EntryDisplayProperties>

the display properties associated with the given entry

id

Added in 1.0.0-alpha01
val id: String

the provider unique identifier of this credential entry, which can be used to identify the exact credential that the user has chosen