Types

Link copied to clipboard

The user can't authenticate because the hardware is unavailable. Try again later.

Link copied to clipboard
data class BiometricErrorNoHardware(val errorMessage: String) : TSBiometricsAuthError

The user can't authenticate because there is no suitable hardware (e.g. no biometric sensor or no keyguard).

Link copied to clipboard

The user can't authenticate because no biometric or device credential is enrolled.

Link copied to clipboard

The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors. The affected sensor(s) are unavailable until a security update has addressed the issue.

Link copied to clipboard

Unable to determine whether the user can authenticate.

Link copied to clipboard

The user can't authenticate because the specified options are incompatible with the current Android version.

Link copied to clipboard
data class Canceled(val errorMsg: String) : TSBiometricsAuthError

Authentication was cancelled by the system (e.g. another window came to foreground).

Link copied to clipboard
data class InternalError(val message: String, val t: Throwable? = null) : TSBiometricsAuthError

Internal error occurred

Link copied to clipboard
data class Lockout(val errorMsg: String) : TSBiometricsAuthError

Too many failed attempts. Biometric authentication is temporarily locked out.

Link copied to clipboard
data class LockoutPermanent(val errorMsg: String) : TSBiometricsAuthError

Too many failed attempts across sessions. Biometric authentication is permanently locked out until the user re-enrolls or unlocks with device credentials.

Link copied to clipboard
data class NegativeButton(val errorMsg: String) : TSBiometricsAuthError

The user tapped the negative button on the biometric prompt (e.g. "Cancel" or "Use password").

Link copied to clipboard
data class NetworkError(val message: String, val t: Throwable? = null) : TSBiometricsAuthError

Network Error

Link copied to clipboard
data class NoMatch(val errorMsg: String?) : TSBiometricsAuthError

Biometric did not match. The presented biometric was not recognised.

Link copied to clipboard
data class NoSpace(val errorMsg: String) : TSBiometricsAuthError

No space available to store credentials.

Link copied to clipboard
data class NOT_REGISTERED(val message: String, val t: Throwable? = null) : TSBiometricsAuthError

No registered biometrics for this user.

Link copied to clipboard
data class Other(val errorMsg: String?, val t: Throwable?) : TSBiometricsAuthError

An unexpected error occurred that does not fit any other category.

Link copied to clipboard

SDK was not initialized

Link copied to clipboard
data class TimeOut(val errorMsg: String) : TSBiometricsAuthError

Authentication timed out. The biometric prompt was displayed too long without user interaction.

Link copied to clipboard
data class UnableToProcess(val errorMsg: String) : TSBiometricsAuthError

The biometric prompt could not process the request.

Link copied to clipboard
data class UnKnown(val errorMsg: String?) : TSBiometricsAuthError

An unknown biometric error occurred.

Link copied to clipboard
data class UserCanceled(val errorMsg: String) : TSBiometricsAuthError

The user dismissed the biometric prompt.

Properties

Link copied to clipboard
val eM: String?
Link copied to clipboard