WardrikChannel.Outbound (wardrik_channel v0.1.0-rc.1)

A message for the adapter to post, in thread of room, or in the room itself if thread is nil. See WardrikChannel.deliver/2.

body is one of:

{:reply, text, answering} - the agent's answer, and the IDs of the messages it answers.
{:status, label} - what the agent is doing, in a few words. Shown until the next post.
{:stopped, answering} - a run stopped before answering those messages.
{:waiting, [%WardrikChannel.Waiting{}]} - calls the agent waits on a person for.
{:failed, reason} - why a run failed.
{:said, text} - a line about what happened, such as who decided a call.
{:notice, %Wardrik.Notice{}} - what an agent did while nobody watched. Posted in the room. Read its calls with WardrikChannel.Waiting.from_notice/1.

approvers are who a waiting call asks, as the chat app names people. An adapter that can ask each of them directly should, and say in the thread who it waits on.

Summary

Types

body()

t()

Types

body()

@type body() ::
  {:reply, String.t(), [String.t()]}
  | {:status, String.t()}
  | {:stopped, [String.t()]}
  | {:waiting, [WardrikChannel.Waiting.t()]}
  | {:failed, String.t()}
  | {:said, String.t()}
  | {:notice, Wardrik.Notice.t()}

t()

@type t() :: %WardrikChannel.Outbound{
  approvers: [String.t()] | :anyone,
  body: body(),
  installation: Wardrik.Channel.Installation.t(),
  room: String.t(),
  thread: String.t() | nil
}