# ActionsCommands

# ActionsCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ActionsCommands
```

<br />

Known direct subclasses [Actions](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Actions)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Actions` | API for the Actions trait. |

*** ** * ** ***

Commands for the Actions trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Disable an action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Disable an action for a specified amount of time, then enable it. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableActionWithDurationBatchable(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Enable an action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Enable an action for a specified amount of time, then disable it. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableActionWithDurationBatchable(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Trigger an action (state change) on endpoints in an asynchronous manner. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantActionWithTransition(kotlin.UShort,kotlin.UShort,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Trigger an action (state change) on endpoints, specifying how long the state change should take. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantActionWithTransitionBatchable(kotlin.UShort,kotlin.UShort,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantActionWithTransition(kotlin.UShort,kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Pause an ongoing action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Pause an ongoing action for a specified amount of time, after which it resumes. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseActionWithDurationBatchable(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#resumeAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.ResumeActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Resume a paused action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#resumeActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.ResumeActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#resumeAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Start an action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startAction(kotlin.UShort,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Start an action, allow it to run for a specified amount of time, after which it stops. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startActionWithDurationBatchable(kotlin.UShort,kotlin.UInt,kotlin.Function1)( actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#stopAction(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StopActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Stop the ongoing action. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#stopActionBatchable(kotlin.UShort,kotlin.Function1)(actionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StopActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#stopAction(kotlin.UShort,kotlin.Function1)` command. |

## Public functions

### disableAction

```
suspend fun disableAction(actionId: UShort, optionalArgs: ActionsTrait.DisableActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Disable an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### disableActionBatchable

```
fun disableActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.DisableActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableAction(kotlin.UShort,kotlin.Function1)` command.

Disable an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### disableActionWithDuration

```
suspend fun disableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Disable an action for a specified amount of time, then enable it.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### disableActionWithDurationBatchable

```
fun disableActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#disableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command.

Disable an action for a specified amount of time, then enable it.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### enableAction

```
suspend fun enableAction(actionId: UShort, optionalArgs: ActionsTrait.EnableActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Enable an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### enableActionBatchable

```
fun enableActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.EnableActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableAction(kotlin.UShort,kotlin.Function1)` command.

Enable an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### enableActionWithDuration

```
suspend fun enableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Enable an action for a specified amount of time, then disable it.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### enableActionWithDurationBatchable

```
fun enableActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#enableActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command.

Enable an action for a specified amount of time, then disable it.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### instantAction

```
suspend fun instantAction(actionId: UShort, optionalArgs: ActionsTrait.InstantActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Trigger an action (state change) on endpoints in an asynchronous manner.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### instantActionBatchable

```
fun instantActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.InstantActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantAction(kotlin.UShort,kotlin.Function1)` command.

Trigger an action (state change) on endpoints in an asynchronous manner.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### instantActionWithTransition

```
suspend fun instantActionWithTransition(
    actionId: UShort,
    transitionTime: UShort,
    optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Trigger an action (state change) on endpoints, specifying how long the state change should take.

| Parameters |
|---|---|
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The transition time (in 0.1 seconds). |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### instantActionWithTransitionBatchable

```
fun instantActionWithTransitionBatchable(
    actionId: UShort,
    transitionTime: UShort,
    optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#instantActionWithTransition(kotlin.UShort,kotlin.UShort,kotlin.Function1)` command.

Trigger an action (state change) on endpoints, specifying how long the state change should take.

| Parameters |
|---|---|
| `transitionTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The transition time (in 0.1 seconds). |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### pauseAction

```
suspend fun pauseAction(actionId: UShort, optionalArgs: ActionsTrait.PauseActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Pause an ongoing action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### pauseActionBatchable

```
fun pauseActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.PauseActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseAction(kotlin.UShort,kotlin.Function1)` command.

Pause an ongoing action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### pauseActionWithDuration

```
suspend fun pauseActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Pause an ongoing action for a specified amount of time, after which it resumes.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### pauseActionWithDurationBatchable

```
fun pauseActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#pauseActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command.

Pause an ongoing action for a specified amount of time, after which it resumes.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### resumeAction

```
suspend fun resumeAction(actionId: UShort, optionalArgs: ActionsTrait.ResumeActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Resume a paused action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.ResumeActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### resumeActionBatchable

```
fun resumeActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.ResumeActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#resumeAction(kotlin.UShort,kotlin.Function1)` command.

Resume a paused action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.ResumeActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### startAction

```
suspend fun startAction(actionId: UShort, optionalArgs: ActionsTrait.StartActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Start an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### startActionBatchable

```
fun startActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.StartActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startAction(kotlin.UShort,kotlin.Function1)` command.

Start an action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### startActionWithDuration

```
suspend fun startActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Start an action, allow it to run for a specified amount of time, after which it stops.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### startActionWithDurationBatchable

```
fun startActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#startActionWithDuration(kotlin.UShort,kotlin.UInt,kotlin.Function1)` command.

Start an action, allow it to run for a specified amount of time, after which it stops.

| Parameters |
|---|---|
| `duration: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The requested duration in seconds. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### stopAction

```
suspend fun stopAction(actionId: UShort, optionalArgs: ActionsTrait.StopActionCommand.OptionalArgs.() -> Unit = {}): Unit
```

Stop the ongoing action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StopActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### stopActionBatchable

```
fun stopActionBatchable(actionId: UShort, optionalArgs: ActionsTrait.StopActionCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsCommands#stopAction(kotlin.UShort,kotlin.Function1)` command.

Stop the ongoing action.

| Parameters |
|---|---|
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ActionsTrait.StopActionCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |