API Documentation for Stage Channels. #2751

tpcstld · 2021-03-31T19:49:53Z

Summary

This PR adds documentation for stage channels. Go wild!

Please note that this feature is still under active development (even though it is launched), and thus there is higher than normal risk of things possibly changing. Nevertheless, we are confident that everything documented in this PR should be "pretty stable", with the exception of the REQUEST_TO_SPEAK permission, which we may (but there is no current plan) remove for alternative options of selective gating.

tpcstld · 2021-03-31T19:52:27Z

docs/resources/Guild.md

+###### Caveats
+
+There are currently several caveats for this endpoint:
+
+- `channel_id` must currently point to a stage channel.
+- current user must already have joined `channel_id`.
+- You must have the `MUTE_MEMBERS` permission to unsuppress yourself. You can always suppress yourself.
+- You must have the `REQUEST_TO_SPEAK` permission to request to speak. You can always clear your own request to speak.
+- You are able to set `request_to_speak_timestamp` to any present or future time.


I'm not too happy with how I effectively listed a bunch of product behaviour here and below. Things that are mostly in flux too and probably improved in the future. Perhaps I should move this to another section/page? Not sure how we do things in other sections.

Honestly, we don't have much consistency around this. If it's in flux, you can put a

> warn > This logic is still in testing and could be changed

ven · 2021-03-31T19:53:17Z

nice

alii · 2021-03-31T19:54:16Z

Nice, would love to see this.

tpcstld · 2021-03-31T19:58:15Z

docs/resources/Guild.md

+- `channel_id` must currently point to a stage channel.
+- User must already have joined `channel_id`.
+- You must have the `MUTE_MEMBERS` permission. (Since suppression is the only thing that is available currently.)
+- When unsuppressed, non-bot users will have their `request_to_speak_timestamp` set to the current time. Bot users will not.


We chose to not set request_to_speak_timestamp, so that bots would effectively "auto speak" when they were invited. The advantage is that most bots (once they are able to join the stage channel), wouldn't have to do anything to support going "onto the stage".

The disadvantage is that maybe there is some unique usecase where a bot would like to accept when they got voluntold up to the stage. But we haven't been able to come up with anything substainally useful. Please note that bots are still able to "raise their hand" regardless of this behaviour.

HanabishiRecca · 2021-04-01T11:06:01Z

docs/topics/Permissions.md

+| MANAGE_ROLES \*       | `0x010000000` | Allows management and editing of roles                                                                                             | T, V, S      |
+| MANAGE_WEBHOOKS \*    | `0x020000000` | Allows management and editing of webhooks                                                                                          | T            |
+| MANAGE_EMOJIS \*      | `0x040000000` | Allows management and editing of emojis                                                                                            |              |
+| REQUEST_TO_SPEAK      | `0x100000000` | Allows for requesting to speak in stage channels. (_This permission is under active development and may be changed or removed._)   | S            |


This causes 32-bit int overflow. Even unsigned.

which is why they are sent as strings, you should parse them with your language's BigInt (or similar) functionality, or a library for it. permissions should be stored as bigints, read the docs: https://discord.com/developers/docs/topics/permissions

amishshah · 2021-04-02T10:13:51Z

Users with the MANAGE_CHANNELS permission are able to bypass the user limit on voice channels - does this also apply to stage channels?

tpcstld · 2021-04-02T14:42:17Z

Users with the MANAGE_CHANNELS permission are able to bypass the user limit on voice channels - does this also apply to stage channels?

I think the permission is MOVE_MEMBERS actually. Nevertheless, yes, this bypass works right now, but this is more of an implementation detail and may change in the future.

msciotti

Small naming nits

msciotti · 2021-04-06T20:39:26Z

docs/resources/Guild.md

 | shield  | shield style widget with Discord icon and guild members online count                                                                                           | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=shield)  |
 | banner1 | large image with guild icon, name and online count. "POWERED BY DISCORD" as the footer of the widget                                                           | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner1) |
 | banner2 | smaller widget style with guild icon, name and online count. Split on the right with Discord logo                                                              | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner2) |
 | banner3 | large image with guild icon, name and online count. In the footer, Discord logo on the left and "Chat Now" on the right                                        | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner3) |
 | banner4 | large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget and a "JOIN MY SERVER" button at the bottom | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner4) |
+
+## Update Self Voice State % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/voice-states/@me


"Update Current User Voice State"

msciotti · 2021-04-06T20:39:39Z

docs/resources/Guild.md

+- You must have the `REQUEST_TO_SPEAK` permission to request to speak. You can always clear your own request to speak.
+- You are able to set `request_to_speak_timestamp` to any present or future time.
+
+## Update Others Voice State % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/voice-states/{user.id#DOCS_RESOURCES_USER/user-object}


"Update User Voice State"

See discord/discord-api-docs#2751.

tpcstld requested review from night, msciotti and jhgg March 31, 2021 19:49

