Jido.Chat.Slack.SocketMode.SocketClient behaviour (Jido Chat Slack v1.0.0)

Copy Markdown View Source

Contract for the long-lived Socket Mode WebSocket connection.

Summary

Callbacks

close(socket)
connect(url, owner, opts)
send_text(socket, payload)

Callbacks

close(socket)

@callback close(socket :: term()) :: :ok | {:error, term()}

connect(url, owner, opts)

@callback connect(url :: String.t(), owner :: pid(), opts :: keyword()) ::
  {:ok, term()} | {:error, term()}

send_text(socket, payload)

@callback send_text(socket :: term(), payload :: String.t()) :: :ok | {:error, term()}