# ActionsTrait.InstantActionWithTransitionCommand.Request

# ActionsTrait.InstantActionWithTransitionCommand.Request


```
class ActionsTrait.InstantActionWithTransitionCommand.Request : ClusterStruct
```

<br />

*** ** * ** ***

The request payload for the InstantActionWithTransition 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/ActionsTrait.InstantActionWithTransitionCommand.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/ActionsTrait.InstantActionWithTransitionCommand.Request#Request(kotlin.UShort,com.google.home.matter.serialization.OptionalValue,kotlin.UShort)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, invokeId: https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html )` Creates a request payload for the InstantActionWithTransition 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/ActionsTrait.InstantActionWithTransitionCommand.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/ActionsTrait.InstantActionWithTransitionCommand.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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.Request#actionId()` The action identifier. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.Request#invokeId()` The `invokeId` to be provided in the `StateChanged` event when the action changes to a new state, or an `ActionFailed` event when execution of the action fails. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.Request#transitionTime()` The transition time (in 0.1 seconds). |

## Public constructors

### Request

```
Request(
    actionId: UShort,
    invokeId: OptionalValue<UInt> = OptionalValue.absent(),
    transitionTime: UShort
)
```

Creates a request payload for the InstantActionWithTransition 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

### actionId

```
val actionId: UShort
```

The action identifier.

### invokeId

```
val invokeId: OptionalValue<UInt>
```

The `invokeId` to be provided in the `StateChanged` event when the action changes to a new state, or an `ActionFailed` event when execution of the action fails. The client is responsible for providing this value when invoking the command. It may be used by the client to correlate an event to the command.

### transitionTime

```
val transitionTime: UShort
```

The transition time (in 0.1 seconds).