queer mentioned this pull request Mar 31, 2021

Support stage channels mewna/catnip#533

Closed

tpcstld commented Mar 31, 2021

View reviewed changes

auguwu mentioned this pull request Mar 31, 2021

Support Stage Channels auguwu/Wumpcord#153

Closed

advaith1 mentioned this pull request Mar 31, 2021

feat: stage channels discordjs/discord.js#5456

Merged

3 tasks

HarmoGlace mentioned this pull request Mar 31, 2021

feat: Add support for stage channels serenity-rs/serenity#1275

Merged

5 tasks

xiBread mentioned this pull request Mar 31, 2021

add thread & stage channel types #2693

Closed

tpcstld force-pushed the stage-channels branch from 8c2acf1 to 6678ee8 Compare March 31, 2021 21:15

TheChilliPL mentioned this pull request Mar 31, 2021

Add support for stage channels discord-jda/JDA#1572

Closed

3 tasks

satoufuyuki mentioned this pull request Apr 1, 2021

Stage Channel Support Hazmi35/jukebox#414

Closed

This was referenced Apr 1, 2021

Stage Channels shardlab/discordrb#43

Open

Implement new stage channels and instances shardlab/discordcr#12

Merged

7596ff mentioned this pull request Apr 1, 2021

Implement stage channels twilight-rs/twilight#746

Closed

3 tasks

vladfrangu mentioned this pull request Apr 1, 2021

feat: stage channels! discordjs/discord-api-types#107

Merged

HanabishiRecca reviewed Apr 1, 2021

View reviewed changes

ghost mentioned this pull request Apr 1, 2021

feat: add support for stage channels discordeno/discordeno#728

Merged

MinnDevelopment mentioned this pull request Apr 2, 2021

First pass on stage channels discord-jda/JDA#1575

Merged

6 tasks

DjDeveloperr mentioned this pull request Apr 3, 2021

feat: stage channels harmonyland/harmony#121

Closed

This was referenced Apr 3, 2021

Adds Stage channel Discord4J/discord-json#55

Merged

Adds Stage channel Discord4J/Discord4J#885

Merged

DRSchlaubi mentioned this pull request Apr 3, 2021

Add support for stage channels kordlib/kord#236

Closed

msciotti requested changes Apr 6, 2021

View reviewed changes

Add stage channel type.

1c244ea

tpcstld added 5 commits April 6, 2021 16:53

Document request to speak timestamp.

91a3434

Document voice state endpoints.

1906dce

Document permission.

42011dc

Separate stage from voice permission

caab035

Review.

5dcf679

tpcstld force-pushed the stage-channels branch from 6678ee8 to 5dcf679 Compare April 6, 2021 23:58

tpcstld merged commit 71cc444 into master Apr 7, 2021

tpcstld deleted the stage-channels branch April 7, 2021 00:00

almostSouji mentioned this pull request Apr 9, 2021

feat(Permissions): new bits USE_SLASH_COMMANDS, REQUEST_TO_SPEAK discordjs/discord.js#5515

Closed

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request Apr 10, 2021

Implement support for stage channels.

8946e9b

See discord/discord-api-docs#2751.

itohatweb mentioned this pull request Apr 13, 2021

Add support for staged channels discordeno/discordeno#852

Closed

james7132 mentioned this pull request Apr 22, 2021

models: Implement stage channels twilight-rs/twilight#793

Merged

BinkanSalaryman mentioned this pull request Jun 23, 2021

Support stage channels BinkanSalaryman/Discord-Audio-Stream-Bot#47

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Documentation for Stage Channels. #2751

API Documentation for Stage Channels. #2751

tpcstld commented Mar 31, 2021

tpcstld Mar 31, 2021

msciotti Apr 6, 2021

ven commented Mar 31, 2021

alii commented Mar 31, 2021

tpcstld Mar 31, 2021

HanabishiRecca Apr 1, 2021

advaith1 Apr 1, 2021

amishshah commented Apr 2, 2021

tpcstld commented Apr 2, 2021

msciotti left a comment

msciotti Apr 6, 2021

msciotti Apr 6, 2021

API Documentation for Stage Channels. #2751

API Documentation for Stage Channels. #2751

Conversation

tpcstld commented Mar 31, 2021

Summary

tpcstld Mar 31, 2021

Choose a reason for hiding this comment

msciotti Apr 6, 2021

Choose a reason for hiding this comment

ven commented Mar 31, 2021

alii commented Mar 31, 2021

tpcstld Mar 31, 2021

Choose a reason for hiding this comment

HanabishiRecca Apr 1, 2021

Choose a reason for hiding this comment

advaith1 Apr 1, 2021

Choose a reason for hiding this comment

amishshah commented Apr 2, 2021

tpcstld commented Apr 2, 2021

msciotti left a comment

Choose a reason for hiding this comment

msciotti Apr 6, 2021

Choose a reason for hiding this comment

msciotti Apr 6, 2021

Choose a reason for hiding this comment