multipaz/org.multipaz.presentment.model/PresentmentModel

PresentmentModel

class PresentmentModel

A model which can be used to drive UI for presentment.

This model is designed to be shared by a mechanism (the code communicating with a credential reader) and the UI layer (which displays UI to the user). Typically the mechanism will also include a PromptModel bound to the UI so things like consent prompts and authentication dialogs are displayed in the UI.

Constructors

PresentmentModel

constructor()

Types

sealed class State

State hierarchy.

Properties

documentsSelected

val documentsSelected: StateFlow<List<Document>>

The set of Documents currently selected to be returned.

val documentStore: DocumentStore

The DocumentStore being used for presentment.

documentTypeRepository

val documentTypeRepository: DocumentTypeRepository

The DocumentTypeRepository to provide information about document types.

numRequestsServed

val numRequestsServed: StateFlow<Int>

The number of requests served from the reader.

val state: StateFlow<PresentmentModel.State>

The current state of the model.

Functions

fun reset(documentStore: DocumentStore, documentTypeRepository: DocumentTypeRepository, preselectedDocuments: List<Document>)

Resets the model.

setCanceledByUser

fun setCanceledByUser()

Should be called by the UI layer when the user cancels the transaction.

fun setCompleted(error: Throwable?)

Should be called by the mechanism when the transaction is complete.

fun setConnecting()

Should be called by the mechanism when connecting to the credential reader, if applicable

setDocumentsSelected

fun setDocumentsSelected(selectedDocuments: List<Document>)

Should be called by the mechanism when the user selects a particular set of documents.

fun setSending()

Should be called by the mechanism when transmitting the response to the credential reader.

setWaitingForReader

fun setWaitingForReader()

Should be called by the mechanism when waiting for the credential reader to send a request.

setWaitingForUserInput

fun setWaitingForUserInput()

Should be called by the mechanism when waiting for the user to provide input (consent prompt or authentication).