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

The Category object which encapsulates one category in a given node.

Link to this section Summary

Functions

Execute a category, given a message stream.

Process a json structure from floweditor to the Glific data types

Validate a category

Link to this section Types

@type t() :: %Glific.Flows.Category{
  cases: [Glific.Flows.Case.t()] | [],
  exit: Glific.Flows.Exit.t() | nil,
  exit_uuid: Ecto.UUID.t() | nil,
  id: term(),
  name: String.t() | nil,
  uuid: Ecto.UUID.t() | nil
}

Link to this section Functions

Link to this function

execute(category, context, messages)

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

Execute a category, given a message stream.

Link to this function

process(json, uuid_map, object \\ nil)

View Source
@spec process(map(), map(), any()) :: {t(), map()}

Process a json structure from floweditor to the Glific data types

Link to this function

validate(category, errors, flow)

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

Validate a category