Jido.Chat.X.Transport behaviour (Jido Chat X v1.0.0)

Copy Markdown View Source

Transport contract for X Direct Message API calls.

Summary

Callbacks

delete_dm_event(t, keyword)

@callback delete_dm_event(
  String.t(),
  keyword()
) :: :ok | {:error, term()}

fetch_conversation_messages(t, keyword)

@callback fetch_conversation_messages(
  String.t(),
  keyword()
) :: {:ok, [map()] | map()} | {:error, term()}

fetch_dm_event(t, keyword)

@callback fetch_dm_event(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

send_conversation_message(t, t, keyword)

@callback send_conversation_message(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

send_dm(t, t, keyword)

@callback send_dm(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}