RvcCleanModeTrait.ModeTag

enum RvcCleanModeTrait.ModeTag : Enum, ClusterEnum

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

The ModeTags for RvcCleanMode.

Summary

Enum Values
`Auto`	Decides which options, features, and setting values to use.
`Day`	Provides a mode suitable for use during day time.
`DeepClean`	The device is optimized for improved cleaning.
`LowEnergy`	Optimizes for lower energy usage.
`LowNoise`	Optimizes for low noise operation.
`Max`	Uses the highest available setting value.
`Min`	Uses the lowest available setting value.
`Mop`	The device's mopping feature is enabled.
`Night`	Provides a mode suitable for use during night time.
`Quick`	Optimizes for faster completion.
`Quiet`	Operates silently or barely audibly.
`UnknownValue`	The enum value is out of range.
`Vacation`	Provides a mode suitable for use during vacations or other extended absences.
`Vacuum`	The device's vacuum feature is enabled.
`VacuumThenMop`	Vacuums then mops the relevant areas.

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

Public properties
`EnumEntries<RvcCleanModeTrait.ModeTag>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`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 RvcCleanModeTrait.ModeTag.Auto: RvcCleanModeTrait.ModeTag

Decides which options, features, and setting values to use.

Day

val RvcCleanModeTrait.ModeTag.Day: RvcCleanModeTrait.ModeTag

Provides a mode suitable for use during day time.

DeepClean

val RvcCleanModeTrait.ModeTag.DeepClean: RvcCleanModeTrait.ModeTag

The device is optimized for improved cleaning.

LowEnergy

val RvcCleanModeTrait.ModeTag.LowEnergy: RvcCleanModeTrait.ModeTag

Optimizes for lower energy usage.

LowNoise

val RvcCleanModeTrait.ModeTag.LowNoise: RvcCleanModeTrait.ModeTag

Optimizes for low noise operation.

Max

val RvcCleanModeTrait.ModeTag.Max: RvcCleanModeTrait.ModeTag

Uses the highest available setting value.

Min

val RvcCleanModeTrait.ModeTag.Min: RvcCleanModeTrait.ModeTag

Uses the lowest available setting value.

Mop

val RvcCleanModeTrait.ModeTag.Mop: RvcCleanModeTrait.ModeTag

The device's mopping feature is enabled.

Night

val RvcCleanModeTrait.ModeTag.Night: RvcCleanModeTrait.ModeTag

Provides a mode suitable for use during night time.

Quick

val RvcCleanModeTrait.ModeTag.Quick: RvcCleanModeTrait.ModeTag

Optimizes for faster completion.

Quiet

val RvcCleanModeTrait.ModeTag.Quiet: RvcCleanModeTrait.ModeTag

Operates silently or barely audibly.

UnknownValue

val RvcCleanModeTrait.ModeTag.UnknownValue: RvcCleanModeTrait.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 RvcCleanModeTrait.ModeTag.Vacation: RvcCleanModeTrait.ModeTag

Provides a mode suitable for use during vacations or other extended absences.

Vacuum

val RvcCleanModeTrait.ModeTag.Vacuum: RvcCleanModeTrait.ModeTag

The device's vacuum feature is enabled.

VacuumThenMop

val RvcCleanModeTrait.ModeTag.VacuumThenMop: RvcCleanModeTrait.ModeTag

Vacuums then mops the relevant areas.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): RvcCleanModeTrait.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<RvcCleanModeTrait.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

entries

val entries: EnumEntries<RvcCleanModeTrait.ModeTag>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

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.