Package-level declarations

Types

Link copied to clipboard
class AndroidPromptModel(val toHumanReadable: ConvertToHumanReadableFn = ::defaultConvertToHumanReadable) : ViewModel, PromptModel

PromptModel for Android platform.

Link copied to clipboard
class BiometricPromptState(val cryptoObject: BiometricPrompt.CryptoObject?, val title: String, val subtitle: String, val userAuthenticationTypes: Set<UserAuthenticationType>, val requireConfirmation: Boolean)
Link copied to clipboard
typealias ConvertToHumanReadableFn = suspend (unlockReason: UnlockReason, passphraseConstraints: PassphraseConstraints?) -> UnlockReason.HumanReadable

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

Link copied to clipboard
class IosPromptModel(val toHumanReadable: <Error class: unknown class> = ::defaultConvertToHumanReadable)

PromptModel for iOS platform.

Link copied to clipboard
class NfcDialogParameters<out T>(val initialMessage: String?, val interactionFunction: suspend (tag: NfcIsoTag) -> T?, val options: NfcScanOptions, val context: CoroutineContext)

Parameters needed for UI to display and run NFC dialog. See org.multipaz.nfc.NfcTagReader.scan for more information.

Link copied to clipboard

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

Link copied to clipboard
class PassphraseRequest(val title: String, val subtitle: String, val passphraseConstraints: PassphraseConstraints, val passphraseEvaluator: suspend (enteredPassphrase: String) -> PassphraseEvaluation?)

Data for the UI to display and run passphrase dialog.

Link copied to clipboard

Thrown when user dismisses a prompt.

Link copied to clipboard

Base model object for prompts.

Link copied to clipboard

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

Link copied to clipboard
class SinglePromptModel<ParametersT, ResultT>(lingerDuration: Duration = 0.seconds)

A model for an individual prompt dialog.

Functions

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

Requests that the UI layer should ask the user for a passphrase.