Type alias VirtualActionTransitions

VirtualActionTransitions: {
    FAILED: {
        errorDescription?: ((context: ActionContext) => string);
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
    };
    FINISHED: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        resultDescription: ((context: ActionContext) => string);
    };
    INITIALIZING?: {
        durationTime: number | [string, number];
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Paused | Running | Failed;
    };
    ON_CANCEL?: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
    };
    ON_INIT: {
        next: Initializing | Running | Finished;
    };
    ON_TERMINATE?: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Finished | Failed;
    };
    RUNNING?: {
        durationTime: number | [string, number];
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Paused | Finished | Failed;
    };
}

A specification format to define all possible states of an action, its transitions, and side effects.

Remarks

The action state PAUSED is not part of the format. State transitions from/to this state are handled internally by the adapter.

Type declaration

  • FAILED: {
        errorDescription?: ((context: ActionContext) => string);
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
    }

    Defines FAILED action status.

    • Optional errorDescription?: ((context: ActionContext) => string)
        • (context: ActionContext): string

        • A FAILED action may report a corresponding error state with an error description reported by invoking the given function (optional).

          If not specified or if the function returns undefined or an empty string, only the action state change is reported, but not an error state.

          Parameters

          Returns string

    • Optional linkedState?: ((context: ActionContext) => Partial<Headerless<State>>)
  • FINISHED: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        resultDescription: ((context: ActionContext) => string);
    }

    Defines FINISHED action status.

  • Optional INITIALIZING?: {
        durationTime: number | [string, number];
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Paused | Running | Failed;
    }

    Defines INITIALIZING action status (optional for node, edge, and instant actions).

    • durationTime: number | [string, number]

      Time in seconds to stay in this status.

      Specify either a number of seconds or a tuple with the name of the action parameter whose numeric value should be taken and a default value to be taken if this action parameter is not existing.

    • Optional linkedState?: ((context: ActionContext) => Partial<Headerless<State>>)
    • next: Paused | Running | Failed

      The next status to transition to after the duration time elapses.

  • Optional ON_CANCEL?: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
    }

    Define status change information for a node or edge action that can be canceled by interrupting an initializing, running or paused action (for interruptable node and edge actions only).

    After cancelation the action transitions to status FAILED automatically.

  • ON_INIT: {
        next: Initializing | Running | Finished;
    }

    Defines the initial state (mandatory for all actions).

    • next: Initializing | Running | Finished

      The initial status to transition to when the action is being executed.

      Remarks

      This transition must always be present. Value must be INITIALIZING or RUNNING for node and edge actions. Value must be INITIALIZING, RUNNING, or FINISHED for instant actions.

  • Optional ON_TERMINATE?: {
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Finished | Failed;
    }

    Define status change information for an edge action to be terminated (for edge actions only, mandatory for edge actions).

  • Optional RUNNING?: {
        durationTime: number | [string, number];
        linkedState?: ((context: ActionContext) => Partial<Headerless<State>>);
        next: Paused | Finished | Failed;
    }

    Defines RUNNING action status (mandatory for node and edge actions, optional for instant actions).

    • durationTime: number | [string, number]

      Time in seconds to stay in this status.

      Specify either a number of seconds or a tuple with the name of the action parameter whose numeric value should be taken and a default value to be taken if this action parameter is not existing.

    • Optional linkedState?: ((context: ActionContext) => Partial<Headerless<State>>)
    • next: Paused | Finished | Failed

      The next status to transition to after the duration time elapses.

Settings

Member Visibility

Theme

Generated using TypeDoc