RvcRunModeTrait.ModeTag

enum RvcRunModeTrait.ModeTag : Enum, ClusterEnum


The ModeTags for RvcRunMode.

Summary

Enum Values

Cleaning

The device is cleaning or paused while in the middle of cleaning.

Idle

The device is doing something other than cleaning or mapping.

Mapping

The device is mapping.

UnknownValue

The enum value is out of range.

Public functions

RvcRunModeTrait.ModeTag
valueOf(value: String)

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

Array<RvcRunModeTrait.ModeTag>

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

Public properties

open String
open String
open ULong

Enum Values

Cleaning

val RvcRunModeTrait.ModeTag.CleaningRvcRunModeTrait.ModeTag

The device is cleaning or paused while in the middle of cleaning.

Idle

val RvcRunModeTrait.ModeTag.IdleRvcRunModeTrait.ModeTag

The device is doing something other than cleaning or mapping.

Mapping

val RvcRunModeTrait.ModeTag.MappingRvcRunModeTrait.ModeTag

The device is mapping.

UnknownValue

val RvcRunModeTrait.ModeTag.UnknownValueRvcRunModeTrait.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.

Public functions

valueOf

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

typeName

open val typeNameString

value

open val valueULong