Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document set voice channel status #6398

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/resources/Channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Represents a guild or DM channel within Discord.
| permission_overwrites? | array of [overwrite](#DOCS_RESOURCES_CHANNEL/overwrite-object) objects | explicit permission overwrites for members and roles |
| name? | ?string | the name of the channel (1-100 characters) |
| topic? | ?string | the channel topic (0-4096 characters for `GUILD_FORUM` and `GUILD_MEDIA` channels, 0-1024 characters for all others) |
| status? | ?string | the voice channel status (0-500 characters) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| status? | ?string | the voice channel status (0-500 characters) |
| status? | ?string | the voice channel status (0-500 characters), only included in the Guild Create event |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for this?

| nsfw? | boolean | whether the channel is nsfw |
| last_message_id? | ?snowflake | the id of the last message sent in this channel (or thread for `GUILD_FORUM` or `GUILD_MEDIA` channels) (may not point to an existing or valid message or thread) |
| bitrate? | integer | the bitrate (in bits) of the voice channel |
Expand Down
10 changes: 10 additions & 0 deletions docs/topics/Gateway_Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,16 @@ This event may reference roles or guild members that no longer exist in the guil

Sent when a channel relevant to the current user is deleted. The inner payload is a [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object.

#### Voice Channel Status Update

Sent when the voice channel status changes.

| Field | Type | Description |
|----------|-----------|------------------------------|
| id | snowflake | The channel id |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be id or channel_id?

Copy link
Contributor

@Misha-133 Misha-133 Sep 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's just id
example payload:

<- Dispatch [VOICE_CHANNEL_STATUS_UPDATE] : 
{
  "status": "123",
  "id": "111...",
  "guild_id": "490..."
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, thank you!

| guild_id | snowflake | The guild id |
| status | ?string | The new voice channel status |

#### Thread Create

Sent when a thread is created, relevant to the current user, or when the current user is added to a thread. The inner payload is a [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object.
Expand Down
1 change: 1 addition & 0 deletions docs/topics/Permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Below is a table of all current permissions, their integer values in hexadecimal
| USE_SOUNDBOARD | `0x0000040000000000` `(1 << 42)` | Allows for using soundboard in a voice channel | V |
| USE_EXTERNAL_SOUNDS | `0x0000200000000000` `(1 << 45)` | Allows the usage of custom soundboard sounds from other servers | V |
| SEND_VOICE_MESSAGES | `0x0000400000000000` `(1 << 46)` | Allows sending voice messages | T, V, S |
| SET_VOICE_CHANNEL_STATUS | `0x0002000000000000` `(1 << 48)` | Allows setting voice channel status | V |
MinnDevelopment marked this conversation as resolved.
Show resolved Hide resolved

**\* These permissions require the owner account to use [two-factor authentication](#DOCS_TOPICS_OAUTH2/twofactor-authentication-requirement) when used on a guild that has server-wide 2FA enabled.**

Expand Down