Reason

interface Reason

Provides a reason why certain operation is needed or is being performed.

For instance, it may be a reason why a key in org.multipaz.securearea.SecureArea needs to be unlocked and it could provide the context of the operation that the key is going to be involved in (signing or key agreement), e.g. a credential being presented.

A reason can be taken into account when implementing org.multipaz.securearea.KeyUnlockDataProvider or when using a user prompt to obtain authorization in PromptModel.toHumanReadable.

This is an interface and thus the set of possible values is not restricted. Applications are encouraged to create application-specific implementation of this interface for use in the application back-end code.

Inheritors

Types

Link copied to clipboard
data class HumanReadable(val title: String, val subtitle: String, val requireConfirmation: Boolean) : Reason

Human-readable explanation for the operation.

Link copied to clipboard

No reason for the operation is given.