AuthenticationRequest.Biometric

Artifact: androidx.biometric:biometric

View Source

Added in 1.4.0-alpha06

---

Kotlin |Java

class AuthenticationRequest.Biometric : AuthenticationRequest

kotlin.Any
↳	androidx.biometric.AuthenticationRequest
	↳	androidx.biometric.AuthenticationRequest.Biometric

---

A set of configurable options for how the BiometricPrompt should appear and behave with biometric authentication with fallbacks.

Summary

Nested types
class AuthenticationRequest.Biometric.Builder Builder used to create an instance of Biometric.
abstract class AuthenticationRequest.Biometric.Fallback Fallback options for the biometric authentication.
class AuthenticationRequest.Biometric.Fallback.CustomOption : AuthenticationRequest.Biometric.Fallback Custom Fallback option displayed as the negative button in prompt authentication screen if it is the only option or displayed in a list in the fallback options page if there are more than one.
object AuthenticationRequest.Biometric.Fallback.DeviceCredential : AuthenticationRequest.Biometric.Fallback Device credential as the fallback.
abstract class AuthenticationRequest.Biometric.Strength Types of biometric strength for the prompt.
object AuthenticationRequest.Biometric.Strength.Class2 : AuthenticationRequest.Biometric.Strength Class 2 (formerly Weak).
class AuthenticationRequest.Biometric.Strength.Class3 : AuthenticationRequest.Biometric.Strength Class 3 (formerly Strong).

Public companion functions
Int	getMaxFallbackOptions() Returns the maximum number of fallback options that can be added to the prompt.

Public properties
List<AuthenticationRequest.Biometric.Fallback>	authFallbacks The Fallback options for the biometric authentication.
AuthenticationRequest.BodyContent?	content The optional BodyContent of the prompt.
Boolean	isConfirmationRequired Whether user confirmation should be required for passive biometrics.
Bitmap?	logoBitmap
String?	logoDescription
Int	logoRes
AuthenticationRequest.Biometric.Strength	minStrength The minimum biometric strength for the authentication.
String?	subtitle The optional subtitle of the prompt.
String	title The title of the prompt.

Public companion functions

getMaxFallbackOptions

Added in 1.4.0-alpha06

fun getMaxFallbackOptions(): Int

Returns the maximum number of fallback options that can be added to the prompt.

Returns
Int	The maximum number of fallback options.

Public properties

authFallbacks

Added in 1.4.0-alpha06

val authFallbacks: List<AuthenticationRequest.Biometric.Fallback>

The Fallback options for the biometric authentication.

content

Added in 1.4.0-alpha06

val content: AuthenticationRequest.BodyContent?

The optional BodyContent of the prompt.

isConfirmationRequired

Added in 1.4.0-alpha06

val isConfirmationRequired: Boolean

Whether user confirmation should be required for passive biometrics.

logoBitmap

Added in 1.4.0-alpha06

val logoBitmap: Bitmap?

logoDescription

Added in 1.4.0-alpha06

val logoDescription: String?

logoRes

Added in 1.4.0-alpha06

val logoRes: Int

minStrength

Added in 1.4.0-alpha06

val minStrength: AuthenticationRequest.Biometric.Strength

The minimum biometric strength for the authentication. Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

subtitle

Added in 1.4.0-alpha06

val subtitle: String?

The optional subtitle of the prompt.

title

Added in 1.4.0-alpha06

val title: String

The title of the prompt.