Teac.Scopes.User (teac v0.2.0)

View Source

User scopes

Summary

Functions

Returns the entire map of scope atoms to scope strings.

Returns a list of all valid scope atoms.

Returns a list of all valid scope strings.

Join a specified chat channel as your user and appear as a bot, and perform chat-related actions as your user.

user:edit Manage a user object.

View and edit a user’s broadcasting configuration, including Extension configurations.

Retrieves the scope string corresponding to the given atom key.

Manage the block list of a user.

Update the color used for the user’s name in chat.

Receive whispers sent to your user, and send whispers on your user’s behalf.

View the block list of a user.

View a user’s broadcasting configuration, including Extension configurations.

Receive chatroom messages and informational notifications relating to a channel’s chatroom.

View a user’s email address.

View emotes available to a user

View the list of channels a user follows.

Read the list of channels you have moderator privileges in.

View if an authorized user is subscribed to specific channels.

Receive whispers sent to your user.

Send chat messages to a chatroom.

Functions

all()

Returns the entire map of scope atoms to scope strings.

all_keys()

Returns a list of all valid scope atoms.

all_values()

Returns a list of all valid scope strings.

bot()

Join a specified chat channel as your user and appear as a bot, and perform chat-related actions as your user.

API:

EventSub:

edit()

user:edit Manage a user object.

API:

edit_broadcast()

View and edit a user’s broadcasting configuration, including Extension configurations.

API:

get(key)

Retrieves the scope string corresponding to the given atom key.

Examples

iex> YourModule.get(:example_key)
"example:scope"

manage_blocked_users()

Manage the block list of a user.

API:

manage_chat_color()

Update the color used for the user’s name in chat.

API:

manage_whispers()

Receive whispers sent to your user, and send whispers on your user’s behalf.

API:

EventSub:

read_blocked_users()

View the block list of a user.

API:

read_broadcast()

View a user’s broadcasting configuration, including Extension configurations.

API:

read_chat()

Receive chatroom messages and informational notifications relating to a channel’s chatroom.

EventSub:

read_email()

View a user’s email address.

API:

EventSub:

read_emotes()

View emotes available to a user

API:

read_follows()

View the list of channels a user follows.

API:

read_moderated_channels()

Read the list of channels you have moderator privileges in.

API:

read_subscriptions()

View if an authorized user is subscribed to specific channels.

API:

read_whispers()

Receive whispers sent to your user.

EventSub:

write_chat()

Send chat messages to a chatroom.

API: