Skip to content

Commit f5f3cda

Browse files
authored
fix: wording & missing info for interaction related docs (#7836)
* fix: name type correctly * fix: partial channel has more fields * fix: statement of line wasn't true * fix: wording * fix: wording we're talking about "you" (the user) here * fix: we should link that as well :) * fix: formatting / word splitting * fix: wording, again
1 parent 3074538 commit f5f3cda

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

docs/components/reference.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -432,9 +432,9 @@ String Selects are available in messages and modals. They must be placed inside
432432
```
433433
</Collapsible>
434434

435-
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a StringSelect" icon="code">
435+
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a String Select" icon="code">
436436

437-
When a user submits a modal that contains a StringSelect, this is the basic form of the interaction data payload you will receive. The full payload
437+
When a user submits a modal that contains a String Select, this is the basic form of the interaction data payload you will receive. The full payload
438438
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
439439

440440
```json
@@ -646,9 +646,9 @@ User Selects are available in messages and modals. They must be placed inside an
646646
```
647647
</Collapsible>
648648

649-
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a UserSelect in a message" icon="code">
649+
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a User Select in a message" icon="code">
650650

651-
When a user interacts with a UserSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
651+
When a user interacts with a User Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
652652
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
653653

654654
:::info
@@ -681,7 +681,7 @@ User Selects are available in messages and modals. They must be placed inside an
681681
"permissions": "2248473465835073",
682682
"premium_since": null,
683683
"roles": [
684-
"2222222222222222222"
684+
"2222222222222222222"
685685
],
686686
"unusual_dm_activity_until": null
687687
}
@@ -737,9 +737,9 @@ User Selects are available in messages and modals. They must be placed inside an
737737
```
738738
</Collapsible>
739739

740-
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a UserSelect" icon="code">
740+
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a User Select" icon="code">
741741

742-
When a user submits a modal that contains a UserSelect, this is the basic form of the interaction data payload you will receive. The full payload
742+
When a user submits a modal that contains a User Select, this is the basic form of the interaction data payload you will receive. The full payload
743743
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
744744

745745
```json
@@ -886,9 +886,9 @@ Role Selects are available in messages and modals. They must be placed inside an
886886
```
887887
</Collapsible>
888888

889-
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a RoleSelect in a message" icon="code">
889+
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Role Select in a message" icon="code">
890890

891-
When a user interacts with a RoleSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
891+
When a user interacts with a Role Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
892892
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
893893

894894
```json
@@ -960,9 +960,9 @@ Role Selects are available in messages and modals. They must be placed inside an
960960
```
961961
</Collapsible>
962962

963-
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a RoleSelect" icon="code">
963+
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Role Select" icon="code">
964964

965-
When a user submits a modal that contains a RoleSelect, this is the basic form of the interaction data payload you will receive. The full payload
965+
When a user submits a modal that contains a Role Select, this is the basic form of the interaction data payload you will receive. The full payload
966966
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
967967

968968
```json
@@ -1101,9 +1101,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
11011101
```
11021102
</Collapsible>
11031103

1104-
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a MentionableSelect in a message" icon="code">
1104+
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Mentionable Select in a message" icon="code">
11051105

1106-
When a user interacts with a MentionableSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
1106+
When a user interacts with a Mentionable Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
11071107
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
11081108

