OvenModeTrait.ModeTag

enum OvenModeTrait.ModeTag : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.OvenModeTrait.ModeTag

Descriptive names of oven modes.

Summary

Enum Values
`Auto`
`Bake`	Bake mode.
`Clean`	Clean mode.
`Convection`	Convection mode.
`ConvectionBake`	Convection bake mode.
`ConvectionRoast`	Convection roast mode.
`Day`
`Grill`	Grill mode.
`LowEnergy`
`LowNoise`
`Max`
`Min`
`Night`
`Proofing`	Proofing mode.
`Quick`
`Quiet`
`Roast`	Roast mode.
`UnknownValue`	The enum value is out of range.
`Vacation`
`Warming`	Warming mode.

Public functions
`OvenModeTrait.ModeTag`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<OvenModeTrait.ModeTag>`	`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

Auto

val OvenModeTrait.ModeTag.Auto: OvenModeTrait.ModeTag

Bake

val OvenModeTrait.ModeTag.Bake: OvenModeTrait.ModeTag

Bake mode.

Clean

val OvenModeTrait.ModeTag.Clean: OvenModeTrait.ModeTag

Clean mode.

Convection

val OvenModeTrait.ModeTag.Convection: OvenModeTrait.ModeTag

Convection mode.

ConvectionBake

val OvenModeTrait.ModeTag.ConvectionBake: OvenModeTrait.ModeTag

Convection bake mode.

ConvectionRoast

val OvenModeTrait.ModeTag.ConvectionRoast: OvenModeTrait.ModeTag

Convection roast mode.

Day

val OvenModeTrait.ModeTag.Day: OvenModeTrait.ModeTag

Grill

val OvenModeTrait.ModeTag.Grill: OvenModeTrait.ModeTag

Grill mode.

LowEnergy

val OvenModeTrait.ModeTag.LowEnergy: OvenModeTrait.ModeTag

LowNoise

val OvenModeTrait.ModeTag.LowNoise: OvenModeTrait.ModeTag

Max

val OvenModeTrait.ModeTag.Max: OvenModeTrait.ModeTag

Min

val OvenModeTrait.ModeTag.Min: OvenModeTrait.ModeTag

Night

val OvenModeTrait.ModeTag.Night: OvenModeTrait.ModeTag

Proofing

val OvenModeTrait.ModeTag.Proofing: OvenModeTrait.ModeTag

Proofing mode.

Quick

val OvenModeTrait.ModeTag.Quick: OvenModeTrait.ModeTag

Quiet

val OvenModeTrait.ModeTag.Quiet: OvenModeTrait.ModeTag

Roast

val OvenModeTrait.ModeTag.Roast: OvenModeTrait.ModeTag

Roast mode.

UnknownValue

val OvenModeTrait.ModeTag.UnknownValue: OvenModeTrait.ModeTag

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.

Vacation

val OvenModeTrait.ModeTag.Vacation: OvenModeTrait.ModeTag

Warming

val OvenModeTrait.ModeTag.Warming: OvenModeTrait.ModeTag

Warming mode.

Public functions

valueOf

fun valueOf(value: String): OvenModeTrait.ModeTag

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<OvenModeTrait.ModeTag>

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.