ActionsTrait.InstantActionWithTransitionCommand.Request

class ActionsTrait.InstantActionWithTransitionCommand.Request

The request payload for the InstantActionWithTransition command.

Summary

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

Creates a request payload for the InstantActionWithTransition command.

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.
UShort

The transition time (in 0.1 seconds).

Public constructors

Request

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

Creates a request payload for the InstantActionWithTransition command.

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.

transitionTime

val transitionTime: UShort

The transition time (in 0.1 seconds).