From a18222ff5b8e91af9ac37b9e797acd2c4b5c82ad Mon Sep 17 00:00:00 2001 From: "Lina L." Date: Thu, 23 Jan 2025 18:48:49 +0100 Subject: [PATCH 1/4] document soundmojis --- docs/Reference.mdx | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/Reference.mdx b/docs/Reference.mdx index 2b2eb65999..9aea2cdd93 100644 --- a/docs/Reference.mdx +++ b/docs/Reference.mdx @@ -257,19 +257,20 @@ Discord utilizes a subset of markdown for rendering message content on its clien ###### Formats -| Type | Structure | Example | -|-------------------------|-----------------------|---------------------------------| -| User | `<@USER_ID>` | `<@80351110224678912>` | -| User \* | `<@!USER_ID>` | `<@!80351110224678912>` | -| Channel | `<#CHANNEL_ID>` | `<#103735883630395392>` | -| Role | `<@&ROLE_ID>` | `<@&165511591545143296>` | -| Slash Command \*\* | `` | `` | -| Standard Emoji | Unicode Characters | 🦶 | -| Custom Emoji | `<:NAME:ID>` | `<:mmLol:216154654256398347>` | -| Custom Emoji (Animated) | `` | `` | -| Unix Timestamp | `` | `` | -| Unix Timestamp (Styled) | `` | `` | -| Guild Navigation | `` | `` | +| Type | Structure | Example | +|-------------------------|-----------------------------|-------------------------------------------------| +| User | `<@USER_ID>` | `<@80351110224678912>` | +| User \* | `<@!USER_ID>` | `<@!80351110224678912>` | +| Channel | `<#CHANNEL_ID>` | `<#103735883630395392>` | +| Role | `<@&ROLE_ID>` | `<@&165511591545143296>` | +| Slash Command \*\* | `` | `` | +| Standard Emoji | Unicode Characters | 🦶 | +| Custom Emoji | `<:NAME:ID>` | `<:mmLol:216154654256398347>` | +| Custom Emoji (Animated) | `` | `` | +| Unix Timestamp | `` | `` | +| Unix Timestamp (Styled) | `` | `` | +| Guild Navigation | `` | `` | +| Soundmoji \*\*\* | `` | `` | Using the markdown for either users, roles, or channels will usually mention the target(s) accordingly, but this can be suppressed using the `allowed_mentions` parameter when creating a message. Standard emoji are currently rendered using [Twemoji](https://twemoji.twitter.com/) for Desktop/Android and Apple's native emoji on iOS. @@ -279,6 +280,8 @@ Timestamps are expressed in seconds and display the given timestamp in the user' \*\* Subcommands and subcommand groups can also be mentioned by using respectively `` and ``. +\*\*\* `GUILD_ID` should be `0` when a [default sound](#DOCS_RESOURCES_SOUNDBOARD/list-default-soundboard-sounds) is used. + ###### Timestamp Styles | Style | Example Output | Description | @@ -529,3 +532,18 @@ For example: | ja | Japanese | 日本語 | | zh-TW | Chinese, Taiwan | 繁體中文 | | ko | Korean | 한국어 | + + +## Sounds + +#### Base URL + +``` +https://cdn.discordapp.com/ +``` + +###### Endpoints + +| Type | Path | +|------------------|----------------------------------------------------------------------------------| +| Soundboard Sound | soundboard-sounds/[sound_id](#DOCS_RESOURCES_SOUNDBOARD/soundboard-sound-object) | From f3b4f276cf7ed88d6509fff7b1e5938e4fae3198 Mon Sep 17 00:00:00 2001 From: "Lina L." Date: Thu, 23 Jan 2025 20:25:41 +0100 Subject: [PATCH 2/4] forgot to update the message payload --- docs/resources/Message.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/resources/Message.md b/docs/resources/Message.md index 1adcbe0f83..54a0143433 100644 --- a/docs/resources/Message.md +++ b/docs/resources/Message.md @@ -54,6 +54,7 @@ Represents a message sent in a channel within Discord. | resolved? | [resolved](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-resolved-data-structure) data | data for users, members, channels, and roles in the message's [auto-populated select menus](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/select-menus) | | poll? \[2\] | [poll](#DOCS_RESOURCES_POLL/poll-object) object | A poll! | | call? | [message call](#DOCS_RESOURCES_MESSAGE/message-call-object) object | the call associated with the message | +| soundboard_sounds? | array of [soundboard sounds](#DOCS_RESOURCES_SOUNDBOARD/soundboard-sound-object) | sent if the message contains soundmojis \[1\] The author object follows the structure of the user object, but is only a valid user in the case where the message is generated by a user or bot user. If the message is generated by a webhook, the author object corresponds to the webhook's id, username, and avatar. You can tell if a message is generated by a webhook by checking for the `webhook_id` on the message object. From e373314b4c9c0780179dc1b8bd8ad4387d5ec4fa Mon Sep 17 00:00:00 2001 From: "Lina L." Date: Thu, 23 Jan 2025 20:26:43 +0100 Subject: [PATCH 3/4] remove sounds from reference --- docs/Reference.mdx | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/docs/Reference.mdx b/docs/Reference.mdx index 9aea2cdd93..8c8055fc77 100644 --- a/docs/Reference.mdx +++ b/docs/Reference.mdx @@ -532,18 +532,3 @@ For example: | ja | Japanese | 日本語 | | zh-TW | Chinese, Taiwan | 繁體中文 | | ko | Korean | 한국어 | - - -## Sounds - -#### Base URL - -``` -https://cdn.discordapp.com/ -``` - -###### Endpoints - -| Type | Path | -|------------------|----------------------------------------------------------------------------------| -| Soundboard Sound | soundboard-sounds/[sound_id](#DOCS_RESOURCES_SOUNDBOARD/soundboard-sound-object) | From daf419cec62fc09e75c8e561f086329290490aa1 Mon Sep 17 00:00:00 2001 From: "Lina L." Date: Sun, 26 Jan 2025 16:56:39 +0100 Subject: [PATCH 4/4] update message snapshot --- docs/resources/Message.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/Message.md b/docs/resources/Message.md index 54a0143433..3588961267 100644 --- a/docs/resources/Message.md +++ b/docs/resources/Message.md @@ -417,7 +417,7 @@ The encoding, and the waveform details, are an implementation detail and may cha | message\* | partial [message](#DOCS_RESOURCES_MESSAGE/message-object) object | minimal subset of fields in the forwarded message | \* The current subset of message fields consists of: -`type`, `content`, `embeds`, `attachments`, `timestamp`, `edited_timestamp`, `flags`, `mentions`, `mention_roles`, `stickers`, `sticker_items`, and `components`. +`type`, `content`, `embeds`, `attachments`, `timestamp`, `edited_timestamp`, `flags`, `mentions`, `mention_roles`, `stickers`, `sticker_items`, `components`, and `soundboard_sounds`. > info > While message snapshots are able to support nested snapshots, we currently limit the depth of nesting to 1.