multipaz/org.multipaz.prompt

Package-level declarations

Types

Link copied to clipboard
class AndroidPromptModel : PromptModel

PromptModel for Android platform.

Link copied to clipboard
Link copied to clipboard
typealias ConvertToHumanReadableFn = suspend (unlockReason: Reason, passphraseConstraints: PassphraseConstraints?) -> Reason.HumanReadable

A function that converts arbitrary Reason to a human-readable kind Reason.HumanReadable.

Link copied to clipboard
class IosPromptModel

PromptModel for iOS platform.

Link copied to clipboard
sealed class PassphraseEvaluation

A value that encodes the result of a PIN or passphrase attempt.

Link copied to clipboard
Link copied to clipboard
abstract class PromptDialogModel<ParametersT, ResultT>

A model for an individual prompt dialog that presents ParametersT to the user and obtains ResultT response from them.

Link copied to clipboard
class PromptDismissedException : Exception

Thrown when user dismisses a prompt or another coroutine tries to display the prompt of the same type (that preempts the originally displayed prompt).

Link copied to clipboard
abstract class PromptModel : CoroutineContext.Element

Base model object for prompts.

Link copied to clipboard
class PromptModelNotAvailableException : Exception

Thrown when PromptModel is not present in the current coroutine context.

Link copied to clipboard
class PromptUiNotAvailableException : Exception

Thrown when PromptDialogModel is not bound to the UI even after calling PromptModel.launchUi.

Link copied to clipboard
interface Reason

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

Link copied to clipboard
class ScanNfcPromptDialogModel : PromptDialogModel<ScanNfcPromptDialogModel.NfcDialogParameters<Any>, Any?>

Gives user feedback while NFC scanning is performed.

Link copied to clipboard
enum ScanNfcTagDialogIcon : Enum<ScanNfcTagDialogIcon>

Constants used to convey which icon to show when using UiViewAndroid.showScanNfcTagDialog.

Functions

Link copied to clipboard
suspend fun PromptModel.requestPassphrase(title: String, subtitle: String, passphraseConstraints: PassphraseConstraints, passphraseEvaluator: suspend (enteredPassphrase: String) -> PassphraseEvaluation?): String

Prompts user for authentication through a passphrase.

Link copied to clipboard
suspend fun AndroidPromptModel.showBiometricPrompt(cryptoObject: BiometricPrompt.CryptoObject?, title: String, subtitle: String, userAuthenticationTypes: Set<UserAuthenticationType>, requireConfirmation: Boolean): Boolean

Prompts user for authentication through biometrics.