AuthenticationRequest.Biometric


public final class AuthenticationRequest.Biometric extends AuthenticationRequest


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

Summary

Nested types

Builder used to create an instance of Biometric.

Fallback options for the biometric authentication.

Device credential as the fallback.

A customized negative button as the fallback.

Types of biometric strength for the prompt.

Class 2 (formerly Weak).

Class 3 (formerly Strong).

Public methods

final @NonNull AuthenticationRequest.Biometric.Fallback

The Fallback for the biometric authentication.

final AuthenticationRequest.BodyContent

The optional BodyContent of the prompt.

final Bitmap
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
getLogoBitmap()
final String
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
getLogoDescription()
final int
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
getLogoRes()
final @NonNull AuthenticationRequest.Biometric.Strength

The minimum biometric strength for the authentication.

final String

The optional subtitle of the prompt.

final @NonNull String

The title of the prompt.

final boolean

Whether user confirmation should be required for passive biometrics.

Public methods

getAuthFallback

Added in 1.4.0-alpha03
public final @NonNull AuthenticationRequest.Biometric.Fallback getAuthFallback()

The Fallback for the biometric authentication.

getContent

Added in 1.4.0-alpha03
public final AuthenticationRequest.BodyContent getContent()

The optional BodyContent of the prompt.

getLogoBitmap

Added in 1.4.0-alpha03
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final Bitmap getLogoBitmap()

getLogoDescription

Added in 1.4.0-alpha03
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final String getLogoDescription()

getLogoRes

Added in 1.4.0-alpha03
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final int getLogoRes()

getMinStrength

Added in 1.4.0-alpha03
public final @NonNull AuthenticationRequest.Biometric.Strength getMinStrength()

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.

getSubtitle

Added in 1.4.0-alpha03
public final String getSubtitle()

The optional subtitle of the prompt.

getTitle

Added in 1.4.0-alpha03
public final @NonNull String getTitle()

The title of the prompt.

isConfirmationRequired

Added in 1.4.0-alpha03
public final boolean isConfirmationRequired()

Whether user confirmation should be required for passive biometrics.