11091109
:::info
@@ -1137,7 +1137,7 @@ Mentionable Selects are available in messages and modals. They must be placed in
11371137
"permissions": "2248473465835073",
11381138
"premium_since": null,
11391139
"roles": [
1140-
"2222222222222222222"
1140+
"2222222222222222222"
11411141
],
11421142
"unusual_dm_activity_until": null
11431143
}
@@ -1213,9 +1213,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
12131213
```
12141214
</Collapsible>
12151215

1216-
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a MentionableSelect" icon="code">
1216+
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Mentionable Select" icon="code">
12171217

1218-
When a user submits a modal that contains a MentionableSelect, this is the basic form of the interaction data payload you will receive. The full payload
1218+
When a user submits a modal that contains a Mentionable Select, this is the basic form of the interaction data payload you will receive. The full payload
12191219
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
12201220

12211221
```json
@@ -1336,9 +1336,9 @@ Channel Selects are available in messages and modals. They must be placed inside
13361336
```
13371337
</Collapsible>
13381338

1339-
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a ChannelSelect in a message" icon="code">
1339+
<Collapsible title="Message Interaction Data Example" description="When a user interacts with a Channel Select in a message" icon="code">
13401340

1341-
When a user interacts with a ChannelSelect in a message, this is the basic form of the interaction data payload you will receive. The full payload
1341+
When a user interacts with a Channel Select in a message, this is the basic form of the interaction data payload you will receive. The full payload
13421342
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
13431343

13441344
```json
@@ -1404,9 +1404,9 @@ Channel Selects are available in messages and modals. They must be placed inside
14041404
```
14051405
</Collapsible>
14061406

1407-
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a ChannelSelect" icon="code">
1407+
<Collapsible title="Modal Submit Interaction Data Example" description="When a user submits a modal containing a Channel Select" icon="code">
14081408

1409-
When a user submits a modal that contains a ChannelSelect, this is the basic form of the interaction data payload you will receive. The full payload
1409+
When a user submits a modal that contains a Channel Select, this is the basic form of the interaction data payload you will receive. The full payload
14101410
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
14111411

14121412
```json
@@ -1562,7 +1562,7 @@ To use this component in messages you must send the [message flag](/docs/resourc
15621562

15631563
###### Examples
15641564

1565-
<Collapsible title="Message Example" description="Message create payload with a TextDisplay component" icon="code">
1565+
<Collapsible title="Message Example" description="Message create payload with a Text Display component" icon="code">
15661566

15671567
<Collapsible title="Rendered Example" description="Visualization of the message created by the payload below" icon="image" nested={true}>
15681568
![Example of a Text Display with markdown](images/components/text-display.webp)
@@ -1975,7 +1975,7 @@ To use this component in messages you must send the [message flag](/docs/resourc
19751975
A Label is a top-level layout component. Labels wrap modal components with text as a label and optional description.
19761976

19771977
:::info
1978-
The `description` may display above or below the `component` depending on platform.
1978+
The `description` may display above or below the `component` depending on the platform.
19791979
:::
19801980

19811981
###### Label Structure
@@ -2005,7 +2005,7 @@ The `description` may display above or below the `component` depending on platfo
20052005
|-----------|----------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
20062006
| type | integer | `18` for a Label |
20072007
| id | integer | Unique identifier for the component |
2008-
| component | [interaction response label child component](/docs/components/reference#label-label-interaction-response-child-components) | The component within the label |
2008+
| component | [label interaction response child component](/docs/components/reference#label-label-interaction-response-child-components) | The component within the label |
20092009

20102010
###### Label Interaction Response Child Components
20112011

docs/interactions/receiving-and-responding.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ If data for a Member is included, data for its corresponding User will also be i
163163

164164
\* Partial `Member` objects are missing `user`, `deaf` and `mute` fields
165165

166-
\*\* Partial `Channel` objects only have `id`, `name`, `type` and `permissions` fields. Threads will also have `thread_metadata` and `parent_id` fields.
166+
\*\* Partial `Channel` objects only have `id`, `name`, `type`, `permissions`, `last_message_id`, `last_pin_timestamp`, `nsfw`, `parent_id`, `guild_id`, `flags`, `rate_limit_per_user`, `topic` and `position` fields. Threads will also have the `thread_metadata` field.
167167

168168
###### Application Command Interaction Data Option Structure
169169

@@ -277,7 +277,7 @@ Not all message fields are currently supported.
277277
| attachments? \*\* | array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description |
278278
| poll? | [poll](/docs/resources/poll#poll-create-request-object) request object | Details about the poll |
279279

280-
\* If you create a callback with the [type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE` the only valid [message flag](/docs/resources/message#message-object-message-flags) you may use is `EPHEMERAL`. If you'd like to create a component based message with `IS_COMPONENTS_V2` you must do that with the [followup](/docs/interactions/receiving-and-responding#followup-messages) message, not this one.
280+
\* If you create a callback with the [type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE` the only valid [message flag](/docs/resources/message#message-object-message-flags) you may use is `EPHEMERAL`. If you'd like to create a component based message with `IS_COMPONENTS_V2` you must do that with the [edit original response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) endpoint, not this one.
281281

282282
\*\* See [Uploading Files](/docs/reference#uploading-files) for details.
283283

@@ -364,8 +364,8 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow
364364
| type | integer | [Interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type) |
365365
| activity_instance_id? | string | Instance ID of the Activity if one was launched or joined |
366366
| response_message_id? | snowflake | ID of the message that was created by the interaction |
367-
| response_message_loading? | boolean | Whether or not the message is in a loading state |
368-
| response_message_ephemeral? | boolean | Whether or not the response message was ephemeral |
367+
| response_message_loading? | boolean | Whether the message is in a loading state |
368+
| response_message_ephemeral? | boolean | Whether the response message is ephemeral |
369369

370370
###### Interaction Callback Resource Object
371371

@@ -388,7 +388,7 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow
388388

389389
## Followup Messages
390390

391-
Sometimes, your bot will want to send followup messages to a user after responding to an interaction. Or, you may want to edit your original response. Whether you receive Interactions over the gateway or by outgoing webhook, you can use the following endpoints to edit your initial response or send followup messages:
391+
Sometimes, you want to send followup messages to a user after responding to an interaction. Or, you may want to edit your original response. Whether you receive Interactions over the gateway or by outgoing webhook, you can use the following endpoints to edit your initial response or send followup messages:
392392

393393
- [`PATCH /webhooks/<application_id>/<interaction_token>/messages/@original`](/docs/interactions/receiving-and-responding#edit-original-interaction-response) to edit your initial response to an Interaction
394394
- [`DELETE /webhooks/<application_id>/<interaction_token>/messages/@original`](/docs/interactions/receiving-and-responding#delete-original-interaction-response) to delete your initial response to an Interaction
@@ -445,7 +445,7 @@ Apps are limited to 5 followup messages per interaction if it was initiated from
445445

446446
Create a followup message for an Interaction. Functions the same as [Execute Webhook](/docs/resources/webhook#execute-webhook), but `wait` is always true. The `thread_id`, `avatar_url`, and `username` parameters are not supported when using this endpoint for interaction followups. You can use the `EPHEMERAL` [message flag](/docs/resources/message#message-object-message-flags) `1 << 6` (64) to send a message that only the user can see. You can also use the `IS_COMPONENTS_V2` [message flag](/docs/resources/message#message-object-message-flags) `1 << 15` (32768) to send a [component](/docs/components/reference)-based message.
447447

448-
When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the Edit Original Interaction Response endpoint in this case instead.
448+
When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) endpoint in this case instead.
449449

450450
## Get Followup Message
451451
<Route method="GET">/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object)</Route>

0 commit comments

Comments
 (0)