BaseHomeError

sealed class BaseHomeError

Known direct subclasses
HomeError

Representation of an error that happened during an API call.
MatterError

Base class for HomeError and MatterError.

Summary

Protected constructors
BaseHomeError(
    code: Int,
    message: String,
    domain: HomeErrorDomain?,
    reason: String?
)

Public properties
open Int

the error code in HomeException.Codes
open HomeErrorDomain?

the error domain
open String

the error message
open String?

the reason for the error which represents UPPER_SNAKE_CASE string.

Protected constructors

BaseHomeError

protected BaseHomeError(
    code: Int,
    message: String,
    domain: HomeErrorDomain? = null,
    reason: String? = null
)
Parameters
code: Int

the error code in HomeException.Codes
message: String

the error message
domain: HomeErrorDomain? = null

the error domain
reason: String? = null

the reason for the error which represents UPPER_SNAKE_CASE string.

Public properties

code

open val code: Int

the error code in HomeException.Codes

domain

open val domain: HomeErrorDomain?

the error domain

message

open val message: String

the error message

reason

open val reason: String?

the reason for the error which represents UPPER_SNAKE_CASE string.