AuthenticationError

Artifact: androidx.credentials:credentials

View Source

Added in 1.5.0-alpha02

---

Kotlin |Java

class AuthenticationError

---

Error returned from the Biometric Prompt flow that is executed by androidx.credentials.CredentialManager after the user makes a selection on the Credential Manager account selector.

See also
AuthenticationErrorTypes

Summary

Public constructors
AuthenticationError(errorCode: Int, errorMsg: CharSequence?)

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

Public properties
Int	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 androidx.biometric.BiometricPrompt such as androidx.biometric.BiometricPrompt.ERROR_HW_UNAVAILABLE or androidx.biometric.BiometricPrompt.ERROR_TIMEOUT
CharSequence?	errorMsg the message associated with the errorCode in the form that can be displayed on a UI.

Public constructors

AuthenticationError

Added in 1.5.0-alpha02

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-alpha02

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 androidx.biometric.BiometricPrompt such as androidx.biometric.BiometricPrompt.ERROR_HW_UNAVAILABLE or androidx.biometric.BiometricPrompt.ERROR_TIMEOUT

errorMsg

Added in 1.5.0-alpha02

val errorMsg: CharSequence?

the message associated with the errorCode in the form that can be displayed on a UI.