multipaz/org.multipaz.prompt/Reason/HumanReadable

HumanReadable

data class HumanReadable(val title: String, val subtitle: String, val requireConfirmation: Boolean) : Reason

Human-readable explanation for the operation.

Note: title and subtitle are presented to the user and thus must be localized.

Multipaz library itself never uses values of this type for back-end operations. However, when PromptModel is used for key unlock prompts, every other Reason value is ultimately converted to a Reason.HumanReadable. See PromptModel.toHumanReadable property (which can be used to customize unlock prompts).

Constructors

HumanReadable

constructor(title: String, subtitle: String, requireConfirmation: Boolean)

Properties

requireConfirmation

val requireConfirmation: Boolean

if active user confirmation is required when used for passive biometrics.

subtitle

val subtitle: String

the subtitle to show in the authentication prompt.

title

val title: String

the title to show in the authentication prompt.