ActionsTrait.DisableActionWithDurationCommand.Request

class ActionsTrait.DisableActionWithDurationCommand.Request


The request payload for the DisableActionWithDuration command.

Summary

Public constructors

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

Creates a request payload for the DisableActionWithDuration command.

Public properties

UShort

The action identifier.

UInt

The requested duration in seconds.

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(),
    duration: UInt
)

Creates a request payload for the DisableActionWithDuration command.

Public properties

actionId

val actionIdUShort

The action identifier.

duration

val durationUInt

The requested duration in seconds.

invokeId

val invokeIdOptionalValue<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.