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)
HomeException
HomeException
HomeException
bulkError(subErrors: Map<String, HomeError>)

Used to inform callers of specific failures during a bulk operation
HomeException
cancelled(message: String)
HomeException
dataLoss(message: String)
HomeException
HomeException
HomeException
internal(message: String)
HomeException
HomeException
notFound(message: String)
HomeException
outOfRange(message: String)
HomeException
HomeException
HomeException
HomeException
HomeException
unavailable(message: String)
HomeException
HomeException
unknown(message: String)

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

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 = ""): HomeException

alreadyExists

fun alreadyExists(message: String = ""): HomeException

apiNotConnected

fun apiNotConnected(message: String = ""): 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 = ""): HomeException

dataLoss

fun dataLoss(message: String = ""): HomeException

deadlineExceeded

fun deadlineExceeded(message: String = ""): HomeException

failedPrecondition

fun failedPrecondition(message: String = ""): HomeException

internal

fun internal(message: String = ""): HomeException

invalidArgument

fun invalidArgument(message: String = ""): HomeException

notFound

fun notFound(message: String = ""): HomeException

outOfRange

fun outOfRange(message: String = ""): HomeException

permissionDenied

fun permissionDenied(message: String = ""): HomeException

resourceExhausted

fun resourceExhausted(message: String = ""): HomeException

sdkInitializationMissingInfo

fun sdkInitializationMissingInfo(message: String = ""): HomeException

unauthenticated

fun unauthenticated(message: String = ""): HomeException

unavailable

fun unavailable(message: String = ""): HomeException

unimplemented

fun unimplemented(message: String = ""): HomeException

unknown

fun unknown(message: String = ""): 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 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