multipaz/org.multipaz.digitalcredentials/DigitalCredentials

DigitalCredentials

interface DigitalCredentials

An interface for interacting with the W3C Digital Credentials API provider on the platform.

Use DigitalCredentials.Companion.getDefault from the multipaz-dcapi library to obtain an instance.

Types

object Companion

Properties

authorizationState

abstract val authorizationState: StateFlow<DigitalCredentialsAuthorizationState>

Whether the application is authorized to use the register method.

registerAvailable

abstract val registerAvailable: Boolean

Whether the register method is available on the platform.

requestAvailable

abstract val requestAvailable: Boolean

Whether the request method is available on the platform.

supportedProtocols

abstract val supportedProtocols: Set<String>

The set of W3C Digital Credentials protocols supported by the register method.

Functions

abstract suspend fun register(documentStore: DocumentStore, documentTypeRepository: DocumentTypeRepository, selectedProtocols: Set<String> = supportedProtocols)

Registers all documents in documentStore and removes registrations for previously registered documents no longer in documentStore.

abstract suspend fun request(request: JsonObject): JsonObject

Request credentials from wallet applications.