164 results found
-
first extension how-to details Build your first Extension
Here’s an extension that just says ‘Hello, world!’where do i store this? how do i connect this with the twitch extension config page?
2 votes -
Add existing IRC WHISPER command to IRC documentation The IRC gateway passes whispers using the WHISPER code:
[16:36:15] [@] @badges=bits-charity/1;color=#3E2E18;display-name=foo;emotes=;message-id=2;thread-id=21001676_470220570;turbo=0;user-id=2109996;user-type= :foo!foo!foo.twitch.tv WHISPER myuser :this is a whisperBut I am unable to find any reference to that code on https://dev.twitch.tv/docs/irc/commands where I would expect it, or any other documentation page under the "Chatbots and IRC" section.
I would suggest adding the WHISPER command to the list of commands at the top of the page on the IRC: Commands section, something similar to:
WHISPER Receive a Whisper message from another user
and then the prototype at the bottom, to include the fact that it appears the WHISPER command is…
15 votes -
Clarify read-only nature of IRC MODE command While you do a good job of stating that the IRC interface deviates from the RFC, as well as where and how it deviates from the RFC, it may be beneficial to specifically call out the deviation that the MODE command is server-generated (read only), instead of being a keyword that can be generated by a client.
In other words, my bot cannot issue its own "MODE #channel +o nickname" command via the IRC interface (like it can on IRC), it can only receive notifications from the server that the server has sett one of those modes. One sentence covering…
2 votesThanks for the head’s up!
-
Enabling Drops This guy does not resemble reality. Part 4: Enabling Drops; Click Your Console ( Where is it, I clicked Your Dashboard); Click Drops ( Where is it? How am I suppose to find it?).
Not approvable3 votes -
Wording on refreshing a token is confusing https://dev.twitch.tv/docs/authentication#refreshing-access-tokens
"
How to Refresh
To refresh a token, you need an access token/refresh token pair coming from a body. For example:
"You need only the "refresh token" and "client secret"
You can lose the access token, and still get a new token if you have a refresh_token
3 votes -
The Validate requests endpoint omits the expiry from the example response URL
https://dev.twitch.tv/docs/authentication#validating-requests
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>"
}should be
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>",
"expires_in": timeInSeconds
}4 votes -
Fix TMI JS example with Promise handling https://dev.twitch.tv/docs/irc#overview
Row:
client.connect();Should be replaced with:
client.connect().catch((err) => {console.log('Connection error!', err)});
or smth like that.Let's show users how to write good code, and show them, that all Promises should be handled. Unhandled promise rejections is bad!
Tmi.js Library also have connect example which contain promise handling
7 votes -
Helper: viewer is misleading as the viewer object is populated on all views not just the channel page https://dev.twitch.tv/docs/extensions/reference#helper-viewer
The Twitch.ext.viewer object is a collection of info about the twitch viewer that is watching the channel page where your extension is activated. It will only be populated if the viewer is logged in, and only after the `onAuthorized` callback has been called. Accessing its properties will otherwise return `null`.Should be
The Twitch.ext.viewer object is a collection of info about the twitch user that is watching the extension view.Or something, as the
viewerhelper object exists on all views!3 votes -
Extension Pubsub Docs missing whisper targer. https://dev.twitch.tv/docs/extensions/reference/#send-extension-pubsub-message
The docs say Valid values: "broadcast", "global".
But, the target 'whisper-opaqueId' to send "per user" pusub message is missing.
14 votes -
Get Broadcaster Subscriptions docs example incomplete The Get Broadcast Subscriptions docs https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions was updated to include gifterid and giftername fields, but neither of these were added to the example.
Also, the example is erroneous because it shows the same user id for both broadcaster and subscriber, but they represent different usernames, which is impossible.
3 votes -
Document error responses https://dev.twitch.tv/docs/authentication/getting-tokens-oauth#oauth-client-credentials-flow
There's no information about error response and it doesn't seem to be fully compatible with RFC 6749 which means I can't find info about possible errors easily.
3 votes -
Extension popout "by default" From: https://github.com/twitchdev/issues/issues/72
Brief description
By default, pop-out control is enabled for panel Extensions and for extension “live configuration views” (see the Live Config Path setting on the Asset Hosting tab in the Extensions manager).
https://dev.twitch.tv/docs/extensions/required-technical-background
The documentation suggests that extension developers can disable pop-outs. Which is not the case
3 votes -
User/Channel ID needs to be a string From: https://github.com/twitchdev/issues/issues/70
Brief description
The documentation for creating signing JWT's don't explicitly state that
user_id/channel_idin JWT's need to be an explicit string literalhttps://dev.twitch.tv/docs/extensions/building/#signing-the-jwt
https://dev.twitch.tv/docs/extensions/reference#send-extension-pubsub-messageExpected documentation
Where: exp is the Unix epoch timestamp when the payload will expire. Be sure to provide a buffer, to allow potential positive time drift. user_id is the Twitch user ID that owns the extension, where the user ID is cast as a string literal. role is set to external.3 votes -
HTTP Response codes unclear From: https://github.com/twitchdev/issues/issues/69
Brief descriptionSome endpoints return a 204 code no content.
But this is only highlighted in the example responses and not in the "main documentation"For example
https://dev.twitch.tv/docs/extensions/reference#send-extension-pubsub-message
https://dev.twitch.tv/docs/extensions/reference#send-extension-chat-messageEach endpoint documented could be extended to include usual HTTP response codes.
Expected documentation
The expected response code for success when theres no body response
Common non 2xx codes for the endpoints4 votes -
msg-id tags page outdated/incorrect From: https://github.com/twitchdev/issues/issues/68
Docs location: https://dev.twitch.tv/docs/irc/msg-id
bad_ban_global_mod&bad_timeout_global_modare gone for as far as i know (ref: https://blog.twitch.tv/en/2018/12/13/thank-you-global-moderators-4d44cfccf22/)Missing notices for vip events (
vip_success,unvip_success,no_vips,bad_vip_grantee_banned,bad_vip_grantee_already_vip,usage_vip&bad_unvip_grantee_not_vipMight have missed some.First line says "These tags apply to both the" and than only names one thing.
usage_untimeout has "/raid <username>" in the message.
7 votes -
Webhooks topic(s) don't note required oAuth From: https://github.com/twitchdev/issues/issues/59
Brief description
Mod Change and Channel ban Change events don't note the required oAuth scope needed for the topic
https://dev.twitch.tv/docs/api/webhooks-reference#topic-moderator-change-events
https://dev.twitch.tv/docs/api/webhooks-reference#topic-channel-ban-change-eventsExpected documentation
Add, (similar to
Topic: User Changed)Authentication User Access Token must have the `moderation:read` for the user in questionAdditional context or questions
5 votes -
Helper: Actions - don't work in the rig From: https://github.com/twitchdev/issues/issues/56
Brief description
Documentation describes that there are functions such as
followChannelandrequestIdSharebut the documentation doesn't mention that these functions don't work in the rig (at time of writing)https://dev.twitch.tv/docs/extensions/reference#helper-actions
Additional context or questions
https://discordapp.com/channels/504015559252377601/523676096277905419/676767529666084864
3 votes -
Information about config service unclear From: https://github.com/twitchdev/issues/issues/55
Brief description
https://dev.twitch.tv/docs/extensions/building#using-the-configuration-service
Doesn't mention the key bit of information regarding the size limit of 5kb
Additional context or questions
It's important to note here as people will start designing an extension and then discover the sizing limit late into construction of an extension. For clarity the limit should be noted here also
3 votes -
onPositionChanged still in docs From: https://github.com/twitchdev/issues/issues/36
Brief description
https://dev.twitch.tv/docs/extensions/reference#helper-extensions
The JS helper/callback function
onPositionChangedis still documented but is no longer relevant post video component redesignExpected documentation
Section Should be removed
3 votes -
PubSub Docs don't mention Token Type From: https://github.com/twitchdev/issues/issues/25
Brief description
https://dev.twitch.tv/docs/pubsub#topics
PubSub documentation mentions the requirement to use an oAuth token, but doesn't directly specify which type of token, nor the requirement for the UserID of the token to match the UserID of the topic.
Authentication All topics require an OAuth token, but only some topics have a specific required scope (noted in the table below). Available Topics All topics require an OAuth token, but only some topics have a specific required scope (noted in the table).Expected documentation
…Authentication All topics require a User Access OAuth token, where the UserID of the token matches the9 votes
- Don't see your idea?