View Source TwitchEventSub.Subscriptions (hello_twitch_eventsub v0.3.0)

Twitch API.

Summary

Types

auth_store()

Functions

create(auth_store, subscription, opts)

Create an eventsub subscription.

create_many(auth_store, method, channel_ids, subscriptions, opts)

Create many Twitch event sub subscriptions.

list(auth_store, params \\ %{})

List all eventsub subscriptions.

Types

auth_store()

@type auth_store() :: TwitchAPI.AuthStore.name() | pid()

Functions

create(auth_store, subscription, opts)

@spec create(
  auth_store :: auth_store(),
  subscription :: TwitchEventSub.Subscriptions.Subscription.t(),
  opts :: map()
) :: {:ok, Req.Response.t()} | {:error, term()}

Create an eventsub subscription.

create_many(auth_store, method, channel_ids, subscriptions, opts)

@spec create_many(
  auth_store :: auth_store(),
  method :: :conduit | :webhook | :websocket,
  channel_ids :: [String.t()],
  subscriptions :: [String.t()],
  opts :: map()
) :: :ok

Create many Twitch event sub subscriptions.

list(auth_store, params \\ %{})

@spec list(TwitchAPI.AuthStore.name() | pid(), params :: map()) ::
  {:ok, Req.Response.t()} | {:error, term()}

List all eventsub subscriptions.