Enum HomeAuthorizationStatus

java.lang.Object

java.lang.Enum<HomeAuthorizationStatus>

com.codename1.home.HomeAuthorizationStatus

All Implemented Interfaces:

Comparable<HomeAuthorizationStatus>

public enum HomeAuthorizationStatus
extends Enum<HomeAuthorizationStatus>

Whether the user has granted this app access to their home.

Unlike the health API, this question has an honest answer on every backend: HomeKit publishes HMHomeManagerAuthorizationStatus and the Google Home APIs publish the account and structure grant. There is no read/write split -- a home is authorized as a whole, and what an app may do to a particular accessory is a property of the accessory, not of the grant.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHORIZED	Access granted.
DENIED	The user was asked and declined.
NOT_DETERMINED	The user has not been asked yet.
RESTRICTED	Blocked by parental controls or device management.
UNKNOWN	This port cannot answer the question because it has no backend to ask.

Method Summary

Modifier and Type	Method	Description
static HomeAuthorizationStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HomeAuthorizationStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, getDeclaringClass, getEnumValues, hashCode, name, ordinal, setEnumValues, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_DETERMINED

public static final HomeAuthorizationStatus NOT_DETERMINED

The user has not been asked yet. Call SmartHome.requestAuthorization().

AUTHORIZED

public static final HomeAuthorizationStatus AUTHORIZED

Access granted.

RESTRICTED

public static final HomeAuthorizationStatus RESTRICTED

Blocked by parental controls or device management. Asking again will not help.

DENIED

public static final HomeAuthorizationStatus DENIED

The user was asked and declined. Recoverable only through the system settings; see SmartHome.openHomeSettings().

UNKNOWN

public static final HomeAuthorizationStatus UNKNOWN

This port cannot answer the question because it has no backend to ask. Returned by the inert fallback and by the local simulated home.

Method Details

values

public static HomeAuthorizationStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HomeAuthorizationStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null