Supabase.Realtime.Behaviour behaviour (supabase_realtime v0.5.0)

Defines the interface for the main module Supabase.Realtime

Summary

channel()

channel_opts()

client()

event_filter()

event_type()

start_option()

t()

set_auth(t, t)

@type channel() :: Supabase.Realtime.Channel.t()

@type channel_opts() :: keyword()

@type client() :: module() | atom()

@type event_filter() :: Enumerable.t()

@type event_type() :: :postgres_changes | :broadcast | :presence

@type start_option() :: {:name, atom()} | {:timeout, pos_integer()}

@type t() :: pid() | atom()

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

@callback channel(t(), String.t(), channel_opts()) :: {:ok, channel()} | {:error, term()}

@callback connection_state(t()) :: Supabase.Realtime.connection_state()

@callback on(channel(), String.t(), event_filter()) :: :ok | {:error, term()}

@callback remove_all_channels(t()) :: :ok | {:error, term()}

@callback send(t(), channel(), map()) :: :ok | {:error, term()}

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

@callback set_auth(t(), channel(), String.t()) :: :ok | {:error, term()}

@callback start_link(Supabase.Client.t(), [start_option()]) :: Supervisor.on_start()

@callback track(t(), channel(), map()) :: :ok | {:error, term()}

@callback unsubscribe(channel()) :: :ok | {:error, term()}

@callback untrack(t(), channel()) :: :ok | {:error, term()}