Language

BiometricManager.Strings.PromptMessage Property

Definition

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

public string? PromptMessage { get; }
member this.PromptMessage : string

Property Value

The string representation of PromptMessageFormatted, or null if that property is null.

Remarks

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

Android reference for android.hardware.biometrics.BiometricManager.Strings.getPromptMessage.

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.

Applies to