ActionsTrait.StartActionCommand.Request
class ActionsTrait.StartActionCommand.Request
The request payload for the StartAction command.
Summary
Public constructors |
|---|
Request(actionId: UShort, invokeId: OptionalValue<UInt>)Creates a request payload for the StartAction command. |
Public properties |
|
|---|---|
UShort |
The action identifier. |
OptionalValue<UInt> |
The |
Public constructors
Request
Request(
actionId: UShort,
invokeId: OptionalValue<UInt> = OptionalValue.absent()
)
Creates a request payload for the StartAction command.
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.