lib/live.hms.video.error/HMSException

HMSException

class HMSException(val code: Int, val name: String, val action: String, val message: String, description: String, cause: Throwable? = null, var isTerminal: Boolean = true, params: HashMap<String, Any> = hashMapOf()) : Exception, IAnalyticsPropertiesProvider

This class contains the error codes and messages that may arise when calling any API of HMS SDK

Constructors

HMSException

fun HMSException(code: Int, name: String, action: String, message: String, description: String, cause: Throwable? = null, isTerminal: Boolean = true, params: HashMap<String, Any> = hashMapOf())

Functions

addSuppressed

fun addSuppressed(p0: Throwable)

fillInStackTrace

open fun fillInStackTrace(): Throwable

getLocalizedMessage

open fun getLocalizedMessage(): String

getStackTrace

open fun getStackTrace(): Array<StackTraceElement>

getSuppressed

fun getSuppressed(): Array<Throwable>

initCause

open fun initCause(p0: Throwable): Throwable

printStackTrace

open fun printStackTrace()

open fun printStackTrace(p0: PrintStream)

open fun printStackTrace(p0: PrintWriter)

setStackTrace

open fun setStackTrace(p0: Array<StackTraceElement>)

toAnalyticsProperties

open override fun toAnalyticsProperties(): HashMap<String, Any>

toString

open override fun toString(): String

Properties

action

val action: String

Action denotes the category which resulted in this error (Not so useful for UI)

cause

open val cause: Throwable?

code

val code: Int

The error code by which this error can be identified with

description

var description: String

isTerminal

var isTerminal: Boolean = true

This denotes if the SDK has cleaned up the connection due to this error or not. UI show show a notification or dialog according to this. If this is true it denotes that this error has removed user from the room else it denotes that user is still in the room even with this error

message

open override val message: String

The error message describing the error which can be shown on the UI

name

val name: String

The error name by which can be shown to user in UI