HomeError

class HomeError : BaseHomeError


Representation of an error that happened during an API call. The code allows the developers to reference the documentation for more information.

Summary

Public constructors

HomeError(message: String, domain: HomeErrorDomain?, reason: String?)
HomeError(
    code: Int,
    message: String,
    domain: HomeErrorDomain?,
    reason: String?
)

Public functions

open operator Boolean
equals(other: Any?)
open Int

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.

Public constructors

HomeError

HomeError(message: String, domain: HomeErrorDomain? = null, reason: String? = null)

HomeError

HomeError(
    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 functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

code

open val codeInt

the error code in HomeException.Codes

domain

open val domainHomeErrorDomain?

the error domain

message

open val messageString

the error message

reason

open val reasonString?

the reason for the error which represents UPPER_SNAKE_CASE string.