Interface ActionState

Hierarchy

  • ActionState

Indexable

[property: string]: any

Properties

actionDescriptor? actionId actionResult? actionStatus actionType?

Properties

Optional actionDescriptor

actionDescriptor?: string

A user-defined, human-readable name or descriptor.

actionId

actionId: string

Unique actionId

Optional actionResult

actionResult?: string

Description of the result, e.g., the result of a RFID-read. Errors will be transmitted in errors.

actionStatus

actionStatus: V3_0.ActionStatus

WAITING: waiting for the trigger (passing the mode, entering the edge); INITIALIZING: Action was triggered, preparatory measures are initiated; RUNNING: The action is running; RETRIABLE: Actions that failed, but can be retried; PAUSED: paused by instantAction or external trigger; FINISHED: The action is finished; FAILED: action could not be performed.

Optional actionType

actionType?: string

actionType of the action. Optional: Only for informational or visualization purposes. Order knows the type.

Settings

Member Visibility

Theme

Generated using TypeDoc