OpenUI.Event (OpenUI v0.1.1)

Copy Markdown View Source

An action that reaches the host (language.md, section 6.3): continue_conversation from @ToAssistant, open_url from @OpenUrl, or the name of a library action.

form_state is read when the action runs. Inside a form it holds that form's fields, each as %{"value", "componentType"}; outside one it holds the page's $variables and page-level fields.

Summary

Types

t()

Functions

to_map(event)

The wire form of language.md, section 6.3.

Types

t()

@type t() :: %OpenUI.Event{
  form_name: String.t() | nil,
  form_state: map(),
  human_friendly_message: String.t(),
  params: map(),
  type: String.t()
}

Functions

to_map(event)

@spec to_map(t()) :: map()

The wire form of language.md, section 6.3.