Class2BiometricAuthExtensionsKt

Added in 1.4.0-alpha02

Kotlin |Java

public final class Class2BiometricAuthExtensionsKt

Summary

Public methods
`static final @NonNull BiometricPrompt.AuthenticationResult`	`authenticate( @NonNull receiver, @NonNull host )` Shows an authentication prompt to the user.
`static final @NonNull BiometricPrompt.AuthenticationResult`	`authenticateWithClass2Biometrics( @NonNull Fragment receiver, @NonNull CharSequence title, @NonNull CharSequence negativeButtonText, CharSequence subtitle, CharSequence description, boolean confirmationRequired )` Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).
`static final @NonNull BiometricPrompt.AuthenticationResult`	`authenticateWithClass2Biometrics( @NonNull FragmentActivity receiver, @NonNull CharSequence title, @NonNull CharSequence negativeButtonText, CharSequence subtitle, CharSequence description, boolean confirmationRequired )` Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).
`static final @NonNull`	`startClass2BiometricAuthentication( @NonNull Fragment receiver, @NonNull CharSequence title, @NonNull CharSequence negativeButtonText, CharSequence subtitle, CharSequence description, boolean confirmationRequired, Executor executor, @NonNull callback )` Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).
`static final @NonNull`	`startClass2BiometricAuthentication( @NonNull FragmentActivity receiver, @NonNull CharSequence title, @NonNull CharSequence negativeButtonText, CharSequence subtitle, CharSequence description, boolean confirmationRequired, Executor executor, @NonNull callback )` Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Public methods

authenticate

Artifact: androidx.biometric:biometric-ktx

View Source

public static final @NonNull BiometricPrompt.AuthenticationResult authenticate(
    @NonNull  receiver,
    @NonNull  host
)

Shows an authentication prompt to the user.

import androidx.biometric.BiometricPrompt
import androidx.biometric.auth.AuthPromptErrorException
import androidx.biometric.auth.AuthPromptFailureException
import androidx.biometric.auth.AuthPromptHost
import androidx.biometric.auth.Class2BiometricAuthPrompt
import androidx.biometric.auth.authenticate

val payload = "A message to encrypt".toByteArray(Charset.defaultCharset())

// Construct AuthPrompt with localized Strings to be displayed to UI.
val authPrompt =
    Class2BiometricAuthPrompt.Builder(title, negativeButtonText)
        .apply {
            setSubtitle(subtitle)
            setDescription(description)
            setConfirmationRequired(true)
        }
        .build()

try {
    val authResult = authPrompt.authenticate(AuthPromptHost(this))

    // Encrypt a payload using the result of crypto-based auth.
    val encryptedPayload = authResult.cryptoObject?.cipher?.doFinal(payload)

    // Use the encrypted payload somewhere interesting.
    sendEncryptedPayload(encryptedPayload)
} catch (e: AuthPromptErrorException) {
    // Handle irrecoverable error during authentication.
    // Possible values for AuthPromptErrorException.errorCode are listed in the @IntDef,
    // androidx.biometric.BiometricPrompt.AuthenticationError.
} catch (e: AuthPromptFailureException) {
    // Handle auth failure due biometric credentials being rejected.
}

Parameters
`@NonNull host`	A wrapper for the component that will host the prompt.

Returns
`@NonNull BiometricPrompt.AuthenticationResult`	`AuthenticationResult` for a successful authentication.

Throws
`androidx.biometric.auth.AuthPromptErrorException`	when an unrecoverable error has been encountered and authentication has stopped.
`androidx.biometric.auth.AuthPromptFailureException`	when an authentication attempt by the user has been rejected.

See also
`Class2BiometricAuthPrompt.authenticate`	(AuthPromptHost, AuthPromptCallback)

authenticateWithClass2Biometrics

Artifact: androidx.biometric:biometric-ktx

View Source

public static final @NonNull BiometricPrompt.AuthenticationResult authenticateWithClass2Biometrics(
    @NonNull Fragment receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

Parameters
`@NonNull CharSequence title`	The title to be displayed on the prompt.
`@NonNull CharSequence negativeButtonText`	The label for the negative button on the prompt.
`CharSequence subtitle`	An optional subtitle to be displayed on the prompt.
`CharSequence description`	An optional description to be displayed on the prompt.
`boolean confirmationRequired`	Whether user confirmation should be required for passive biometrics.

Returns
`@NonNull BiometricPrompt.AuthenticationResult`	`AuthenticationResult` for a successful authentication.

Throws
`androidx.biometric.auth.AuthPromptErrorException`	when an unrecoverable error has been encountered and authentication has stopped.
`androidx.biometric.auth.AuthPromptFailureException`	when an authentication attempt by the user has been rejected.

See also
`Class2BiometricAuthPrompt`

authenticateWithClass2Biometrics

Artifact: androidx.biometric:biometric-ktx

View Source

public static final @NonNull BiometricPrompt.AuthenticationResult authenticateWithClass2Biometrics(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

Parameters
`@NonNull CharSequence title`	The title to be displayed on the prompt.
`@NonNull CharSequence negativeButtonText`	The label for the negative button on the prompt.
`CharSequence subtitle`	An optional subtitle to be displayed on the prompt.
`CharSequence description`	An optional description to be displayed on the prompt.
`boolean confirmationRequired`	Whether user confirmation should be required for passive biometrics.

Returns
`@NonNull BiometricPrompt.AuthenticationResult`	`AuthenticationResult` for a successful authentication.

Throws
`androidx.biometric.auth.AuthPromptErrorException`	when an unrecoverable error has been encountered and authentication has stopped.
`androidx.biometric.auth.AuthPromptFailureException`	when an authentication attempt by the user has been rejected.

See also
`Class2BiometricAuthPrompt`

startClass2BiometricAuthentication

Artifact: androidx.biometric:biometric-ktx

View Source

public static final @NonNull  startClass2BiometricAuthentication(
    @NonNull Fragment receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired,
    Executor executor,
    @NonNull  callback
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

Parameters
`@NonNull CharSequence title`	The title to be displayed on the prompt.
`@NonNull CharSequence negativeButtonText`	The label for the negative button on the prompt.
`CharSequence subtitle`	An optional subtitle to be displayed on the prompt.
`CharSequence description`	An optional description to be displayed on the prompt.
`boolean confirmationRequired`	Whether user confirmation should be required for passive biometrics.
`Executor executor`	An executor for `callback` methods. If `null`, these will run on the main thread.
`@NonNull callback`	The object that will receive and process authentication events.

Returns
`@NonNull`	An AuthPrompt handle to the shown prompt.

See also
`Class2BiometricAuthPrompt`

startClass2BiometricAuthentication

Artifact: androidx.biometric:biometric-ktx

View Source

public static final @NonNull  startClass2BiometricAuthentication(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired,
    Executor executor,
    @NonNull  callback
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

Parameters
`@NonNull CharSequence title`	The title to be displayed on the prompt.
`@NonNull CharSequence negativeButtonText`	The label for the negative button on the prompt.
`CharSequence subtitle`	An optional subtitle to be displayed on the prompt.
`CharSequence description`	An optional description to be displayed on the prompt.
`boolean confirmationRequired`	Whether user confirmation should be required for passive biometrics.
`Executor executor`	An executor for `callback` methods. If `null`, these will run on the main thread.
`@NonNull callback`	The object that will receive and process authentication events.

Returns
`@NonNull`	An AuthPrompt handle to the shown prompt.

See also
`Class2BiometricAuthPrompt`