Package-level declarations

Types

Link copied to clipboard
data class StytchAPIError(val requestId: String? = null, val errorType: String, val message: String, val url: String? = null) : StytchError

An error class representing a non-schema error that occurs in the Stytch API

Link copied to clipboard
data class StytchAPISchemaError(val message: String) : StytchError

An error class representing a schema error that occurs in the Stytch API

Link copied to clipboard
data class StytchAPIUnreachableError(val message: String, val exception: Throwable? = null) : StytchError

An error that occurs when the Stytch SDK cannot reach the API. This may mean that there is a network error, or an error occurred while creating the request

Link copied to clipboard

Thrown when biometric authentication has failed, providing a reason if available

Link copied to clipboard

Thrown when a challenge signing (biometrics, passkeys) has failed

Link copied to clipboard

A type of error that can occur during deeplink handling

Link copied to clipboard

Thrown when we attempted to handle a deeplink, but no token was found

Link copied to clipboard

Thrown when we were passed an unknown deeplink token type

Link copied to clipboard
sealed class StytchError : Exception

A base error class for all errors returned by the Stytch SDK

Link copied to clipboard

Thrown when we couldn't create a code challenge on device

Link copied to clipboard

Thrown when there was an error decrypting data from persistent storage

Link copied to clipboard
data class StytchInternalError(val exception: Throwable? = null, val message: String = "An internal error has occurred. Please contact Stytch if this occurs.") : StytchSDKError

Thrown when all else fails. We should audit our usage of this and see if it makes sense to create classes for these

Thrown when the Google OneTap client or nonce is missing

Link copied to clipboard

Thrown when the keystore is unavailable, but the developer did not pass allowFallbackToCleartext=true

Thrown when the Google OneTap authorization credential was missing an id_token

Link copied to clipboard
data class StytchMissingPKCEError(val exception: Throwable?) : StytchSDKError

Thrown when we couldn't find a code verifier on device

Link copied to clipboard

Thrown when we are unable to retrieve a biometric key

Link copied to clipboard

Thrown when there are no biometric registrations present on the device

Link copied to clipboard

Thrown when there is no current session persisted on device

Link copied to clipboard

Thrown when you attempt to perform a passkey flow on a device that does not support passkeys

Link copied to clipboard

A base class representing SDK specific errors or exceptions that may occur. This class should not be used directly, rather we should be creating implementations for each of the known/expected errors we return.

Link copied to clipboard
data class StytchSDKNotConfiguredError(val clientName: String) : StytchSDKError

Thrown when you try to use the SDK before it has been configured

Link copied to clipboard
data class StytchSSOError(val exception: Throwable? = null) : StytchSDKError

Thrown when we encounter an SSO error

Link copied to clipboard
data class StytchUIActivityFailed(val code: Int) : StytchUIError

Thrown when the UI Activity failed

Link copied to clipboard
sealed class StytchUIError : StytchError

A base class representing SDK specific errors or exceptions that may occur. This class should not be used directly, rather we should be creating implementations for each of the known/expected errors we return.

Link copied to clipboard

Thrown when your Stytch UI configuration is invalid

Link copied to clipboard

Thrown when there was an error parsing the activity intent

Link copied to clipboard
data class UnexpectedCredentialType(val credentialType: String) : StytchSDKError

Thrown when we receive an unexpected token type from Sign In With Google