EmbeddedBiometricPrompt.Builder.SetAuthenticationPurpose Method

Definition

Namespace:: Android.Hardware.Biometrics

Assembly:: Mono.Android.dll

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.

Optional: Sets the authentication purpose for the prompt.

[Android.Runtime.Register("setAuthenticationPurpose", "(I)Landroid/hardware/biometrics/EmbeddedBiometricPrompt$Builder;", "", ApiSince=37)]
public Android.Hardware.Biometrics.EmbeddedBiometricPrompt.Builder SetAuthenticationPurpose(Android.Hardware.Biometrics.BiometricManagerAuthenticationPurpose purpose);

[<Android.Runtime.Register("setAuthenticationPurpose", "(I)Landroid/hardware/biometrics/EmbeddedBiometricPrompt$Builder;", "", ApiSince=37)>]
member this.SetAuthenticationPurpose : Android.Hardware.Biometrics.BiometricManagerAuthenticationPurpose -> Android.Hardware.Biometrics.EmbeddedBiometricPrompt.Builder

Parameters

purpose: BiometricManagerAuthenticationPurpose

The authentication purpose to set. Value is one of the following: BiometricManager.AUTHENTICATION_PURPOSE_UNKNOWN; BiometricManager.AUTHENTICATION_PURPOSE_PAYMENT; BiometricManager.AUTHENTICATION_PURPOSE_LOGIN

Returns

EmbeddedBiometricPrompt.Builder

This builder. This value cannot be null.

Attributes: RegisterAttribute

Remarks

Optional: Sets the authentication purpose for the prompt.

Provides a hint to customize the BiometricPrompt appearance to clarify what the user is authorizing. This is cosmetic only, can vary by device, and does not change security guarantees (see setAllowedAuthenticators(int)).

For example, this may inform the user to click or tap "to pay" instead of "to authenticate".

Android reference for android.hardware.biometrics.EmbeddedBiometricPrompt.Builder.setAuthenticationPurpose.

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