LaundryWasherModeTrait.ModeTag

enum LaundryWasherModeTrait.ModeTag : Enum, ClusterEnum


The ModeTags for LaundryWasherMode.

Summary

Enum Values

Auto
Day
Delicate

Mode optimized for washing delicate garments.

Heavy

Mode optimized for heavy washing.

LowEnergy
LowNoise
Max
Min
Night
Normal

The normal regimen of operation.

Quick
Quiet
UnknownValue

The enum value is out of range.

Vacation
Whites

Mode optimized for stain removal on white fabrics.

Public functions

LaundryWasherModeTrait.ModeTag
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<LaundryWasherModeTrait.ModeTag>

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

Public properties

open String

Trait identifier of the Matter Cluster that defines the enum Data Type.

open String

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

open ULong

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

Enum Values

Delicate

val LaundryWasherModeTrait.ModeTag.DelicateLaundryWasherModeTrait.ModeTag

Mode optimized for washing delicate garments.

Heavy

val LaundryWasherModeTrait.ModeTag.HeavyLaundryWasherModeTrait.ModeTag

Mode optimized for heavy washing.

Normal

val LaundryWasherModeTrait.ModeTag.NormalLaundryWasherModeTrait.ModeTag

The normal regimen of operation.

UnknownValue

val LaundryWasherModeTrait.ModeTag.UnknownValueLaundryWasherModeTrait.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.

Whites

val LaundryWasherModeTrait.ModeTag.WhitesLaundryWasherModeTrait.ModeTag

Mode optimized for stain removal on white fabrics.

Public functions

valueOf

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

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

typeName

open val typeNameString

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

value

open val valueULong

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