EmbeddedBiometricPrompt Class
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.
The embedded version of BiometricPrompt that allows client apps to pass in content to
display above the biometric prompt as a connected sheet.
[Android.Runtime.Register("android/hardware/biometrics/EmbeddedBiometricPrompt", ApiSince=37, DoNotGenerateAcw=true)]
public sealed class EmbeddedBiometricPrompt : Java.Lang.Object[<Android.Runtime.Register("android/hardware/biometrics/EmbeddedBiometricPrompt", ApiSince=37, DoNotGenerateAcw=true)>]
type EmbeddedBiometricPrompt = class
inherit Object- Inheritance
- Attributes
Remarks
The embedded version of BiometricPrompt that allows client apps to pass in content to display above the biometric prompt as a connected sheet.
Android reference for android.hardware.biometrics.EmbeddedBiometricPrompt.
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.
Fields
| Name | Description |
|---|---|
| StartModeDeferred |
Obsolete.
The prompt should be collapsed and display in the deferred/paused state. |
| StartModeImmediate |
Obsolete.
Start authentication immediately with the full prompt displayed. |
| StartModeImmediateUnlessOccluded |
Obsolete.
Start authentication immediately unless the embedded content height exceeds the maximum allowed dimensions. |
Properties
| Name | Description |
|---|---|
| AllowedAuthenticators |
Gets the type(s) of authenticators that may be invoked by the prompt. |
| AuthenticationExecutor |
Gets the executor used for the authentication callback. |
| AuthenticationPurpose |
Gets the authentication purpose for the prompt. |
| Class |
Returns the runtime class of this |
| ContentView |
Gets the content view, as set by Builder.setContentView(PromptContentView). |
| Description | |
| DescriptionFormatted |
Gets the description, as set by Builder.setDescription(CharSequence). |
| EmbeddedContentFactory |
Gets the factory that will create the content to display above the biometric prompt as a connected sheet. |
| ExistingAuthSessionId |
Returns the existing auth session id for BiometricPrompt. |
| FallbackOptions |
Gets the fallback options for the prompt. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IsConfirmationRequired |
Determines if explicit user confirmation is required by the prompt. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| LogoBitmap |
Gets the logo bitmap, as set by Builder.setLogoBitmap(Bitmap). |
| LogoDescription |
Gets the logo description, as set by Builder.setLogoDescription(String). |
| LogoRes |
Gets the drawable resource of the logo, as set by |
| NegativeButton |
Gets the negative button listener, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener). |
| NegativeButtonExecutor |
Gets the executor used for the negative button listener, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener). |
| NegativeButtonText | |
| NegativeButtonTextFormatted |
Gets the negative button text, as set by Builder.setNegativeButton(CharSequence,Executor,DialogInterface.OnClickListener). |
| NextTranslationOffset |
Gets the ending target layout translation offset in pixels (px) for the disappear (exit) animation. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| PreviousTranslationOffset |
Gets the starting layout translation offset in pixels (px) for the appear (entry) animation. |
| StyleSpec |
Returns a BiometricPromptStyleSpec containing the style specifications of BiometricPrompt |
| Subtitle | |
| SubtitleFormatted |
Gets the subtitle, as set by Builder.setSubtitle(CharSequence). |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| Title | |
| TitleFormatted |
Gets the title, as set by Builder.setTitle(CharSequence). |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetAuthenticationCallback() |
Gets the authentication callback used for the prompt. |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
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) |
| PauseAuthentication() |
Pauses biometric authentication and collapses the biometric prompt to the delayed state, displaying a button in its place. |
| ResumeAuthentication() |
Activates biometric authentication and starts the biometric sensor scanning if delayed authentication was configured. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| StartAuthenticationSession(CancellationSignal, EmbeddedBiometricPromptStartMode, IExecutor, EmbeddedBiometricPrompt+AuthenticationCallback) |
Starts an authentication session for embedded BiometricPrompt. |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (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, 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) |
| 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) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |