BiometricPromptResult

Artifact: androidx.credentials:credentials

Kotlin |Java

class BiometricPromptResult

The result of a Biometric Prompt authentication flow, that is propagated to the provider if the provider requested for androidx.credentials.CredentialManager to handle the authentication flow.

An instance of this class will always be part of the final provider request, either the ProviderGetCredentialRequest or the ProviderCreateCredentialRequest that the provider receives after the user selects a CredentialEntry or a CreateEntry respectively.

Summary

Public constructors
`BiometricPromptResult(authenticationError: AuthenticationError)` An unsuccessful biometric prompt result, denoting that authentication has failed.
`BiometricPromptResult(authenticationResult: AuthenticationResult)` A successful biometric prompt result, denoting that authentication has succeeded.

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`

Public properties
`AuthenticationError?`	`authenticationError` error information, non-null if the authentication flow has failured, meaning that `isSuccessful` will be false in this case
`AuthenticationResult?`	`authenticationResult` the result of the authentication flow, non-null if the authentication flow was successful
`Boolean`	`isSuccessful` whether the result is a success result, in which case `authenticationResult` should be non-null

Public constructors

BiometricPromptResult

Added in 1.5.0-alpha02

BiometricPromptResult(authenticationError: AuthenticationError)

An unsuccessful biometric prompt result, denoting that authentication has failed.

Parameters
`authenticationError: AuthenticationError`	the error that caused the biometric prompt authentication flow to fail

BiometricPromptResult

Added in 1.5.0-alpha02

BiometricPromptResult(authenticationResult: AuthenticationResult)

A successful biometric prompt result, denoting that authentication has succeeded.

Parameters
`authenticationResult: AuthenticationResult`	the result after a successful biometric prompt authentication operation

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

authenticationError

Added in 1.5.0-alpha02

val authenticationError: AuthenticationError?

error information, non-null if the authentication flow has failured, meaning that isSuccessful will be false in this case

authenticationResult

Added in 1.5.0-alpha02

val authenticationResult: AuthenticationResult?

the result of the authentication flow, non-null if the authentication flow was successful

isSuccessful

Added in 1.5.0-alpha02

val isSuccessful: Boolean

whether the result is a success result, in which case authenticationResult should be non-null