# AuthenticationError

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

*** ** * ** ***

<br />

```
class AuthenticationError
```

<br />

*** ** * ** ***

Error returned from the Biometric Prompt flow that is executed by `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager` after the user makes a selection on the Credential Manager account selector.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationErrorTypes` |   |

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#AuthenticationError(kotlin.Int,kotlin.CharSequence)(errorCode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, errorMsg: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?)` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#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/AuthenticationError#hashCode()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#errorCode()` the error code denoting what kind of error was encountered while the biometric prompt flow failed, must be one of the error codes defined in `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt` such as `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricConstants#ERROR_HW_UNAVAILABLE()` or `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricConstants#ERROR_TIMEOUT()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#errorMsg()` the message associated with the `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#errorCode()` in the form that can be displayed on a UI. |

## Public constructors

### AuthenticationError

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

```
AuthenticationError(errorCode: Int, errorMsg: CharSequence? = null)
```

## Public functions

### equals

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

### hashCode

```
open fun hashCode(): Int
```

## Public properties

### errorCode

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

```
val errorCode: Int
```

the error code denoting what kind of error was encountered while the biometric prompt flow failed, must be one of the error codes defined in `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt` such as `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricConstants#ERROR_HW_UNAVAILABLE()` or `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricConstants#ERROR_TIMEOUT()`

### errorMsg

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

```
val errorMsg: CharSequence?
```

the message associated with the `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError#errorCode()` in the form that can be displayed on a UI.