showBiometricPrompt

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

Prompts user for authentication through biometrics.

To dismiss the prompt programmatically, cancel the job the coroutine was launched in.

To obtain title and subtitle back-end code generally should create a Reason object and use PromptModel.toHumanReadable to convert it to human-readable form. This gives application code a chance to customize user-facing messages.

Return

true if authentication succeed, false if the user dismissed the prompt.

Parameters

cryptoObject

optional CryptoObject to be associated with the authentication.

title

the title for the authentication prompt.

subtitle

the subtitle for the authentication prompt.

userAuthenticationTypes

the set of allowed user authentication types, must contain at least one element.

requireConfirmation

set to true to require explicit user confirmation after presenting passive biometric.