Document Stage Instances. #2898
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tpcstld
commented
May 8, 2021
|
|
||
| ## Auto Closing | ||
|
|
||
| When a Stage channel has no speakers for a certain period of time (on the order of minutes) it will be automatically deleted. |
There was a problem hiding this comment.
For some extra color, this should be on average 10-15 minutes. The exact time is an implementation detail and will not be documented. (Since we might tune it without warning.)
The goal for us here is to not have lingering stage instances with basically no one in them. We found that for large Stages listeners just go AFK. In the future, we plan that ending a stage instance will kick everyone out of the stage.
apacheli
reviewed
May 8, 2021
tpcstld
force-pushed
the
stage-instances
branch
2 times, most recently
from
fe44299 to
99d10c2
Compare
NCPlayz
reviewed
May 9, 2021
6 tasks
ghost
mentioned this pull request
itohatweb
added a commit
to discordeno/discordeno
that referenced
this pull request
May 12, 2021
* feat: implement stage instances Reference: discord/discord-api-docs#2898 * feat: implement stage instances * Update src/types/misc/stage_instance.ts Co-authored-by: ITOH <[email protected]> * Update src/helpers/misc/delete_stage_instance.ts Co-authored-by: ITOH <[email protected]> * Update src/types/misc/stage_instance.ts Co-authored-by: ITOH <[email protected]> * Move stage instances related modules to channels module * Move to channels * Move to channels * Add permission checks * Add permissions checl * Ad inhibitors * style: fix lint warnings * Do not throw & add import type Co-authored-by: ITOH <[email protected]>
Nihlus
added a commit
to Remora/Remora.Discord
that referenced
this pull request
May 20, 2021
arqunis
pushed a commit
to serenity-rs/serenity
that referenced
this pull request
Jul 2, 2021
This commit adds support to creating, editing, getting, and deleting stage instances. See discord/discord-api-docs#2898 and discord/discord-api-docs#2933
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now presenting the sequel to Stage channels documentation, Stage instances!
Summary
Status: APIs are already available.
While developing, you may notice some more fields than what are documented. This is because we're still working on this stuff right now. We'll be incrementally documenting more and more fields as they become finalized and production ready. Please ignore every un-documented field.
Our main motivation of getting this PR out early is that we've started noticing bots changing the Stage channel's topic to programmatically edit the Stage topic. This is currently fine*, but it will probably break in the near future (on the order of weeks? I know this is a super fast change). So if you're doing that, we would much prefer people hack on this API instead. FWIW this is the reason why I didn't document topic behaviour in the Stage channels PR.
* We currently have compatibility code which means changing channel topic <-> changing stage instance. And that's the thing we're looking to remove soon.
Future stuff