BiometricManager.Strings

public static class BiometricManager.Strings
extends Object

java.lang.Object
   ↳ androidx.biometric.BiometricManager.Strings


Provides localized strings for an application that uses BiometricPrompt to authenticate the user.

Summary

Public methods

CharSequence getButtonLabel()

Provides a localized string that can be used as the label for a button that invokes BiometricPrompt.

CharSequence getPromptMessage()

Provides a localized string that can be shown while the user is authenticating with BiometricPrompt.

CharSequence getSettingName()

Provides a localized string that can be shown as the title for an app setting that allows authentication with BiometricPrompt.

Inherited methods

Public methods

getButtonLabel

public CharSequence getButtonLabel ()

Provides a localized string that can be used as the label for a button that invokes BiometricPrompt.

When possible, this method should use the given authenticator requirements to more precisely specify the authentication type that will be used. For example, if Class 3 biometric authentication is requested on a device with a Class 3 fingerprint sensor and a Class 2 face sensor, the returned string should indicate that fingerprint authentication will be used.

This method should also try to specify which authentication method(s) will be used in practice when multiple authenticators meet the given requirements. For example, if biometric authentication is requested on a device with both face and fingerprint sensors but the user has selected face as their preferred method, the returned string should indicate that face authentication will be used.

This method may return null if none of the requested authenticator types are available, but this should not be relied upon for checking the status of authenticators. Instead, use BiometricManager.canAuthenticate(int).

Requires the USE_BIOMETRIC permission.

Returns
CharSequence The label for a button that invokes BiometricPrompt for authentication.

getPromptMessage

public CharSequence getPromptMessage ()

Provides a localized string that can be shown while the user is authenticating with BiometricPrompt.

When possible, this method should use the given authenticator requirements to more precisely specify the authentication type that will be used. For example, if Class 3 biometric authentication is requested on a device with a Class 3 fingerprint sensor