BiometricManager.Strings.SettingNameFormatted Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a localized string that can be shown as the title for an app setting that
enables authentication with BiometricPrompt.
public virtual Java.Lang.ICharSequence? SettingNameFormatted { [Android.Runtime.Register("getSettingName", "()Ljava/lang/CharSequence;", "GetGetSettingNameHandler", ApiSince=31)] get; }[<get: Android.Runtime.Register("getSettingName", "()Ljava/lang/CharSequence;", "GetGetSettingNameHandler", ApiSince=31)>]
member this.SettingNameFormatted : Java.Lang.ICharSequenceProperty Value
The label for a button that invokes BiometricPrompt for authentication.
- Attributes
Remarks
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 <strong>Class 3</strong> biometric authentication is requested on a device with a <strong>Class 3</strong> fingerprint sensor and a <strong>Class 2</strong> face sensor, the returned string should indicate that fingerprint authentication will be used.
This method should <em>not</em> 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 <em>not</em> be relied upon for checking the status of authenticators. Instead, use #canAuthenticate(int) or android.content.pm.PackageManager#hasSystemFeature(String).
Java documentation for android.hardware.biometrics.BiometricManager.Strings.getSettingName().
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.