HomeException

class HomeException : Exception
kotlin.Any
   ↳ kotlin.Throwable
     ↳ java.lang.Exception
       ↳ com.google.home.HomeException

The exception thrown if any issue is encountered during an API call. Exceptions could be recoverable by the user of the API or unrecoverable. The error code in each exception needs to be documented to showcase the state.

Summary

Nested types

Public companion functions
HomeException
aborted(message: String, vararg subErrors: HomeError)
HomeException
alreadyExists(message: String, vararg subErrors: HomeError)
HomeException
apiNotConnected(message: String, vararg subErrors: HomeError)
HomeException
bulkError(subErrors: Map<String, HomeError>)

Used to inform callers of specific failures during a bulk operation
HomeException
cancelled(message: String, vararg subErrors: HomeError)
HomeException
dataLoss(message: String, vararg subErrors: HomeError)
HomeException
deadlineExceeded(message: String, vararg subErrors: HomeError)
HomeException
failedPrecondition(message: String, vararg subErrors: HomeError)
HomeException
internal(message: String, vararg subErrors: HomeError)
HomeException
invalidArgument(message: String, vararg subErrors: HomeError)
HomeException
notFound(message: String, vararg subErrors: HomeError)
HomeException
outOfRange(message: String, vararg subErrors: HomeError)
HomeException
permissionDenied(message: String, vararg subErrors: HomeError)
HomeException
resourceExhausted(message: String, vararg subErrors: HomeError)
HomeException
sdkInitializationMissingInfo(message: String, vararg subErrors: HomeError)
HomeException
unauthenticated(message: String, vararg subErrors: HomeError)
HomeException
unavailable(message: String, vararg subErrors: HomeError)
HomeException
unimplemented(message: String, vararg subErrors: HomeError)
HomeException
unknown(message: String, vararg subErrors: HomeError)

Public constructors
HomeException(
    error: HomeError,
    exception: Exception?,
    subErrors: Map<String, HomeError>
)
HomeException(
    code: Int,
    message: String,
    exception: Exception?,
    subErrors: Map<String, HomeError>
)

Public functions
List<Int>

Returns the error codes of the sub errors.

Public properties
HomeError

the home error that occurred
Map<String, HomeError>

any errors that were from sub operations, usually only set for bulk operations

Inherited functions
From kotlin.Throwable
Unit
open Throwable
open String
open Array<StackTraceElement>
Array<Throwable>
open Throwable
open Unit
open Unit
open Unit
open Unit

Inherited properties
From kotlin.Throwable
open Throwable?
open String?

Public companion functions

aborted

fun aborted(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

alreadyExists

fun alreadyExists(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

apiNotConnected

fun apiNotConnected(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

bulkError

fun bulkError(subErrors: Map<String, HomeError>): HomeException

Used to inform callers of specific failures during a bulk operation

cancelled

fun cancelled(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

dataLoss

fun dataLoss(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

deadlineExceeded

fun deadlineExceeded(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

failedPrecondition

fun failedPrecondition(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

internal

fun internal(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

invalidArgument

fun invalidArgument(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

notFound

fun notFound(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

outOfRange

fun outOfRange(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

permissionDenied

fun permissionDenied(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

resourceExhausted

fun resourceExhausted(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

sdkInitializationMissingInfo

fun sdkInitializationMissingInfo(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

unauthenticated

fun unauthenticated(
    message: String = "",
    vararg subErrors: HomeError = emptyArray()
): HomeException

unavailable

fun unavailable(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

unimplemented

fun unimplemented(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

unknown

fun unknown(message: String = "", vararg subErrors: HomeError = emptyArray()): HomeException

Public constructors

HomeException

HomeException(
    error: HomeError,
    exception: Exception? = null,
    subErrors: Map<String, HomeError> = emptyMap()
)
Parameters
error: HomeError

the home error that occurred
exception: Exception? = null

another exception that caused this one
subErrors: Map<String, HomeError> = emptyMap()

any errors that were from sub operations, usually only set for bulk operations

HomeException

HomeException(
    code: Int,
    message: String,
    exception: Exception? = null,
    subErrors: Map<String, HomeError> = emptyMap()
)

Public functions

getSubErrorCodes

fun getSubErrorCodes(): List<Int>

Returns the error codes of the sub errors. The error codes are returned in the format of * 100 + . For example, if the parent error code is 13 (INTERNAL) and the sub error code is 5 (STRUCTURE_FLOW_FAILED), the returned value will be 1305.

Public properties

error

val error: HomeError

the home error that occurred

subErrors

val subErrors: Map<String, HomeError>

any errors that were from sub operations, usually only set for bulk operations