RoomioError
class RoomioError(val code: RoomioError.Code, val severity: RoomioError.Severity, val isRetryable: Boolean, message: String, val underlying: Throwable? = null) : Exception
An error reported by the Roomio SDK.
New codes may be added in future releases. Decide how to respond from severity and isRetryable, and check code only where you want to handle a specific failure.
Constructors
| RoomioError | constructor(code: RoomioError.Code, severity: RoomioError.Severity, isRetryable: Boolean, message: String, underlying: Throwable? = null) |
Types
| Name | Summary |
|---|---|
| Code | @JvmInline value class Code(val raw: String) The kind of failure. New codes may be added in future releases, so include an else branch when you match on codes. |
| Severity | enum Severity : Enum<RoomioError.Severity> How serious an error is. |
Properties
| Name | Summary |
|---|---|
| code | val code: RoomioError.Code The kind of failure. |
| isRetryable | val isRetryable: Boolean Whether trying again, for example by starting a new scan, may succeed. |
| severity | val severity: RoomioError.Severity Whether the scan can continue. |
| underlying | val underlying: Throwable? = null The underlying cause, when there is one. Useful for logging. |
Functions
RoomioError
constructor(code: RoomioError.Code, severity: RoomioError.Severity, isRetryable: Boolean, message: String, underlying: Throwable? = null)
code
val code: RoomioError.Code
isRetryable
val isRetryable: Boolean
severity
val severity: RoomioError.Severity
toString
open override fun toString(): String
underlying
val underlying: Throwable? = null