# BiometricPromptResult

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/BiometricPromptResult.kt+class:androidx.credentials.provider.BiometricPromptResult) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

*** ** * ** ***

<br />

```
class BiometricPromptResult
```

<br />

*** ** * ** ***

The result of a Biometric Prompt authentication flow, that is propagated to the provider if the provider requested for `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager` to handle the authentication flow.

An instance of this class will always be part of the final provider request, either the `https://developer.android.com/reference/kotlin/androidx/credentials/provider/ProviderGetCredentialRequest` or the `https://developer.android.com/reference/kotlin/androidx/credentials/provider/ProviderCreateCredentialRequest` that the provider receives after the user selects a `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry` or a `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry` respectively.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#BiometricPromptResult(androidx.credentials.provider.AuthenticationError)(authenticationError: https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError)` An unsuccessful biometric prompt result, denoting that authentication has failed. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#BiometricPromptResult(androidx.credentials.provider.AuthenticationResult)(authenticationResult: https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationResult)` A successful biometric prompt result, denoting that authentication has succeeded. |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#hashCode()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError?` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#authenticationError()` error information, non-null if the authentication flow has failured, meaning that `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#isSuccessful()` will be false in this case |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationResult?` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#authenticationResult()` the result of the authentication flow, non-null if the authentication flow was successful |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#isSuccessful()` whether the result is a success result, in which case `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#authenticationResult()` should be non-null |

## Public constructors

### BiometricPromptResult

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
BiometricPromptResult(authenticationError: AuthenticationError)
```

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

| Parameters |
|---|---|
| `authenticationError: https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError` | the error that caused the biometric prompt authentication flow to fail |

### BiometricPromptResult

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
BiometricPromptResult(authenticationResult: AuthenticationResult)
```

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

| Parameters |
|---|---|
| `authenticationResult: https://developer.android.com/reference/kotlin/androidx/credentials/provider/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](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
val authenticationError: AuthenticationError?
```

error information, non-null if the authentication flow has failured, meaning that `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#isSuccessful()` will be false in this case

### authenticationResult

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
val authenticationResult: AuthenticationResult?
```

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

### isSuccessful

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
val isSuccessful: Boolean
```

whether the result is a success result, in which case `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult#authenticationResult()` should be non-null