ActionsCommands

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

Known direct subclasses
Actions

API for the Actions trait.

Summary

Public functions
suspend Unit

Disable an action.
BatchableCommand<Unit>

The batchable version of disableAction command.
suspend Unit
disableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit
)

Disable an action for a specified amount of time, then enable it.
BatchableCommand<Unit>
disableActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit
)

The batchable version of disableActionWithDuration command.
suspend Unit

Enable an action.
BatchableCommand<Unit>

The batchable version of enableAction command.
suspend Unit
enableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit
)

Enable an action for a specified amount of time, then disable it.
BatchableCommand<Unit>
enableActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit
)

The batchable version of enableActionWithDuration command.
suspend Unit

Trigger an action (state change) on endpoints in an asynchronous manner.
BatchableCommand<Unit>

The batchable version of instantAction command.
suspend Unit
instantActionWithTransition(
    actionId: UShort,
    transitionTime: UShort,
    optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit
)

Trigger an action (state change) on endpoints, specifying how long the state change should take.
BatchableCommand<Unit>
instantActionWithTransitionBatchable(
    actionId: UShort,
    transitionTime: UShort,
    optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit
)

The batchable version of instantActionWithTransition command.
suspend Unit

Pause an ongoing action.
BatchableCommand<Unit>

The batchable version of pauseAction command.
suspend Unit
pauseActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit
)

Pause an ongoing action for a specified amount of time, after which it resumes.
BatchableCommand<Unit>
pauseActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit
)

The batchable version of pauseActionWithDuration command.
suspend Unit

Resume a paused action.
BatchableCommand<Unit>

The batchable version of resumeAction command.
suspend Unit

Start an action.
BatchableCommand<Unit>

The batchable version of startAction command.
suspend Unit
startActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit
)

Start an action, allow it to run for a specified amount of time, after which it stops.
BatchableCommand<Unit>
startActionWithDurationBatchable(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit
)

The batchable version of startActionWithDuration command.
suspend Unit

Stop the ongoing action.
BatchableCommand<Unit>

The batchable version of stopAction command.

Public functions

disableAction

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

Disable an action.

Parameters
optionalArgs: ActionsTrait.DisableActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

disableActionBatchable

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

The batchable version of disableAction command.

Disable an action.

Parameters
optionalArgs: ActionsTrait.DisableActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit = {}

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 disableActionWithDuration command.

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

Parameters
duration: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

enableAction

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

Enable an action.

Parameters
optionalArgs: ActionsTrait.EnableActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

enableActionBatchable

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

The batchable version of enableAction command.

Enable an action.

Parameters
optionalArgs: ActionsTrait.EnableActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit = {}

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 enableActionWithDuration command.

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

Parameters
duration: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: ActionsTrait.InstantActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

instantActionBatchable

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

The batchable version of instantAction command.

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

Parameters
optionalArgs: ActionsTrait.InstantActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: UShort

The transition time (in 0.1 seconds).
optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit = {}

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 instantActionWithTransition command.

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

Parameters
transitionTime: UShort

The transition time (in 0.1 seconds).
optionalArgs: ActionsTrait.InstantActionWithTransitionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

pauseAction

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

Pause an ongoing action.

Parameters
optionalArgs: ActionsTrait.PauseActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

pauseActionBatchable

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

The batchable version of pauseAction command.

Pause an ongoing action.

Parameters
optionalArgs: ActionsTrait.PauseActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit = {}

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 pauseActionWithDuration command.

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

Parameters
duration: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.PauseActionWithDurationCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

resumeAction

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

Resume a paused action.

Parameters
optionalArgs: ActionsTrait.ResumeActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

resumeActionBatchable

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

The batchable version of resumeAction command.

Resume a paused action.

Parameters
optionalArgs: ActionsTrait.ResumeActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

startAction

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

Start an action.

Parameters
optionalArgs: ActionsTrait.StartActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

startActionBatchable

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

The batchable version of startAction command.

Start an action.

Parameters
optionalArgs: ActionsTrait.StartActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

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: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit = {}

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 startActionWithDuration command.

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

Parameters
duration: UInt

The requested duration in seconds.
optionalArgs: ActionsTrait.StartActionWithDurationCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand

stopAction

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

Stop the ongoing action.

Parameters
optionalArgs: ActionsTrait.StopActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

stopActionBatchable

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

The batchable version of stopAction command.

Stop the ongoing action.

Parameters
optionalArgs: ActionsTrait.StopActionCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<Unit>

BatchableCommand