Added in API level 31

Summary: Methods | Inherited Methods

BiometricManager.Strings

---

Kotlin |Java

public static class BiometricManager.Strings
extends Object

java.lang.Object
↳	android.hardware.biometrics.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 enables authentication with BiometricPrompt.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getButtonLabel

Added in API level 31

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 Manifest.permission.USE_BIOMETRIC

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

getPromptMessage

Added in API level 31

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 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 Manifest.permission.USE_BIOMETRIC

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

getSettingName

Added in API level 31

public CharSequence getSettingName ()

Provides a localized string that can be shown as the title for an app setting that enables authentication 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 and a Class 2 face sensor, the returned string should indicate that fingerprint authentication will be used.

This method should not 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, the returned string should indicate that either face or fingerprint authentication may be used, regardless of whether the user has enrolled or selected either as their preferred method.

This method may return null if none of the requested authenticator types are supported by the system, but this should not be relied upon for checking the status of authenticators. Instead, use BiometricManager.canAuthenticate(int) or PackageManager.hasSystemFeature(String).
Requires Manifest.permission.USE_BIOMETRIC

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