RoomioError

An error reported by the Roomio SDK.

struct RoomioError

Overview

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.

code

The kind of failure.

let code: Code

errorDescription

var errorDescription: String? { get }

init(code:severity:isRetryable:message:underlying:)

Create an error.

init(code: Code, severity: Severity, isRetryable: Bool, message: String, underlying: String? = nil)

isRetryable

Whether trying again, for example by starting a new scan, may succeed.

let isRetryable: Bool

message

A readable description of the error, suitable for display and logging.

let message: String

severity

Whether the scan can continue.

let severity: Severity

underlying

A description of the underlying cause, when there is one. Useful for logging.

let underlying: String?