livekit-android-sdk/io.livekit.android.rpc/RpcError

RpcError

data class RpcError(val code: Int, val message: String, val data: String = "", val cause: Throwable? = null) : Exception

Specialized error handling for RPC methods.

Instances of this type, when thrown in a RPC method handler, will have their message serialized and sent across the wire. The sender will receive an equivalent error on the other side.

Built-in types are included but developers may use any message string, with a max length of 256 bytes.

Constructors

RpcError

constructor(code: Int, message: String, data: String = "", cause: Throwable? = null)

Types

BuiltinRpcError

enum BuiltinRpcError : Enum<RpcError.BuiltinRpcError>

Companion

object Companion

Properties

cause

open override val cause: Throwable? = null

The local cause of the error, if any. This will not be passed over the wire to the remote.

code

val code: Int

The error code of the RPC call. Error codes 1001-1999 are reserved for built-in errors.

data

val data: String

An optional data payload. Must be smaller than 15KB in size, or else will be truncated.

message

open override val message: String

A message to include. Strings over 256 bytes will be truncated.

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>)

toProto

fun toProto(): <Error class: unknown class>