ActionsTrait.StopActionCommand.Request

class ActionsTrait.StopActionCommand.Request : ClusterStruct

The request payload for the StopAction command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(actionId: UShort, invokeId: OptionalValue<UInt>)

Creates a request payload for the StopAction command.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
UShort

The action identifier.
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.

Public constructors

Request

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

Creates a request payload for the StopAction command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
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.