Teac.Scopes.Channel (teac v0.2.0)

View Source

Channel management 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.

Joins your channel’s chatroom as a bot user, and perform chat-related actions as that user.

Run commercials on a channel.

Retrieves the scope string corresponding to the given atom key.

Manage ads schedule on a channel.

Manage a channel’s broadcast configuration, including updating channel configuration and managing stream markers and stream tags.

Manage a channel’s Extension configuration, including activating Extensions.

Manage Guest Star for your channel.

Add or remove the moderator role from users in your channel.

Manage a channel’s polls.

Manage of channel’s Channel Points Predictions

Manage a channel raiding another channel.

Manage Channel Points custom rewards and their redemptions on a channel.

Manage a channel’s stream schedule.

Manage a channel’s videos, including deleting videos.

Add or remove the VIP role from users in your channel.

Perform moderation actions in a channel.

Read the ads schedule and details on your channel.

Read charity campaign details and user donations on your channel.

View a list of users with the editor role for a channel.

View Creator Goals for a channel.

Read Guest Star details for your channel.

View Hype Train information for a channel.

View a channel’s polls.

View a channel’s Channel Points Predictions.

View Channel Points custom rewards and their redemptions on a channel.

View an authorized user’s stream key.

View a list of all subscribers to a channel and check if a user is subscribed to a channel.

Read the list of VIPs in your channel.

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()

Joins your channel’s chatroom as a bot user, and perform chat-related actions as that user.

API:

EventSub:

edit_commercial()

Run commercials on a channel.

API

get(key)

Retrieves the scope string corresponding to the given atom key.

Examples

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

manage_ads()

Manage ads schedule on a channel.

API:

manage_broadcast()

Manage a channel’s broadcast configuration, including updating channel configuration and managing stream markers and stream tags.

API:

manage_extensions()

Manage a channel’s Extension configuration, including activating Extensions.

API:

manage_guest_star()

Manage Guest Star for your channel.

API:

EventSub:

manage_moderators()

Add or remove the moderator role from users in your channel.

API:

manage_polls()

Manage a channel’s polls.

API:

EventSub:

manage_predictions()

Manage of channel’s Channel Points Predictions

API:

EventSub:

manage_raids()

Manage a channel raiding another channel.

API:

manage_redemptions()

Manage Channel Points custom rewards and their redemptions on a channel.

API:

EventSub:

manage_schedule()

Manage a channel’s stream schedule.

API:

manage_videos()

Manage a channel’s videos, including deleting videos.

API:

manage_vip()

Add or remove the VIP role from users in your channel.

API:

EventSub:

moderate()

Perform moderation actions in a channel.

EventSub:

read_ads()

Read the ads schedule and details on your channel.

API:

EventSub:

read_charity()

Read charity campaign details and user donations on your channel.

API:

EventSub

read_editors()

View a list of users with the editor role for a channel.

API:

read_goals()

View Creator Goals for a channel.

API:

EventSub:

read_guest_star()

Read Guest Star details for your channel.

API:

EventSub:

read_hype_train()

View Hype Train information for a channel.

API:

EventSub:

read_polls()

View a channel’s polls.

API:

EventSub:

read_predictions()

View a channel’s Channel Points Predictions.

API:

EventSub:

read_redemptions()

View Channel Points custom rewards and their redemptions on a channel.

API:

EventSub:

read_stream_key()

View an authorized user’s stream key.

API:

read_subscriptions()

View a list of all subscribers to a channel and check if a user is subscribed to a channel.

API:

EventSub:

read_vips()

Read the list of VIPs in your channel.

API:

EventSub: