ExtendedThermostatTrait.PresetScenario

enum ExtendedThermostatTrait.PresetScenario : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.google.ExtendedThermostatTrait.PresetScenario

The type of preset.

Summary

Enum Values
`Away`	Away, also known as Leave.
`Comfort`	Temperature is optimized for comfort.
`Eco`	Energy-saving mode.
`Home`	Home, also known as Return.
`Occupied`	For use when the space is occupied.
`Sleep`	Temperature is optimized for sleeping.
`UnknownValue`	The enum value is out of range.
`Unoccupied`	For use when the space is vacant.
`Unspecified`	Unspecified.
`UserDefined`	User-defined preset.
`Vacation`	Temperature is optimized for vacation.
`Wake`	Temperature is optimized for when the user is awake.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`ExtendedThermostatTrait.PresetScenario`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<ExtendedThermostatTrait.PresetScenario>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

Away

val ExtendedThermostatTrait.PresetScenario.Away: ExtendedThermostatTrait.PresetScenario

Away, also known as Leave.

Comfort

val ExtendedThermostatTrait.PresetScenario.Comfort: ExtendedThermostatTrait.PresetScenario

Temperature is optimized for comfort.

Eco

val ExtendedThermostatTrait.PresetScenario.Eco: ExtendedThermostatTrait.PresetScenario

Energy-saving mode.

Home

val ExtendedThermostatTrait.PresetScenario.Home: ExtendedThermostatTrait.PresetScenario

Home, also known as Return.

Occupied

val ExtendedThermostatTrait.PresetScenario.Occupied: ExtendedThermostatTrait.PresetScenario

For use when the space is occupied.

Sleep

val ExtendedThermostatTrait.PresetScenario.Sleep: ExtendedThermostatTrait.PresetScenario

Temperature is optimized for sleeping.

UnknownValue

val ExtendedThermostatTrait.PresetScenario.UnknownValue: ExtendedThermostatTrait.PresetScenario

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

Unoccupied

val ExtendedThermostatTrait.PresetScenario.Unoccupied: ExtendedThermostatTrait.PresetScenario

For use when the space is vacant.

Unspecified

val ExtendedThermostatTrait.PresetScenario.Unspecified: ExtendedThermostatTrait.PresetScenario

Unspecified.

UserDefined

val ExtendedThermostatTrait.PresetScenario.UserDefined: ExtendedThermostatTrait.PresetScenario

User-defined preset.

Vacation

val ExtendedThermostatTrait.PresetScenario.Vacation: ExtendedThermostatTrait.PresetScenario

Temperature is optimized for vacation.

Wake

val ExtendedThermostatTrait.PresetScenario.Wake: ExtendedThermostatTrait.PresetScenario

Temperature is optimized for when the user is awake.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): ExtendedThermostatTrait.PresetScenario

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.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

fun values(): Array<ExtendedThermostatTrait.PresetScenario>

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

This method may be used to iterate over the constants.

Public properties

traitId

open val traitId: String

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.