You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: docs/components/reference.mdx
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -432,9 +432,9 @@ String Selects are available in messages and modals. They must be placed inside
432
432
```
433
433
</Collapsible>
434
434
435
-
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a StringSelect"icon="code">
435
+
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a String Select"icon="code">
436
436
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
438
438
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
439
439
440
440
```json
@@ -646,9 +646,9 @@ User Selects are available in messages and modals. They must be placed inside an
646
646
```
647
647
</Collapsible>
648
648
649
-
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a UserSelect in a message"icon="code">
649
+
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a User Select in a message"icon="code">
650
650
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
652
652
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
653
653
654
654
:::info
@@ -681,7 +681,7 @@ User Selects are available in messages and modals. They must be placed inside an
681
681
"permissions": "2248473465835073",
682
682
"premium_since": null,
683
683
"roles": [
684
-
"2222222222222222222"
684
+
"2222222222222222222"
685
685
],
686
686
"unusual_dm_activity_until": null
687
687
}
@@ -737,9 +737,9 @@ User Selects are available in messages and modals. They must be placed inside an
737
737
```
738
738
</Collapsible>
739
739
740
-
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a UserSelect"icon="code">
740
+
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a User Select"icon="code">
741
741
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
743
743
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
744
744
745
745
```json
@@ -886,9 +886,9 @@ Role Selects are available in messages and modals. They must be placed inside an
886
886
```
887
887
</Collapsible>
888
888
889
-
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a RoleSelect in a message"icon="code">
889
+
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a Role Select in a message"icon="code">
890
890
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
892
892
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
893
893
894
894
```json
@@ -960,9 +960,9 @@ Role Selects are available in messages and modals. They must be placed inside an
960
960
```
961
961
</Collapsible>
962
962
963
-
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a RoleSelect"icon="code">
963
+
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a Role Select"icon="code">
964
964
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
966
966
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
967
967
968
968
```json
@@ -1101,9 +1101,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
1101
1101
```
1102
1102
</Collapsible>
1103
1103
1104
-
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a MentionableSelect in a message"icon="code">
1104
+
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a Mentionable Select in a message"icon="code">
1105
1105
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
1107
1107
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
1108
1108
1109
1109
:::info
@@ -1137,7 +1137,7 @@ Mentionable Selects are available in messages and modals. They must be placed in
1137
1137
"permissions": "2248473465835073",
1138
1138
"premium_since": null,
1139
1139
"roles": [
1140
-
"2222222222222222222"
1140
+
"2222222222222222222"
1141
1141
],
1142
1142
"unusual_dm_activity_until": null
1143
1143
}
@@ -1213,9 +1213,9 @@ Mentionable Selects are available in messages and modals. They must be placed in
1213
1213
```
1214
1214
</Collapsible>
1215
1215
1216
-
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a MentionableSelect"icon="code">
1216
+
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a Mentionable Select"icon="code">
1217
1217
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
1219
1219
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
1220
1220
1221
1221
```json
@@ -1336,9 +1336,9 @@ Channel Selects are available in messages and modals. They must be placed inside
1336
1336
```
1337
1337
</Collapsible>
1338
1338
1339
-
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a ChannelSelect in a message"icon="code">
1339
+
<Collapsibletitle="Message Interaction Data Example"description="When a user interacts with a Channel Select in a message"icon="code">
1340
1340
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
1342
1342
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
1343
1343
1344
1344
```json
@@ -1404,9 +1404,9 @@ Channel Selects are available in messages and modals. They must be placed inside
1404
1404
```
1405
1405
</Collapsible>
1406
1406
1407
-
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a ChannelSelect"icon="code">
1407
+
<Collapsibletitle="Modal Submit Interaction Data Example"description="When a user submits a modal containing a Channel Select"icon="code">
1408
1408
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
1410
1410
is available in the [interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) reference.
1411
1411
1412
1412
```json
@@ -1562,7 +1562,7 @@ To use this component in messages you must send the [message flag](/docs/resourc
1562
1562
1563
1563
###### Examples
1564
1564
1565
-
<Collapsibletitle="Message Example"description="Message create payload with a TextDisplay component"icon="code">
1565
+
<Collapsibletitle="Message Example"description="Message create payload with a Text Display component"icon="code">
1566
1566
1567
1567
<Collapsibletitle="Rendered Example"description="Visualization of the message created by the payload below"icon="image"nested={true}>
1568
1568

@@ -1975,7 +1975,7 @@ To use this component in messages you must send the [message flag](/docs/resourc
1975
1975
A Label is a top-level layout component. Labels wrap modal components with text as a label and optional description.
1976
1976
1977
1977
:::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.
1979
1979
:::
1980
1980
1981
1981
###### Label Structure
@@ -2005,7 +2005,7 @@ The `description` may display above or below the `component` depending on platfo
| 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 |
Copy file name to clipboardExpand all lines: docs/interactions/receiving-and-responding.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -163,7 +163,7 @@ If data for a Member is included, data for its corresponding User will also be i
163
163
164
164
\* Partial `Member` objects are missing `user`, `deaf` and `mute` fields
165
165
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.
167
167
168
168
###### Application Command Interaction Data Option Structure
169
169
@@ -277,7 +277,7 @@ Not all message fields are currently supported.
277
277
| attachments? \*\*| array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description |
278
278
| poll? |[poll](/docs/resources/poll#poll-create-request-object) request object | Details about the poll |
279
279
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.
281
281
282
282
\*\* See [Uploading Files](/docs/reference#uploading-files) for details.
283
283
@@ -364,8 +364,8 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow
364
364
| type | integer |[Interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type)|
365
365
| activity_instance_id? | string | Instance ID of the Activity if one was launched or joined |
366
366
| 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|
369
369
370
370
###### Interaction Callback Resource Object
371
371
@@ -388,7 +388,7 @@ Interaction `tokens` are valid for **15 minutes** and can be used to send follow
388
388
389
389
## Followup Messages
390
390
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:
392
392
393
393
-[`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
394
394
-[`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
445
445
446
446
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.
447
447
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.
0 commit comments