View Source TwitchEventSub (hello_twitch_eventsub v0.3.0)

TwitchEventSub websocket client supervisor. See the option/0 type for the required options.

Summary

Types

channel_ids()

The IDs of the channels we're subscribing to or something.

handler()

The module that implements TwitchEventSub.

keepalive_timeout()

The keepalive timeout in seconds. Specifying an invalid, numeric value will return the nearest acceptable value. Optional. Defaults to 10.

option()

The options accepted (or required) by the TwitchEventSub.Supervisor.

start?()

Tell the websocket client whether or not it should be started. Optional. Defaults to true.

subscription()

A subscription for EventSub. Optional. Defaults to a bunch. Check TwitchEventSub.Websocket.Client for the defaults.

url()

A websocket URL to connect to. Optional. Defaults to "wss://eventsub.wss.twitch.tv/ws".

user_id()

The user ID of the broadcaster or bot user we are using for subscriptions.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

Types

channel_ids()

@type channel_ids() :: [String.t()]

The IDs of the channels we're subscribing to or something.

handler()

@type handler() :: module()

The module that implements TwitchEventSub.

keepalive_timeout()

@type keepalive_timeout() :: pos_integer()

The keepalive timeout in seconds. Specifying an invalid, numeric value will return the nearest acceptable value. Optional. Defaults to 10.

option()

@type option() ::
  {:auth_store_callback_module, module()}
  | {:auth_store_name, TwitchAPI.AuthStore.name()}
  | {:channel_ids, channel_ids()}
  | {:handler, handler()}
  | {:keepalive_timeout, keepalive_timeout()}
  | {:start?, start?()}
  | {:subscriptions, [subscription()]}
  | {:url, url()}
  | {:user_id, user_id()}

The options accepted (or required) by the TwitchEventSub.Supervisor.

start?()

@type start?() :: boolean() | nil

Tell the websocket client whether or not it should be started. Optional. Defaults to true.

subscription()

@type subscription() :: String.t() | %{condition: map(), name: String.t()}

A subscription for EventSub. Optional. Defaults to a bunch. Check TwitchEventSub.Websocket.Client for the defaults.

url()

@type url() :: String.t()

A websocket URL to connect to. Optional. Defaults to "wss://eventsub.wss.twitch.tv/ws".

user_id()

@type user_id() :: String.t()

The user ID of the broadcaster or bot user we are using for subscriptions.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.