# RvcRunModeTrait.ModeTag


```
enum RvcRunModeTrait.ModeTag : Enum, ClusterEnum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.matter.standard.RvcRunModeTrait.ModeTag](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag) |

*** ** * ** ***

The ModeTags for RvcRunMode.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Auto` | Decides which options, features, and setting values to use. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Cleaning` | The device is cleaning or paused while in the middle of cleaning. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Day` | Provides a mode suitable for use during day time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Idle` | The device is doing something other than cleaning or mapping. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#LowEnergy` | Optimizes for lower energy usage. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#LowNoise` | Optimizes for low noise operation. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Mapping` | The device is mapping. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Max` | Uses the highest available setting value. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Min` | Uses the lowest available setting value. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Night` | Provides a mode suitable for use during night time. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Quick` | Optimizes for faster completion. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Quiet` | Operates silently or barely audibly. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#UnknownValue` | The enum value is out of range. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#Vacation` | Provides a mode suitable for use during vacations or other extended absences. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#traitId()` Trait identifier of the Matter Cluster that defines the enum Data Type. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#typeName()` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcRunModeTrait.ModeTag#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 RvcRunModeTrait.ModeTag.Auto: RvcRunModeTrait.ModeTag
```

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

### Cleaning

```
val RvcRunModeTrait.ModeTag.Cleaning: RvcRunModeTrait.ModeTag
```

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

### Day

```
val RvcRunModeTrait.ModeTag.Day: RvcRunModeTrait.ModeTag
```

Provides a mode suitable for use during day time.

### Idle

```
val RvcRunModeTrait.ModeTag.Idle: RvcRunModeTrait.ModeTag
```

The device is doing something other than cleaning or mapping.

### LowEnergy

```
val RvcRunModeTrait.ModeTag.LowEnergy: RvcRunModeTrait.ModeTag
```

Optimizes for lower energy usage.

### LowNoise

```
val RvcRunModeTrait.ModeTag.LowNoise: RvcRunModeTrait.ModeTag
```

Optimizes for low noise operation.

### Mapping

```
val RvcRunModeTrait.ModeTag.Mapping: RvcRunModeTrait.ModeTag
```

The device is mapping.

### Max

```
val RvcRunModeTrait.ModeTag.Max: RvcRunModeTrait.ModeTag
```

Uses the highest available setting value.

### Min

```
val RvcRunModeTrait.ModeTag.Min: RvcRunModeTrait.ModeTag
```

Uses the lowest available setting value.

### Night

```
val RvcRunModeTrait.ModeTag.Night: RvcRunModeTrait.ModeTag
```

Provides a mode suitable for use during night time.

### Quick

```
val RvcRunModeTrait.ModeTag.Quick: RvcRunModeTrait.ModeTag
```

Optimizes for faster completion.

### Quiet

```
val RvcRunModeTrait.ModeTag.Quiet: RvcRunModeTrait.ModeTag
```

Operates silently or barely audibly.

### UnknownValue

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

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

## Public functions

### toDescription

```
@HomeExperimentalGenericApi
fun toDescription(): String
```

### 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 |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | 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

### entries

```
val entries: EnumEntries<RvcRunModeTrait.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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/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.