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 super reactions #6056

Merged
merged 4 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
47 changes: 36 additions & 11 deletions docs/resources/Channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,11 +384,16 @@ Represents a message sent in a channel within Discord.
"reactions": [
{
"count": 1,
"count_details": {
"burst": 0,
"normal": 1
},
"me": false,
"emoji": {
"id": null,
"name": "🔥"
}
"id": null,
"name": "🔥"
},
"burst_colors": []
}
],
"attachments": [],
Expand Down Expand Up @@ -420,11 +425,17 @@ Represents a message sent in a channel within Discord.
"reactions": [
{
"count": 1,
"count_details": {
"burst": 0,
"normal": 1
},
"me": false,
"me_burst": false,
Mateo-tem marked this conversation as resolved.
Show resolved Hide resolved
"emoji": {
"id": null,
"name": "🔥"
}
"id": null,
"name": "🔥"
},
"burst_colors": []
}
],
"attachments": [],
Expand Down Expand Up @@ -525,11 +536,25 @@ There are multiple message types that have a message_reference object. Since me

###### Reaction Structure

| Field | Type | Description |
| ----- | ---------------------------------------------------------- | ------------------------------------------------- |
| count | integer | times this emoji has been used to react |
| me | boolean | whether the current user reacted using this emoji |
| emoji | partial [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | emoji information |
| Field | Type | Description |
| ------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| count | integer | Total number of times this emoji has been used to react (including super reacts) |
| count_details | object | [Reaction count details object](#DOCS_RESOURCES_CHANNEL/reaction-count-details-object) |
| me | boolean | Whether the current user reacted using this emoji |
| me_burst | boolean | Whether the current user super-reacted using this emoji |
| emoji | partial [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | emoji information |
| burst_colors | array | HEX colors used for super reaction |

### Reaction Count Details Object

The reaction count details object contains a breakdown of normal and super reaction counts for the associated emoji.

###### Reaction Count Details Structure

| Field | Type | Description |
| ------ | --------- | ----------------------------- |
| burst | integer | Count of super reactions |
| normal | integer | Count of normal reactions |

### Overwrite Object

Expand Down
1 change: 1 addition & 0 deletions docs/topics/Opcodes_and_Status_Codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ Along with the HTTP error code, our API can also return more detailed error code
| 60003 | Two factor is required for this operation |
| 80004 | No users with DiscordTag exist |
| 90001 | Reaction was blocked |
| 90002 | User cannot use burst reactions |
| 110001 | Application not yet available. Try again later |
| 130000 | API resource is currently overloaded. Try again a little later |
| 150006 | The Stage is already open |
Expand Down