BiometricPrompt Class

Reference

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.

A class that manages a system-provided biometric dialog.

[Android.Runtime.Register("android/hardware/biometrics/BiometricPrompt", ApiSince=28, DoNotGenerateAcw=true)]
public class BiometricPrompt : Java.Lang.Object

[<Android.Runtime.Register("android/hardware/biometrics/BiometricPrompt", ApiSince=28, DoNotGenerateAcw=true)>]
type BiometricPrompt = class
    inherit Object

Inheritance: Object

Object
BiometricPrompt

Attributes: RegisterAttribute

Remarks

A class that manages a system-provided biometric dialog.

Java documentation for android.hardware.biometrics.BiometricPrompt.

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.

Constructors

BiometricPrompt(IntPtr, JniHandleOwnership)

Fields

AuthenticationResultTypeBiometric	Obsolete. Authentication type reported by `AuthenticationResult` when the user authenticated by presenting some form of biometric (e.
AuthenticationResultTypeDeviceCredential	Obsolete. Authentication type reported by `AuthenticationResult` when the user authenticated by entering their device PIN, pattern, or password.
BiometricAcquiredGood
BiometricAcquiredImagerDirty
BiometricAcquiredInsufficient
BiometricAcquiredPartial
BiometricAcquiredTooFast
BiometricAcquiredTooSlow
BiometricErrorCanceled
BiometricErrorHwNotPresent
BiometricErrorHwUnavailable
BiometricErrorLockout
BiometricErrorLockoutPermanent
BiometricErrorNoBiometrics
BiometricErrorNoDeviceCredential
BiometricErrorNoSpace
BiometricErrorSecurityUpdateRequired
BiometricErrorTimeout
BiometricErrorUnableToProcess
BiometricErrorUserCanceled
BiometricErrorVendor

Properties

AllowedAuthenticators	Gets the type(s) of authenticators that may be invoked by the prompt to authenticate the user, as set by `Builder#setAllowedAuthenticators(int)`.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Description
DescriptionFormatted	Gets the description for the prompt, as set by `Builder#setDescription(CharSequence)`.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsConfirmationRequired	Determines if explicit user confirmation is required by the prompt, as set by `Builder#setConfirmationRequired(boolean)`.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
NegativeButtonText
NegativeButtonTextFormatted	Gets the negative button text for the prompt, as set by `Builder#setNegativeButton(CharSequence, Executor, DialogInterface.OnClickListener)`.
PeerReference	(Inherited from Object)
Subtitle
SubtitleFormatted	Gets the subtitle for the prompt, as set by `Builder#setSubtitle(CharSequence)`.
ThresholdClass
ThresholdType
Title
TitleFormatted	Gets the title for the prompt, as set by `Builder#setTitle(CharSequence)`.

Methods

Authenticate(BiometricPrompt+CryptoObject, CancellationSignal, IExecutor, BiometricPrompt+AuthenticationCallback)	This call warms up the biometric hardware, displays a system-provided dialog, and starts scanning for a biometric.
Authenticate(CancellationSignal, IExecutor, BiometricPrompt+AuthenticationCallback)	This call warms up the biometric hardware, displays a system-provided dialog, and starts scanning for a biometric.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to