Teac.Scopes.Channel (teac v0.2.0)
View SourceChannel 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
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.
API:
- Send Chat Message: https://dev.twitch.tv/docs/api/reference/#send-chat-message
EventSub:
- Channel Chat Clear: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatclear
- Channel Chat Clear User Messages: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatclear_user_messages
- Channel Chat Message: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatmessage
- Channel Chat Message Delete: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatmessage_delete
- Channel Chat Notification: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatnotification
- Channel Chat Settings Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchat_settingsupdate
Run commercials on a channel.
API
- Start Commercial: https://dev.twitch.tv/docs/api/reference#start-commercial
Retrieves the scope string corresponding to the given atom key.
Examples
iex> YourModule.get(:example_key)
"example:scope"
Manage ads schedule on a channel.
API:
- Snooze Next Ad https://dev.twitch.tv/docs/api/reference#snooze-next-ad
Manage a channel’s broadcast configuration, including updating channel configuration and managing stream markers and stream tags.
API:
- Modify Channel Information: https://dev.twitch.tv/docs/api/reference#modify-channel-information
- Create Stream Marker: https://dev.twitch.tv/docs/api/reference#create-stream-marker
- Replace Stream Tags: https://dev.twitch.tv/docs/api/reference#replace-stream-tags
Manage a channel’s Extension configuration, including activating Extensions.
API:
- Get User Active Extensions: https://dev.twitch.tv/docs/api/reference#get-user-active-extensions
- Update User Extensions: https://dev.twitch.tv/docs/api/reference#update-user-extensions
Manage Guest Star for your channel.
API:
- Update Channel Guest Star Settings: https://dev.twitch.tv/docs/api/reference#update-channel-guest-star-settings
- Create Guest Star Session: https://dev.twitch.tv/docs/api/reference#create-guest-star-session
- End Guest Star Session: https://dev.twitch.tv/docs/api/reference#end-guest-star-session
- Send Guest Star Invite: https://dev.twitch.tv/docs/api/reference#send-guest-star-invite
- Delete Guest Star Invite: https://dev.twitch.tv/docs/api/reference#delete-guest-star-invite
- Assign Guest Star Slot: https://dev.twitch.tv/docs/api/reference#assign-guest-star-slot
- Update Guest Star Slot: https://dev.twitch.tv/docs/api/reference#update-guest-star-slot
- Delete Guest Star Slot: https://dev.twitch.tv/docs/api/reference#delete-guest-star-slot
- Update Guest Star Slot Settings: https://dev.twitch.tv/docs/api/reference#update-guest-star-slot-settings
EventSub:
- Channel Guest Star Session Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_sessionbegin
- Channel Guest Star Session End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_sessionend
- Channel Guest Star Guest Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_guestupdate
- Channel Guest Star Settings Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_settingsupdate
Add or remove the moderator role from users in your channel.
API:
- Add Channel Moderator: https://dev.twitch.tv/docs/api/reference#add-channel-moderator
- Remove Channel Moderator: https://dev.twitch.tv/docs/api/reference#remove-channel-moderator
- Get Moderators: https://dev.twitch.tv/docs/api/reference/#get-moderators
Manage a channel’s polls.
API:
- Get Polls: https://dev.twitch.tv/docs/api/reference#get-polls
- Create Poll: https://dev.twitch.tv/docs/api/reference#create-poll
- End Poll: https://dev.twitch.tv/docs/api/reference#end-poll
EventSub:
- Channel Poll Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollbegin
- Channel Poll Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollprogress
- Channel Poll End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollend
Manage of channel’s Channel Points Predictions
API:
- Get Channel Points Predictions: https://dev.twitch.tv/docs/api/reference#get-predictions
- Create Channel Points Prediction: https://dev.twitch.tv/docs/api/reference#create-prediction
- End Channel Points Prediction: https://dev.twitch.tv/docs/api/reference#end-prediction
EventSub:
- Channel Prediction Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionbegin
- Channel Prediction Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionprogress
- Channel Prediction Lock: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionlock
- Channel Prediction End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionend
Manage a channel raiding another channel.
API:
- Start a raid: https://dev.twitch.tv/docs/api/reference#start-a-raid
- Cancel a raid: https://dev.twitch.tv/docs/api/reference#cancel-a-raid
Manage Channel Points custom rewards and their redemptions on a channel.
API:
- Get Custom Reward: https://dev.twitch.tv/docs/api/reference#get-custom-reward
- Get Custom Reward Redemption: https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
- Create Custom Rewards: https://dev.twitch.tv/docs/api/reference#create-custom-rewards
- Delete Custom Reward: https://dev.twitch.tv/docs/api/reference#delete-custom-reward
- Update Custom Reward: https://dev.twitch.tv/docs/api/reference#update-custom-reward
- Update Redemption Status: https://dev.twitch.tv/docs/api/reference#update-redemption-status
EventSub:
- Channel Points Automatic Reward Redemption: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_automatic_reward_redemptionadd
- Channel Points Custom Reward Add: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardadd
- Channel Points Custom Reward Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardupdate
- Channel Points Custom Reward Remove: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardremove
- Channel Points Custom Reward Redemption Add: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_reward_redemptionadd
- Channel Points Custom Reward Redemption Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_reward_redemptionupdate
Manage a channel’s stream schedule.
API:
- Update Channel Stream Schedule: https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule
- Create Channel Stream Schedule Segment: https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment
- Update Channel Stream Schedule Segment: https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment
- Delete Channel Stream Schedule Segment: https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
Manage a channel’s videos, including deleting videos.
API:
- Delete Videos: https://dev.twitch.tv/docs/api/reference#delete-videos
Add or remove the VIP role from users in your channel.
API:
- Get VIPs: https://dev.twitch.tv/docs/api/reference#get-vips
- Add Channel VIP: https://dev.twitch.tv/docs/api/reference#add-channel-vip
- Remove Channel VIP: https://dev.twitch.tv/docs/api/reference#remove-channel-vip
EventSub:
Perform moderation actions in a channel.
EventSub:
Read the ads schedule and details on your channel.
API:
- Get Ad Schedule: https://dev.twitch.tv/docs/api/reference#get-ad-schedule
EventSub:
- Channel Ad Break Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelad_breakbegin
Read charity campaign details and user donations on your channel.
API:
- Get Charity Campaign: https://dev.twitch.tv/docs/api/reference#get-charity-campaign
- Get Charity Campaign Donations: https://dev.twitch.tv/docs/api/reference/#get-charity-campaign-donations
EventSub
- Charity Donation: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaigndonate
- Charity Campaign Start: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignstart
- Charity Campaign Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignprogress
- Charity Campaign Stop: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignstop
View a list of users with the editor role for a channel.
API:
- Get Channel Editors: https://dev.twitch.tv/docs/api/reference#get-channel-editors
View Creator Goals for a channel.
API:
- Get Creator Goals: https://dev.twitch.tv/docs/api/reference#get-creator-goals
EventSub:
Read Guest Star details for your channel.
API:
- Get Channel Guest Star Settings: https://dev.twitch.tv/docs/api/reference#get-channel-guest-star-settings
- Get Guest Star Session: https://dev.twitch.tv/docs/api/reference#get-guest-star-session
- Get Guest Star Invites: https://dev.twitch.tv/docs/api/reference#get-guest-star-invites
EventSub:
- Channel Guest Star Session Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_sessionbegin
- Channel Guest Star Session End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_sessionend
- Channel Guest Star Guest Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_guestupdate
- Channel Guest Star Settings Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelguest_star_settingsupdate
View Hype Train information for a channel.
API:
- Get Hype Train Events: https://dev.twitch.tv/docs/api/reference#get-hype-train-events
EventSub:
- Hype Train Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelhype_trainbegin
- Hype Train Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelhype_trainprogress
- Hype Train End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelhype_trainend
View a channel’s polls.
API:
EventSub:
- Channel Poll Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollbegin
- Channel Poll Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollprogress
- Channel Poll End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpollend
View a channel’s Channel Points Predictions.
API:
- Get Channel Points Predictions: https://dev.twitch.tv/docs/api/reference#get-predictions
EventSub:
- Channel Prediction Begin: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionbegin
- Channel Prediction Progress: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionprogress
- Channel Prediction Lock: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionlock
- Channel Prediction End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelpredictionend
View Channel Points custom rewards and their redemptions on a channel.
API:
- Get Custom Reward: https://dev.twitch.tv/docs/api/reference#get-custom-reward
- Get Custom Reward Redemption: https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
EventSub:
- Channel Points Automatic Reward Redemption: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_automatic_reward_redemptionadd
- Channel Points Automatic Reward Redemption v2: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_automatic_reward_redemptionadd-v2
- Channel Points Custom Reward Add: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardadd
- Channel Points Custom Reward Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardupdate
- Channel Points Custom Reward Remove: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_rewardremove
- Channel Points Custom Reward Redemption Add: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_reward_redemptionadd
- Channel Points Custom Reward Redemption Update: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_custom_reward_redemptionupdate
View an authorized user’s stream key.
API:
- Get Stream Key: https://dev.twitch.tv/docs/api/reference#get-stream-key
View a list of all subscribers to a channel and check if a user is subscribed to a channel.
API:
- Get Broadcaster Subscriptions: https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions
EventSub:
- Channel Subscribe: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsubscribe
- Channel Subscription End: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsubscriptionend
- Channel Subscription Gift: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsubscriptiongift
- Channel Subscription Message: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsubscriptionmessage
Read the list of VIPs in your channel.
API:
EventSub: