# RvcCleanMode

# RvcCleanMode


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface RvcCleanMode : RvcCleanModeTrait.Attributes, MatterTrait, RvcCleanModeCommands
```

<br />

*** ** * ** ***

API for the RvcCleanMode trait. This trait provides an interface to the cleaning modes of robotic vacuum cleaners.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode#supports(com.google.home.matter.standard.RvcCleanMode.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode#supports(com.google.home.matter.standard.RvcCleanMode.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanMode#factory()` |

| ### Inherited functions |
|---|
| From [com.google.home.matter.standard.RvcCleanModeCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeCommands) |---|---| | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.ChangeToModeCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeCommands#changeToMode(kotlin.UByte)(newMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` Change the mode of the device's cluster instance, and set the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#currentMode()` attribute of the device's cluster instance. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.ChangeToModeCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeCommands#changeToModeBatchable(kotlin.UByte)(newMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeCommands#changeToMode(kotlin.UByte)` command. | |
| From [com.google.home.matter.standard.RvcCleanModeTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes) |---|---| | `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. | | `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/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/RvcCleanModeTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. | |
| From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` | |

| ### Inherited properties |
|---|
| From [com.google.home.matter.standard.RvcCleanModeTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes) |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#currentMode()` The current mode. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.ModeOptionStruct>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/RvcCleanModeTrait.Attributes#supportedModes()` The list of supported modes for the cluster instance. | |
| From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) |---|---| | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()` | |

## Public functions

### supports

```
fun supports(attribute: RvcCleanMode.Attribute): Boolean
```

### supports

```
fun supports(command: RvcCleanMode.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<RvcCleanMode>
```