EmbeddedBiometricPromptStartMode Enum

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.

public enum EmbeddedBiometricPromptStartMode

type EmbeddedBiometricPromptStartMode =

Inheritance: Enum
EmbeddedBiometricPromptStartMode

Fields

Name Value Description

Immediate

Name	Value	Description
Immediate	0	Start authentication immediately with the full prompt displayed. Android reference for `android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_IMMEDIATE`. 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.
ImmediateUnlessOccluded	1	Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. If authentication is started and the provided embedded content exceeds the maximum available space, the prompt displays in the deferred/paused state, where it shows a shorter bottom sheet with a down arrow button in place of the full prompt, and biometric sensors are not activated. Apps can listen for AuthenticationCallback.onAuthenticationPaused in this case, and respond by calling resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating. Android reference for `android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_IMMEDIATE_UNLESS_OCCLUDED`. 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.
Deferred	2	The prompt should be collapsed and display in the deferred/paused state. A shorter bottom sheet with a down arrow button is shown in place of the full prompt, and biometric sensors are not activated. Apps can call resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating. Android reference for `android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_DEFERRED`. 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.

Start authentication immediately with the full prompt displayed.

Android reference for android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_IMMEDIATE.

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.

ImmediateUnlessOccluded

Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. If authentication is started and the provided embedded content exceeds the maximum available space, the prompt displays in the deferred/paused state, where it shows a shorter bottom sheet with a down arrow button in place of the full prompt, and biometric sensors are not activated. Apps can listen for AuthenticationCallback.onAuthenticationPaused in this case, and respond by calling resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

Android reference for android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_IMMEDIATE_UNLESS_OCCLUDED.

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.

Deferred

The prompt should be collapsed and display in the deferred/paused state. A shorter bottom sheet with a down arrow button is shown in place of the full prompt, and biometric sensors are not activated. Apps can call resumeAuthentication() when ready to expand the bottom sheet to the full prompt and activate biometric sensors to begin authenticating.

Android reference for android.hardware.biometrics.EmbeddedBiometricPrompt.START_MODE_DEFERRED.

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