MultipazProject

multipaz-models/org.multipaz.models.presentment/PresentmentModel

PresentmentModel

class PresentmentModel

A model used for credential presentment.

This model implements the entire UX/UI flow related to presentment, including

Allowing the user to cancel at any time, including when the connection is being established.
Querying the user for which document to present, if multiple credentials can satisfy the request.
Showing a consent dialog.
Generating the response and sending it to the verifier, via the selected mechanism.
Support for multiple requests if both sides keep the connection open

Constructors

PresentmentModel

constructor()

Types

object Companion

data class ConsentData(val document: Document, val request: Request, val trustPoint: TrustPoint?)

Data to include in the consent prompt.

enum DismissType : Enum<PresentmentModel.DismissType>

Three different ways the close/dismiss button can be triggered.

enum State : Enum<PresentmentModel.State>

Possible states that the model can be in.

Properties

availableDocuments

val availableDocuments: List<Document>

The list of available documents to pick from.

val consentData: PresentmentModel.ConsentData

The data to show in the consent dialog.

val dismissable: StateFlow<Boolean>

Returns whether the presentment can be dismissed/canceled.

val error: Throwable?

If presentment fails, this will be set with a Throwable with more information about the failure.

val mechanism: PresentmentMechanism?

The mechanism being used to communicate with the credential reader.

numRequestsServed

val numRequestsServed: StateFlow<Int>

Number of requests served.

presentmentScope

val presentmentScope: CoroutineScope

A CoroutineScope for the presentment process.

val source: PresentmentSource?

The source which provides data to present.

val state: StateFlow<PresentmentModel.State>

The current state.

Functions

consentReviewed

fun consentReviewed(consentObtained: Boolean)

The UI layer should call this when a user has reviewed the consent data.

fun dismiss(dismissType: PresentmentModel.DismissType)

Should be called by the UI layer if the user hits the dismiss button.

documentSelected

fun documentSelected(document: Document?)

The UI layer should call this when a user has selected a document.

fun reset()

Resets the model to State.IDLE.

fun setCompleted(error: Throwable? = null)

Sets the model to State.COMPLETED

fun setConnecting()

Sets the model to State.CONNECTING.

fun setMechanism(mechanism: PresentmentMechanism)

Sets the PresentmentMechanism to use.

fun setPromptModel(promptModel: PromptModel)

Provides PromptModel, required if presentment involves popping up any prompts, such as biometrics or passphrase.

fun setSource(source: PresentmentSource)

Sets the PresentmentSource to use as the source of truth for presentment.