multipaz/org.multipaz.securearea/UnlockReason/HumanReadable

HumanReadable

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

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 UnlockReason value is ultimately converted to a UnlockReason.HumanReadable. See PromptModel.toHumanReadable property (which can be used to customize unlock prompts).

Constructors

Link copied to clipboard
constructor(title: String, subtitle: String, requireConfirmation: Boolean)

Properties

Link copied to clipboard
val requireConfirmation: Boolean

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

Link copied to clipboard
val subtitle: String

the subtitle to show in the authentication prompt.

Link copied to clipboard
val title: String

the title to show in the authentication prompt.