matrix-sdk-android/org.matrix.android.sdk.api.failure/Failure

Failure

sealed class Failure : Throwable

This class allows to expose different kinds of error to be then handled by the application. As it is a sealed class, you typically use it like that : when(failure) { is NetworkConnection -> Unit is ServerError -> Unit is Unknown -> Unit }

Inheritors

UnrecognizedCertificateFailure

NetworkConnection

OtherServerError

RegistrationFlowError

Types

data class CryptoError(val error: MXCryptoError) : Failure

abstract class FeatureFailure : Failure

NetworkConnection

data class NetworkConnection(val ioException: IOException? = null) : Failure

OtherServerError

data class OtherServerError(val errorBody: String, val httpCode: Int) : Failure

When server send an error, but it cannot be interpreted as a MatrixError.

RegistrationFlowError

data class RegistrationFlowError(val registrationFlowResponse: RegistrationFlowResponse) : Failure

data class ServerError(val error: MatrixError, val httpCode: Int) : Failure

object SuccessError : Failure

data class Unknown(val throwable: Throwable? = null) : Failure

UnrecognizedCertificateFailure

data class UnrecognizedCertificateFailure(val url: String, val fingerprint: Fingerprint) : Failure

Functions

fun addSuppressed(p0: Throwable)

fillInStackTrace

open fun fillInStackTrace(): Throwable

getLocalizedMessage

open fun getLocalizedMessage(): String

fun Throwable.getRetryDelay(defaultValue: Long): Long

Get the retry delay in case of rate limit exceeded error, adding 100 ms, of defaultValue otherwise.

open fun getStackTrace(): Array<StackTraceElement>

fun getSuppressed(): Array<Throwable>

open fun initCause(p0: Throwable): Throwable

fun Throwable.is400(): Boolean

fun Throwable.is401(): Boolean

fun Throwable.is404(): Boolean

isHomeserverConnectionError

fun Throwable.isHomeserverConnectionError(): Boolean

isHomeserverUnavailable

fun Throwable.isHomeserverUnavailable(): Boolean

isInvalidPassword

fun Throwable.isInvalidPassword(): Boolean

isInvalidUIAAuth

fun Throwable.isInvalidUIAAuth(): Boolean

isInvalidUsername

fun Throwable.isInvalidUsername(): Boolean

isLimitExceededError

fun Throwable.isLimitExceededError(): Boolean

isLoginEmailUnknown

fun Throwable.isLoginEmailUnknown(): Boolean

isMissingEmailVerification

fun Throwable.isMissingEmailVerification(): Boolean

isRegistrationAvailabilityError

fun Throwable.isRegistrationAvailabilityError(): Boolean

isRegistrationDisabled

fun Throwable.isRegistrationDisabled(): Boolean

fun Throwable.isTokenError(): Boolean

isUnrecognisedCertificate

fun Throwable.isUnrecognisedCertificate(): Boolean

isUsernameInUse

fun Throwable.isUsernameInUse(): Boolean

fun Throwable.isWeakPassword(): Boolean

printStackTrace

open fun printStackTrace()

open fun printStackTrace(p0: PrintStream)

open fun printStackTrace(p0: PrintWriter)

open fun setStackTrace(p0: Array<StackTraceElement>)

shouldBeRetried

fun Throwable.shouldBeRetried(): Boolean

toRegistrationFlowResponse

fun Throwable.toRegistrationFlowResponse(): RegistrationFlowResponse?

Try to convert to a RegistrationFlowResponse. Return null in the cases it's not possible

fun Throwable.toScanFailure(): ScanFailure?

Try to convert to a ScanFailure. Return null in the cases it's not possible

fun Throwable.toScanFailure(): ScanFailure?

Properties

open val cause: Throwable?

open val message: String?