# ColorControlTrait.MoveColorCommand.Request

# ColorControlTrait.MoveColorCommand.Request


```
class ColorControlTrait.MoveColorCommand.Request : ClusterStruct
```

<br />

*** ** * ** ***

The request payload for the MoveColor command.

## Summary

| ### Nested types |
|---|
| `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request.CommandFields : 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 command's request fields. |

| ### Public constructors |
|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request#Request(kotlin.Short,kotlin.Short,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap,com.google.home.matter.standard.ColorControlTrait.OptionsBitmap)( rateX: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, rateY: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html, optionsMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap, optionsOverride: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap )` Creates a request payload for the MoveColor command. |

| ### Public functions |
|---|---|
| `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/ColorControlTrait.MoveColorCommand.Request#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/ColorControlTrait.MoveColorCommand.Request#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. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request#optionsMask()` Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.OptionsBitmap` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request#optionsOverride()` If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request#rateX()` The rate of movement in steps per second. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.MoveColorCommand.Request#rateY()` The rate of movement in steps per second. |

## Public constructors

### Request

```
Request(
    rateX: Short = 0,
    rateY: Short = 0,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
```

Creates a request payload for the MoveColor command.

## Public functions

### getDescriptor

```
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
```

Returns the descriptor for the struct.

### getFieldValueById

```
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
```

Returns the value of the field for the given tag ID.

## Public properties

### optionsMask

```
val optionsMask: ColorControlTrait.OptionsBitmap
```

Determines which bits in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute should be overridden by `optionsOverride`.

### optionsOverride

```
val optionsOverride: ColorControlTrait.OptionsBitmap
```

If the corresponding bit in `optionsMask` is set to `1`, the bit set here overrides the corresponding bit in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#options()` attribute.

### rateX

```
val rateX: Short
```

The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentX()` attribute.

### rateY

```
val rateY: Short
```

The rate of movement in steps per second. A step is a change of one unit to the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ColorControlTrait.Attributes#currentY()` attribute.