Core/io.telereso.kmp.core.models/ClientException

ClientException

@Serializable

open class ClientException(val message: String? = null, val cause: Throwable? = null, val httpStatusCode: Int? = null, val errorBody: ErrorBody? = null, val errorString: String? = null, val errorType: String? = null, val httpURl: String? = null, val code: String? = null, val failureCount: Int? = null) : Throwable

ClientException class wraps exception and throwable across the code base. We encourage to use this class when dealing with Http Error response or throwing exceptions .

Parameters

httpStatusCode

the API code returned e.g 500, 400

errorBody

The error returned as a Json string.

message

the message related to this Exception.

cause

the cause related to this exception.

errorType

the string error type returned from API/ e.g INVALID_USERNAME_PASSWORD

Constructors

ClientException

constructor(cause: Throwable? = null)

constructor(message: String? = null, cause: Throwable? = null, httpStatusCode: Int? = null, errorBody: ErrorBody? = null, errorString: String? = null, errorType: String? = null, httpURl: String? = null, code: String? = null, failureCount: Int? = null)

Types

Companion

object Companion

class companion class

Properties

cause

@Serializable(with = ThrowableSerializer::class)

open override val cause: Throwable? = null

code

val code: String? = null

errorBody

val errorBody: ErrorBody? = null

errorString

val errorString: String? = null

errorType

val errorType: String? = null

failureCount

val failureCount: Int? = null

httpStatusCode

val httpStatusCode: Int? = null

httpURl

val httpURl: String? = null

message

open override val message: String? = null

Functions

asClientException

fun Throwable.asClientException(failureCount: Int = 0): ClientException

provides a safe casting of throwable converts any throwable into a ClientException. Clients don't need to perform casting as its handled on the SDK level.

isCancellationException

fun isCancellationException(): Boolean

toClientException

suspend fun Throwable.toClientException(failureCount: Int = 0): ClientException

provides a safe suspended casting of throwable converts any throwable into a ClientException. Clients don't need to perform casting as its handled on the SDK level.

toNSError

fun ClientException.toNSError(): NSError

Converts a ClientException into an NSError object for better interop with Objective-C, Swift projects.

toString

open override fun toString(): String

Custom implementation of the toString() function.