Actions

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Actions : ActionsTrait.Attributes, MatterTrait, ActionsCommands

API for the Actions trait. This trait provides a standardized way for a node to expose information about logical grouping of endpoints on the node, expose information about named actions that can be performed on a group of endpoints, expose commands to trigger such actions, and expose events to receive feedback on the state of such actions.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<Actions>

Inherited functions
From com.google.home.matter.standard.ActionsCommands
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.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.matter.standard.ActionsTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<ActionsTrait.ActionStruct>?
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
List<ActionsTrait.EndpointListStruct>?

A list of endpoint list IDs.
UInt

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
String?

A URL referencing a location that provides information about the capabilities provided by the cluster.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Actions.Attribute): Boolean

supports

fun supports(command: Actions.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Actions>