Clerk Android API/com.clerk.api.network.serialization/ClerkResult/Failure

Failure

class Failure<out E : Any>(val error: E?, val throwable: Throwable? = null, val code: Int? = null, val errorType: ClerkResult.Failure.ErrorType = ErrorType.UNKNOWN, tags: Map<KClass<*>, Any> = emptyMap()) : ClerkResult<Nothing, E>

A unified failure type that contains all necessary error information.

Constructors

Failure

constructor(error: E?, throwable: Throwable? = null, code: Int? = null, errorType: ClerkResult.Failure.ErrorType = ErrorType.UNKNOWN, tags: Map<KClass<*>, Any> = emptyMap())

Types

ErrorType

enum ErrorType : Enum<ClerkResult.Failure.ErrorType>

Properties

code

val code: Int?

error

val error: E?

errorMessage

val ClerkResult.Failure<ClerkErrorResponse>.errorMessage: String

Convenience function to extract a user-facing error message from a ClerkResult.Failure.

errorType

val errorType: ClerkResult.Failure.ErrorType

resolvedCredentialFlowMessage

val ClerkResult.Failure<ClerkErrorResponse>.resolvedCredentialFlowMessage: String

shouldFallbackToOAuthFromGoogleOneTap

val ClerkResult.Failure<ClerkErrorResponse>.shouldFallbackToOAuthFromGoogleOneTap: Boolean

shouldSuppressAutomaticCredentialFlowError

val ClerkResult.Failure<ClerkErrorResponse>.shouldSuppressAutomaticCredentialFlowError: Boolean

Automatic credential flows start without user intent, so failures from the credential ceremony itself are logged instead of presented. Server rejections of a credential the user selected arrive as API failures and remain presentable.

shouldSuppressCredentialFlowError

val ClerkResult.Failure<ClerkErrorResponse>.shouldSuppressCredentialFlowError: Boolean

Functions

exceptionOrNull

fun <E : Any> ClerkResult.Failure<E>.exceptionOrNull(): Throwable?

Returns the encapsulated Throwable exception if this is a failure.

shortErrorMessageOrNull

fun ClerkResult.Failure<ClerkErrorResponse>.shortErrorMessageOrNull(): String?

Convenience function to extract the first error message from a ClerkResult.Failure containing a ClerkErrorResponse. Returns null if the error is not a ClerkErrorResponse or if there are no error messages.

withTags

fun withTags(tags: Map<KClass<*>, Any>): ClerkResult.Failure<E>