Jidoka.Operation.Source.Handoff (Jidoka v0.9.0)

Operation source for conversation handoff ownership.

Handoff operations record that a target agent owns future turns for a conversation. The operation returns data to the current turn; routing future turns through that owner remains an application concern.

Summary

Types

forward_context()

t()

target()

Functions

new(attrs)

Builds a handoff operation source from keyword or map attributes.

new!(attrs)

Builds a handoff operation source and raises if the attributes are invalid.

Types

forward_context()

@type forward_context() ::
  :public
  | :none
  | {:only, [atom() | String.t()]}
  | {:except, [atom() | String.t()]}

t()

@type t() :: %Jidoka.Operation.Source.Handoff{
  agent: module(),
  description: nil | binary(),
  forward_context: forward_context(),
  metadata: map(),
  name: binary(),
  target: target()
}

target()

@type target() ::
  :auto | {:peer, String.t()} | {:peer, {:context, atom() | String.t()}}

Functions

new(attrs)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

Builds a handoff operation source from keyword or map attributes.

new!(attrs)

@spec new!(keyword() | map()) :: t()

Builds a handoff operation source and raises if the attributes are invalid.