Glific v5.1.6

View Source Glific.Flows.Router (Glific v5.1.6)

The Router object which encapsulates the router in a given node.

Link to this section Summary

Types

t()

Functions

execute(router, context, messages)

Execute a router, given a message stream. Consume the message stream as processing occurs

process(json, uuid_map, node)

Process a json structure from flow editor to the Glific data types

validate(router, errors, flow)

Validate a action and all its children

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Glific.Flows.Router{
  __meta__: term(),
  cases: [Glific.Flows.Case.t()] | nil,
  categories: [Glific.Flows.Category.t()] | nil,
  default_category: Glific.Flows.Category.t() | nil,
  default_category_uuid: Ecto.UUID.t() | nil,
  id: term(),
  no_response_exit_uuid: Ecto.UUID.t() | nil,
  node: Glific.Flows.Node.t() | nil,
  node_uuid: Ecto.UUID.t() | nil,
  operand: term(),
  other_exit_uuid: Ecto.UUID.t() | nil,
  result_name: String.t() | nil,
  type: String.t() | nil,
  wait: Glific.Flows.Wait.t() | nil,
  wait_type: term()
}

Link to this section Functions

Link to this function

execute(router, context, messages)

View Source 
@spec execute(t(), Glific.Flows.FlowContext.t(), [Glific.Messages.Message.t()]) ::
  {:ok, Glific.Flows.FlowContext.t(), [Glific.Messages.Message.t()]}
  | {:error, String.t()}

Execute a router, given a message stream. Consume the message stream as processing occurs

Link to this function

process(json, uuid_map, node)

View Source 
@spec process(map(), map(), Glific.Flows.Node.t()) :: {t(), map()}

Process a json structure from flow editor to the Glific data types

Link to this function

validate(router, errors, flow)

View Source 
@spec validate(t(), Keyword.t(), map()) :: Keyword.t()

Validate a action and all its children