toolbox v5.3.1

Toolbox.Workflow.Transition (toolbox v5.3.1)

Struct defining a single transition, i.e., a change from one status to another.

The struct should be built only via Toolbox.Workflow.add_transition/2. You can then access this struct in all the workflow callbacks such as when or then.

Link to this section Summary

Types

builtin_when_fn_def()
side_effects_fn_def()
t()
then_fn_def()
update_history_entry_fn_def()
update_possible_transition_fn_def()
when_fn_def()

Link to this section Types

Link to this type

builtin_when_fn_def()

@type builtin_when_fn_def() ::
  {:=, [String.t()], term()}
  | {:<, [String.t()], term()}
  | {:>, [String.t()], term()}
  | {:<=, [String.t()], term()}
  | {:>=, [String.t()], term()}
  | {:contains, [String.t()], term()}
  | {:is_in, [String.t()], term()}
Link to this type

side_effects_fn_def()

@type side_effects_fn_def() :: {atom(), atom()}
Link to this type

t()

@type t() :: %Toolbox.Workflow.Transition{
  attributes: %{required(atom()) => term()},
  from: Toolbox.Workflow.status(),
  side_effects_fn: [side_effects_fn_def()],
  then_fn: [then_fn_def()],
  timeout: integer(),
  timeout?: boolean(),
  to: Toolbox.Workflow.status(),
  update_history_entry_fn: [update_history_entry_fn_def()],
  update_possible_transition_fn: [update_possible_transition_fn_def()],
  when_fn: [when_fn_def()]
}
Link to this type

then_fn_def()

@type then_fn_def() :: {atom(), atom()}
Link to this type

update_history_entry_fn_def()

@type update_history_entry_fn_def() :: {atom(), atom()}
Link to this type

update_possible_transition_fn_def()

@type update_possible_transition_fn_def() :: {atom(), atom()}
Link to this type

when_fn_def()

@type when_fn_def() ::
  {atom(), atom()} | {:timeout, integer()} | builtin_when_fn_def()