ActionsTrait.PauseActionWithDurationCommand.Request
class ActionsTrait.PauseActionWithDurationCommand.Request : ClusterStruct
The request payload for the PauseActionWithDuration command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(actionId: UShort, invokeId: OptionalValue<UInt>, duration: UInt)Creates a request payload for the PauseActionWithDuration command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UShort |
The action identifier. |
UInt |
The requested duration in seconds. |
OptionalValue<UInt> |
The |
Public constructors
Request
Request(
actionId: UShort,
invokeId: OptionalValue<UInt> = OptionalValue.absent(),
duration: UInt
)
Creates a request payload for the PauseActionWithDuration 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
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.