Actions

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.
suspend Unit
disableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.DisableActionWithDurationCommand.OptionalArgs.() -> Unit
)

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

Enable an action.
suspend Unit
enableActionWithDuration(
    actionId: UShort,
    duration: UInt,
    optionalArgs: ActionsTrait.EnableActionWithDurationCommand.OptionalArgs.() -> Unit
)

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

Trigger an action (state change) on endpoints in an asynchronous manner.
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.
suspend Unit

Pause an ongoing action.
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.
suspend Unit

Resume a paused action.
suspend Unit

Start an action.
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.
suspend Unit

Stop the ongoing action.
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>