AuthenticationRequest

Kotlin |Java

public abstract class AuthenticationRequest

Known direct subclasses

AuthenticationRequest.Biometric, AuthenticationRequest.Credential

`AuthenticationRequest.Biometric`	A set of configurable options for how the `BiometricPrompt` should appear and behave with biometric authentication with fallbacks.
`AuthenticationRequest.Credential`	A set of configurable options for how the `BiometricPrompt` should appear and behave with device credential only.

Types for configuring authentication prompt with options that are commonly used together. For example, to perform a basic biometric authentication request do:

val request = biometricRequest(
    title = "title",
    authFallback = BiometricRequest.Fallback.NegativeButton("cancel")
) {
    setSubtitle("sub title")
    setMinStrength(BiometricRequest.Strength.Class2)
}

to perform a basic credential authentication request do:

val request = credentialRequest(
    title = "title",
) {
    setSubtitle("sub title")
}

Backward Compatibility Notes:

< API 30: Credential (device credential only) is not supported.
< API 28: For Biometric.Strength.Class3 + Biometric.Fallback.DeviceCredential, Biometric.Strength.Class3.cryptoObject cannot be used
API 28/29: Biometric.Strength.Class3 + Biometric.Fallback.DeviceCredential is not supported.

Summary

Nested types
`public final class AuthenticationRequest.Biometric extends AuthenticationRequest` A set of configurable options for how the `BiometricPrompt` should appear and behave with biometric authentication with fallbacks.
`public final class AuthenticationRequest.Biometric.Builder` Builder used to create an instance of `Biometric`.
`public abstract class AuthenticationRequest.Biometric.Fallback` Fallback options for the biometric authentication.
`public static class AuthenticationRequest.Biometric.Fallback.DeviceCredential extends AuthenticationRequest.Biometric.Fallback` Device credential as the fallback.
`public final class AuthenticationRequest.Biometric.Fallback.NegativeButton extends AuthenticationRequest.Biometric.Fallback` A customized negative button as the fallback.
`public abstract class AuthenticationRequest.Biometric.Strength` Types of biometric strength for the prompt.
`public static class AuthenticationRequest.Biometric.Strength.Class2 extends AuthenticationRequest.Biometric.Strength` Class 2 (formerly Weak).
`public final class AuthenticationRequest.Biometric.Strength.Class3 extends AuthenticationRequest.Biometric.Strength` Class 3 (formerly Strong).
`public abstract class AuthenticationRequest.BodyContent` Types of the body content to be displayed on the prompt.
`public final class AuthenticationRequest.BodyContent.ContentViewWithMoreOptionsButton extends AuthenticationRequest.BodyContent` A view with "more options" button.
`public final class AuthenticationRequest.BodyContent.PlainText extends AuthenticationRequest.BodyContent` Plain text description as body content.
`public final class AuthenticationRequest.BodyContent.VerticalList extends AuthenticationRequest.BodyContent` A vertical list as body content.
`public static class AuthenticationRequest.Companion`
`@RequiresApi(value = 30) public final class AuthenticationRequest.Credential extends AuthenticationRequest` A set of configurable options for how the `BiometricPrompt` should appear and behave with device credential only.
`public final class AuthenticationRequest.Credential.Builder` Builder used to create an instance of `Credential`.

AuthenticationRequest

Summary

Nested types