dfx 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/DiscordREST/types.js +6 -0
- package/DiscordREST/types.js.map +1 -0
- package/DiscordWS/index.js +2 -0
- package/DiscordWS/index.js.map +1 -0
- package/README.md +3 -0
- package/WS/index.js +71 -0
- package/WS/index.js.map +1 -0
- package/discord-api-docs/index.js +1 -0
- package/mod.js.map +1 -0
- package/package.json +6 -1
- package/types.js +1563 -0
- package/types.js.map +1 -0
- package/websocket.js +11 -0
- package/websocket.js.map +1 -0
- package/.gitmodules +0 -3
- package/.prettierrc.json +0 -4
- package/discord-api-docs/.eslintrc.json +0 -10
- package/discord-api-docs/.gitattributes +0 -11
- package/discord-api-docs/.github/ISSUE_TEMPLATE/api-bug-report.yml +0 -49
- package/discord-api-docs/.github/ISSUE_TEMPLATE/config.yml +0 -20
- package/discord-api-docs/.github/ISSUE_TEMPLATE/developer-site-bug-report.yml +0 -49
- package/discord-api-docs/.github/ISSUE_TEMPLATE/message-components-bug-report.yml +0 -49
- package/discord-api-docs/.github/ISSUE_TEMPLATE/slash-command-bug-report.yml +0 -49
- package/discord-api-docs/.github/workflows/test.yaml +0 -45
- package/discord-api-docs/.prettierignore +0 -1
- package/discord-api-docs/.prettierrc.json +0 -15
- package/discord-api-docs/CODE_OF_CONDUCT.md +0 -75
- package/discord-api-docs/CONTRIBUTING.md +0 -16
- package/discord-api-docs/README.md +0 -35
- package/discord-api-docs/docs/Change_Log.md +0 -474
- package/discord-api-docs/docs/Intro.md +0 -48
- package/discord-api-docs/docs/Legal.md +0 -154
- package/discord-api-docs/docs/Policy.md +0 -81
- package/discord-api-docs/docs/Reference.md +0 -476
- package/discord-api-docs/docs/Store_Distribution_Agreement.md +0 -179
- package/discord-api-docs/docs/dispatch/Branches_and_Builds.md +0 -654
- package/discord-api-docs/docs/dispatch/Dispatch_and_You.md +0 -17
- package/discord-api-docs/docs/dispatch/Error_Codes.md +0 -26
- package/discord-api-docs/docs/dispatch/Field_Values.md +0 -48
- package/discord-api-docs/docs/dispatch/List_of_Commands.md +0 -315
- package/discord-api-docs/docs/game_and_server_management/Alpha_and_Beta_Testing.md +0 -52
- package/discord-api-docs/docs/game_and_server_management/How_to_Get_Your_Game_on_Discord.md +0 -110
- package/discord-api-docs/docs/game_and_server_management/Special_Channels.md +0 -38
- package/discord-api-docs/docs/game_sdk/Achievements.md +0 -405
- package/discord-api-docs/docs/game_sdk/Activities.md +0 -561
- package/discord-api-docs/docs/game_sdk/Applications.md +0 -237
- package/discord-api-docs/docs/game_sdk/Discord.md +0 -443
- package/discord-api-docs/docs/game_sdk/Discord_Voice.md +0 -289
- package/discord-api-docs/docs/game_sdk/Images.md +0 -196
- package/discord-api-docs/docs/game_sdk/Lobbies.md +0 -1639
- package/discord-api-docs/docs/game_sdk/Networking.md +0 -377
- package/discord-api-docs/docs/game_sdk/Overlay.md +0 -195
- package/discord-api-docs/docs/game_sdk/Relationships.md +0 -234
- package/discord-api-docs/docs/game_sdk/SDK_Starter_Guide.md +0 -310
- package/discord-api-docs/docs/game_sdk/Storage.md +0 -312
- package/discord-api-docs/docs/game_sdk/Store.md +0 -555
- package/discord-api-docs/docs/game_sdk/Users.md +0 -178
- package/discord-api-docs/docs/interactions/Application_Commands.md +0 -1069
- package/discord-api-docs/docs/interactions/Message_Components.md +0 -454
- package/discord-api-docs/docs/interactions/Receiving_and_Responding.md +0 -372
- package/discord-api-docs/docs/interactions/Slash_Commands.md +0 -3
- package/discord-api-docs/docs/resources/Application.md +0 -82
- package/discord-api-docs/docs/resources/Audit_Log.md +0 -223
- package/discord-api-docs/docs/resources/Channel.md +0 -1267
- package/discord-api-docs/docs/resources/Emoji.md +0 -122
- package/discord-api-docs/docs/resources/Guild.md +0 -1157
- package/discord-api-docs/docs/resources/Guild_Scheduled_Event.md +0 -273
- package/discord-api-docs/docs/resources/Guild_Template.md +0 -148
- package/discord-api-docs/docs/resources/Invite.md +0 -150
- package/discord-api-docs/docs/resources/Stage_Instance.md +0 -106
- package/discord-api-docs/docs/resources/Sticker.md +0 -164
- package/discord-api-docs/docs/resources/User.md +0 -205
- package/discord-api-docs/docs/resources/Voice.md +0 -55
- package/discord-api-docs/docs/resources/Webhook.md +0 -281
- package/discord-api-docs/docs/rich_presence/Best_Practices.md +0 -88
- package/discord-api-docs/docs/rich_presence/FAQ.md +0 -45
- package/discord-api-docs/docs/rich_presence/How_To.md +0 -302
- package/discord-api-docs/docs/rich_presence/Launch_Checklist.md +0 -46
- package/discord-api-docs/docs/topics/Certified_Devices.md +0 -200
- package/discord-api-docs/docs/topics/Community_Resources.md +0 -98
- package/discord-api-docs/docs/topics/Gateway.md +0 -1600
- package/discord-api-docs/docs/topics/OAuth2.md +0 -427
- package/discord-api-docs/docs/topics/Opcodes_and_Status_Codes.md +0 -306
- package/discord-api-docs/docs/topics/Permissions.md +0 -229
- package/discord-api-docs/docs/topics/RPC.md +0 -1597
- package/discord-api-docs/docs/topics/Rate_Limits.md +0 -126
- package/discord-api-docs/docs/topics/Teams.md +0 -80
- package/discord-api-docs/docs/topics/Threads.md +0 -163
- package/discord-api-docs/docs/topics/Voice_Connections.md +0 -282
- package/discord-api-docs/images/API_center.gif +0 -0
- package/discord-api-docs/images/ask-to-join.gif +0 -0
- package/discord-api-docs/images/available-published.png +0 -0
- package/discord-api-docs/images/button-styles.png +0 -0
- package/discord-api-docs/images/certified-device.png +0 -0
- package/discord-api-docs/images/command-with-groups-subcommands-parameters.png +0 -0
- package/discord-api-docs/images/command-with-groups-subcommands.png +0 -0
- package/discord-api-docs/images/command.png +0 -0
- package/discord-api-docs/images/cpp-files-sdk.png +0 -0
- package/discord-api-docs/images/create-store-channel.png +0 -0
- package/discord-api-docs/images/deferred-example.png +0 -0
- package/discord-api-docs/images/desktop-select.png +0 -0
- package/discord-api-docs/images/game-overlay-sdk-invite.gif +0 -0
- package/discord-api-docs/images/game-overlay-sdk-voice-settings.png +0 -0
- package/discord-api-docs/images/game-overlay-sdk-voice-widget.png +0 -0
- package/discord-api-docs/images/gift-code-creation.png +0 -0
- package/discord-api-docs/images/lib-linked-sdk.png +0 -0
- package/discord-api-docs/images/message-command.png +0 -0
- package/discord-api-docs/images/mobile-select.png +0 -0
- package/discord-api-docs/images/previous-new-server-background.png +0 -0
- package/discord-api-docs/images/rp-actionable.png +0 -0
- package/discord-api-docs/images/rp-all-fields.png +0 -0
- package/discord-api-docs/images/rp-bad-art.png +0 -0
- package/discord-api-docs/images/rp-good-art.png +0 -0
- package/discord-api-docs/images/rp-legend.png +0 -0
- package/discord-api-docs/images/rp-long-strings.png +0 -0
- package/discord-api-docs/images/rp-non-actionable.png +0 -0
- package/discord-api-docs/images/rp-not-all-fields.png +0 -0
- package/discord-api-docs/images/rp-profile-example-1.png +0 -0
- package/discord-api-docs/images/rp-profile-example-2.png +0 -0
- package/discord-api-docs/images/rp-short-strings.png +0 -0
- package/discord-api-docs/images/server-banner-example.png +0 -0
- package/discord-api-docs/images/server-banner-margin-top.png +0 -0
- package/discord-api-docs/images/sku-management.png +0 -0
- package/discord-api-docs/images/snowflake.png +0 -0
- package/discord-api-docs/images/snowflake_original_size.png +0 -0
- package/discord-api-docs/images/spectate.gif +0 -0
- package/discord-api-docs/images/team-2fa.png +0 -0
- package/discord-api-docs/images/team-make-app.png +0 -0
- package/discord-api-docs/images/team-page.png +0 -0
- package/discord-api-docs/images/transfer-app-to-team.png +0 -0
- package/discord-api-docs/images/user-command.png +0 -0
- package/discord-api-docs/package-lock.json +0 -3186
- package/discord-api-docs/package.json +0 -38
- package/discord-api-docs/tsconfig.eslint.json +0 -4
- package/discord-api-docs/tsconfig.json +0 -19
- package/tsconfig.json +0 -24
|
@@ -1,474 +0,0 @@
|
|
|
1
|
-
# Change Log
|
|
2
|
-
|
|
3
|
-
## Interaction Modals and Application Command Attachment Option Type
|
|
4
|
-
|
|
5
|
-
#### Feb 8, 2022
|
|
6
|
-
|
|
7
|
-
Interaction modals are now available, allowing applications to prompt users for further detailed input. Check out [the modal docs](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-response-object-modal) for more information.
|
|
8
|
-
|
|
9
|
-
Application Commands can now add an attachment option type. See [the option type table](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/application-command-object-application-command-option-type) for more information.
|
|
10
|
-
|
|
11
|
-
## Guild Member Timeouts
|
|
12
|
-
|
|
13
|
-
#### Dec 20, 2021
|
|
14
|
-
|
|
15
|
-
Add new documentation for the recently released guild member timeout feature.
|
|
16
|
-
|
|
17
|
-
## Guild Scheduled Events
|
|
18
|
-
|
|
19
|
-
#### Nov 23, 2021
|
|
20
|
-
|
|
21
|
-
- Add official support for `guild_scheduled_events` field on `Guild` resource sent with `GUILD_CREATE` event
|
|
22
|
-
|
|
23
|
-
#### Nov 18, 2021
|
|
24
|
-
|
|
25
|
-
- Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`
|
|
26
|
-
- Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
|
|
27
|
-
- Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}`
|
|
28
|
-
- More details and clarification for the guild scheduled events feature.
|
|
29
|
-
- Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users`
|
|
30
|
-
|
|
31
|
-
#### Nov 15, 2021
|
|
32
|
-
|
|
33
|
-
Add new documentation for the recently released Guild Scheduled Events feature.
|
|
34
|
-
|
|
35
|
-
## Application Command Autocomplete Interactions
|
|
36
|
-
|
|
37
|
-
#### October 27, 2021
|
|
38
|
-
|
|
39
|
-
Autocomplete interactions are now available, allowing application commands to provide server completed options. Check out [the autocomplete interaction docs](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/autocomplete) for more information.
|
|
40
|
-
|
|
41
|
-
## Updated Thread Permissions
|
|
42
|
-
|
|
43
|
-
#### September 16, 2021
|
|
44
|
-
|
|
45
|
-
Thread permissions have been updated and simplified:
|
|
46
|
-
|
|
47
|
-
- "Use Public Threads" is now "Create Public Threads", which allows users to create public threads and announcement threads in a channel, even if they cannot send messages in that channel.
|
|
48
|
-
- "Use Private Threads" is now "Create Private Threads", which allows users to create private threads in a channel, even if they cannot send messages in that channel.
|
|
49
|
-
|
|
50
|
-
A new permission has also been added:
|
|
51
|
-
|
|
52
|
-
- "Send Messages in Threads", which allows users to send a message in a thread. The "Send Messages" permission has no effect in threads: users **must** have "Send Messages in Threads" to send a message in a thread. This allows for setups where a user can participate in a thread but cannot send a message in the parent channel (like a thread on an announcement post).
|
|
53
|
-
|
|
54
|
-
## User and Message Commands
|
|
55
|
-
|
|
56
|
-
#### August 10, 2021
|
|
57
|
-
|
|
58
|
-
[User commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/user-commands) and [message commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/message-commands) are now live! These commands appear on context menus for users and messages, with more to come in the future.
|
|
59
|
-
|
|
60
|
-
Context menu commands are a type of application command. The "Slash Commands" documentation page has been renamed to "Application Commands" and split out by type to show this.
|
|
61
|
-
|
|
62
|
-
## Select Menu Components
|
|
63
|
-
|
|
64
|
-
#### June 30, 2021
|
|
65
|
-
|
|
66
|
-
Select Menus are now part of the components API! They're the greatest thing since the invention of buttons yesterday. Select menus allow you to offer users a choice of one or many options in a friendly UI-based way.
|
|
67
|
-
|
|
68
|
-
Select menus can be used like other [message components](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/). Learn all the specifics in the [documentation](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/select-menus).
|
|
69
|
-
|
|
70
|
-
## Support for Multiple Embeds in Message Routes
|
|
71
|
-
|
|
72
|
-
#### June 10, 2021
|
|
73
|
-
|
|
74
|
-
Message routes now accept an embeds array in addition to the existing embed field. Bots can now send up to 10 embeds per message, to be consistent with webhook behavior. The existing embed field is considered deprecated and will be removed in the next API version.
|
|
75
|
-
|
|
76
|
-
## Buttons and Message Components
|
|
77
|
-
|
|
78
|
-
#### May 26, 2021
|
|
79
|
-
|
|
80
|
-
Message components are now available with our first two components: a layout-based `ActionRow` and...buttons!
|
|
81
|
-
|
|
82
|
-
You can now include buttons on messages sent by your app, whether they're bot messages or responses to interactions. [Learn more about message components](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS/).
|
|
83
|
-
|
|
84
|
-
The addition of message components means new fields and response types:
|
|
85
|
-
|
|
86
|
-
- An optional `components` field has been added to the [message object](#DOCS_RESOURCES_CHANNEL/message-object)
|
|
87
|
-
- New response types `6` and `7` have been added for [interaction responses](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-response-object-interaction-callback-type), valid only for component-based interactions
|
|
88
|
-
|
|
89
|
-
## API v9
|
|
90
|
-
|
|
91
|
-
#### April 28, 2021
|
|
92
|
-
|
|
93
|
-
API v9 is now available.
|
|
94
|
-
|
|
95
|
-
API v9 includes support for [threads](#DOCS_TOPICS_THREADS), an upcoming feature. Older API versions will not receive any Gateway Events for threads, so it is important to update soon! We've prepared a [migration guide](#DOCS_TOPICS_THREADS) to help make the upgrade process very straightforward.
|
|
96
|
-
|
|
97
|
-
This documentation is being published early so bots can have at least two months to upgrade before threads launch.
|
|
98
|
-
|
|
99
|
-
Additionally, API v9 also removes the `/channels/:id/messages/:id/suppress-embeds` route.
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
## Application Command Permissions
|
|
103
|
-
|
|
104
|
-
#### April 5, 2021
|
|
105
|
-
|
|
106
|
-
Need to keep some of your commands safe from prying eyes, or only available to the right people? Commands now support [command permissions](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/permissions)!
|
|
107
|
-
|
|
108
|
-
You can enable or disable a command (guild or global) for a specific user or role in a guild. For now, users will still be able to see the commands, but won't be able to use them.
|
|
109
|
-
|
|
110
|
-
New routes have been added to support this functionality:
|
|
111
|
-
|
|
112
|
-
- [`GET Guild Application Command Permissions`](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/get-guild-application-command-permissions)
|
|
113
|
-
- [`GET Application Command Permissions`](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/get-application-command-permissions)
|
|
114
|
-
- [`PUT Application Command Permissions`](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/batch-edit-application-command-permissions)
|
|
115
|
-
|
|
116
|
-
A `default_permission` field has also been added to the [ApplicationCommand](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/application-command-object-application-command-structure) model. This field allows you to disable commands for everyone in a guild by default, if you prefer to make some of your commands an opt-in experience.
|
|
117
|
-
|
|
118
|
-
## Large Bot Sharding Lowered to 150,000 Guilds
|
|
119
|
-
|
|
120
|
-
#### March 15, 2021
|
|
121
|
-
|
|
122
|
-
There have been reports that sessions have higher frequency of errors when starting if a bot has joined too many guilds (the gateway connection times out). To account for this we have lowered the requirement for large bot sharding down to 150,000 guilds in order to improve reliability.
|
|
123
|
-
|
|
124
|
-
## Changes to Slash Command Response Types and Flags
|
|
125
|
-
|
|
126
|
-
#### March 5, 2021
|
|
127
|
-
|
|
128
|
-
Changes to interaction response types have been made to support better designs for application commands:
|
|
129
|
-
|
|
130
|
-
- Type `2` `Acknowledge` has been deprecated
|
|
131
|
-
- Type `3` `ChannelMessage` has been deprecated
|
|
132
|
-
- Type `5` `AcknowledgeWithSource` has been renamed to `DeferredChannelMessageWithSource`
|
|
133
|
-
|
|
134
|
-
These deprecated types will be removed and break on **April 9, 2021**.
|
|
135
|
-
|
|
136
|
-
Additionally, `flags` has been documented on [InteractionApplicationCommandCallbackData](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-response-object-interaction-callback-data-structure). Setting `flags` to `64` will make the interaction response ephemeral.
|
|
137
|
-
|
|
138
|
-
## Slash Commands in DMs
|
|
139
|
-
|
|
140
|
-
#### February 9, 2021
|
|
141
|
-
|
|
142
|
-
Slash Commands are now supported in DMs with bots. Due to this change, some of the fields on the [Interaction object](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/interaction-object-interaction-structure) have been made optional. Newly optional fields don't reflect any behavior changes in Slash Commands within guilds; they are to support commands in the context of a DM only.
|
|
143
|
-
|
|
144
|
-
## Change to Permission Checking when Creating Channels
|
|
145
|
-
|
|
146
|
-
#### January 22, 2021
|
|
147
|
-
|
|
148
|
-
Permission overwrites in the guild channel creation endpoint are now validated against the permissions your bot has in the guild. Permission overwrites specified in the request body when creating guild channels will now require your bot to also have the permissions being applied. Setting `MANAGE_ROLES` permission in channel overwrites is only possible for guild administrators or users with `MANAGE_ROLES` as a permission overwrite in the channel.
|
|
149
|
-
|
|
150
|
-
## Slash Commands and Interactions
|
|
151
|
-
|
|
152
|
-
#### December 15, 2020
|
|
153
|
-
|
|
154
|
-
Slash Commands are here! There's a _lot_ to cover, so go check out specific documentation under [Slash Commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/).
|
|
155
|
-
|
|
156
|
-
Slash Commands include some new features for webhooks as well:
|
|
157
|
-
|
|
158
|
-
- Webhooks can now update previously-sent messages from the same webhook using [Edit Webhook Message](#DOCS_RESOURCES_WEBHOOK/edit-webhook-message) and [Delete Webhook Message](#DOCS_RESOURCES_WEBHOOK/delete-webhook-message)
|
|
159
|
-
|
|
160
|
-
This PR also documents the `application` field on the `READY` gateway event, which is a partial [application object](#DOCS_RESOURCES_APPLICATION/application-object) containing `id` and `flags`.
|
|
161
|
-
|
|
162
|
-
## Inline Replies
|
|
163
|
-
|
|
164
|
-
#### November 16, 2020
|
|
165
|
-
|
|
166
|
-
Inline Replies have been added to our documentation. They behave differently in v6 and v8, so be cautious in your implementation:
|
|
167
|
-
|
|
168
|
-
- Inline replies are type `19` in v8, but remain type `0` in v6
|
|
169
|
-
- You can now add a `message_reference` on message create to create a reply
|
|
170
|
-
- A new field `referenced_message` has been added to the [Message Object](#DOCS_RESOURCES_CHANNEL/message-object)
|
|
171
|
-
- A new field `replied_user` has been added to the [Allowed Mentions Object](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object)
|
|
172
|
-
- [Message Create](#DOCS_TOPICS_GATEWAY/message-create) gateway event is guaranteed to have a `referenced_message` if the message created is a reply. Otherwise, that field is not guaranteed.
|
|
173
|
-
|
|
174
|
-
## Stickers
|
|
175
|
-
|
|
176
|
-
#### November 13, 2020
|
|
177
|
-
|
|
178
|
-
Stickers are now documented as part of the [message](#DOCS_RESOURCES_CHANNEL/message-object) object.
|
|
179
|
-
|
|
180
|
-
## Gateway v6 Intent Restrictions
|
|
181
|
-
|
|
182
|
-
#### October 27, 2020
|
|
183
|
-
|
|
184
|
-
The v6 gateway now applies the restrictions for gateway intents. This means the new chunking limitations are now in effect, regardless of intents being used. See [Request Guild Members](#DOCS_TOPICS_GATEWAY/request-guild-members) for further details.
|
|
185
|
-
Additionally, if privileged intents are not enabled in the application dashboard the bot will not receive the events for those intents.
|
|
186
|
-
|
|
187
|
-
All other intents are always enabled by default unless specified otherwise by the identify payload. We have made a support article to explain some of the changes and resulting issues with more details: [Gateway Update FAQ](https://dis.gd/gwupdate)
|
|
188
|
-
|
|
189
|
-
## API and Gateway V8
|
|
190
|
-
|
|
191
|
-
#### September 24, 2020
|
|
192
|
-
|
|
193
|
-
We've introduced API and Gateway v8! Changes are noted throughout the documentation, and you can also read [this commit in our docs repo](https://github.com/discord/discord-api-docs/commit/545ff4a7883e5eee7ee91d19a5e5d760a0730033) for a full diff.
|
|
194
|
-
|
|
195
|
-
The changes are:
|
|
196
|
-
|
|
197
|
-
- API and Gateway v8 are now available. v6 is still the default for the time being.
|
|
198
|
-
- [Gateway Intents](#DOCS_TOPICS_GATEWAY/gateway-intents) are now required
|
|
199
|
-
- Removed `guild_subscriptions` in identify in favor of [Gateway Intents](#DOCS_TOPICS_GATEWAY/gateway-intents).
|
|
200
|
-
- All permissions have been converted to strings-serialized numbers. As such, `permissions_new`, `allow_new`, and `deny_new` have been removed
|
|
201
|
-
- The `game` field has been removed. If you need a direct replacement, you can instead reference the first element of `activities`
|
|
202
|
-
- Channel Permission Overwrite `type`s are now numbers (0 and 1) instead of strings ("role" and "member"). However due to a current technical constraint, they are string-serialized numbers in audit log `options`.
|
|
203
|
-
- `embed_enabled` and `embed_channel_id` have been removed. Use `widget_enabled` and `widget_channel_id` instead.
|
|
204
|
-
- Form body errors have been improved to include more helpful messaging on validation. [See more here](#DOCS_REFERENCE/error-messages)
|
|
205
|
-
- The `Retry-After` header value and `retry_after` body value is now based in seconds instead of milliseconds (e.g. `123` means 123 seconds)
|
|
206
|
-
- The `X-RateLimit-Precision` header is no longer respected. `X-RateLimit-Reset` and `X-RateLimit-Reset-After` are always returned at millisecond precision (e.g. `123.456` instead of `124`)
|
|
207
|
-
- Bots no longer receive [Channel Create Gateway Event](#DOCS_TOPICS_GATEWAY/channel-create) for DMs
|
|
208
|
-
- `delete-message-days` is no longer available. Use `delete_message_days`.
|
|
209
|
-
- Removed `roles`, `premium_since`, and `nick` from [Presence Update Gateway Event](#DOCS_TOPICS_GATEWAY/presence-update)
|
|
210
|
-
- Removed some [integration object](#DOCS_RESOURCES_GUILD/integration-object) fields for Discord application integrations
|
|
211
|
-
- Removed `include_applications` from [Get Guild Integrations](#DOCS_RESOURCES_GUILD/get-guild-integrations). Application integrations are always included.
|
|
212
|
-
- The following deprecated routes have been removed for better naming conventions:
|
|
213
|
-
|
|
214
|
-
Removed in favor of `/guilds/<guild_id>/widget`:
|
|
215
|
-
|
|
216
|
-
- `/guilds/<guild_id>/embed`
|
|
217
|
-
|
|
218
|
-
Removed in favor of `/guilds/<guild_id>/widget.json`:
|
|
219
|
-
|
|
220
|
-
- `/servers/<guild_id>/embed.json`
|
|
221
|
-
- `/servers/<guild_id>/widget.json`
|
|
222
|
-
- `/guilds/<guild_id>/embed.json`
|
|
223
|
-
|
|
224
|
-
Removed in favor of `/guilds/<guild_id>/widget.png`:
|
|
225
|
-
|
|
226
|
-
- `/guilds/<guild_id>/embed.png`
|
|
227
|
-
|
|
228
|
-
Removed in favor of `/channels/<channel_id>/messages/bulk-delete`:
|
|
229
|
-
|
|
230
|
-
- `/channels/<channel_id>/messages/bulk_delete/`
|
|
231
|
-
|
|
232
|
-
Removed in favor of `/invites/<code>/`:
|
|
233
|
-
|
|
234
|
-
- `/invite/<code>/`
|
|
235
|
-
|
|
236
|
-
## New Permission Fields
|
|
237
|
-
|
|
238
|
-
#### July 28, 2020
|
|
239
|
-
|
|
240
|
-
Documented `permissions_new`, `allow_new`, and `deny_new` as string-serialized permission bitfields.
|
|
241
|
-
|
|
242
|
-
## Legacy Mention Behavior Deprecation
|
|
243
|
-
|
|
244
|
-
#### May 11, 2020
|
|
245
|
-
|
|
246
|
-
The legacy mention behavior for bots is now removed, and granular control of mentions should use the [Allowed Mentions](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object) API moving forwards.
|
|
247
|
-
|
|
248
|
-
## New Properties on Guild Members Chunk Event
|
|
249
|
-
|
|
250
|
-
#### April 24, 2020
|
|
251
|
-
|
|
252
|
-
The [Guild Members Chunk](#DOCS_TOPICS_GATEWAY/guild-members-chunk) gateway event now contains two properties: `chunk_index` and `chunk_count`. These values can be used to keep track of how many events you have left to receive in response to a [Request Guild Members](#DOCS_TOPICS_GATEWAY/request-guild-members) command.
|
|
253
|
-
|
|
254
|
-
## New Allowed Mentions Object
|
|
255
|
-
|
|
256
|
-
#### March 3, 2020
|
|
257
|
-
|
|
258
|
-
We've added a way to specify mentions in a more granular form. This change also begins the start of a 60 day deprecation cycle on legacy mention behavior. Read more:
|
|
259
|
-
|
|
260
|
-
- [Allowed mentions object](#DOCS_RESOURCES_CHANNEL/allowed-mentions-object)
|
|
261
|
-
|
|
262
|
-
## New Invite Events and Reactions Endpoint
|
|
263
|
-
|
|
264
|
-
We've added a new endpoint for deleting all reactions of a specific emoji from a message, as well as some new invite and reaction gateway events. Read more:
|
|
265
|
-
|
|
266
|
-
- [Delete All Reactions for Emoji](#DOCS_RESOURCES_CHANNEL/delete-all-reactions-for-emoji)
|
|
267
|
-
- [Invite Create](#DOCS_TOPICS_GATEWAY/invite-create)
|
|
268
|
-
- [Invite Delete](#DOCS_TOPICS_GATEWAY/invite-delete)
|
|
269
|
-
- [Message Reaction Remove Emoji](#DOCS_TOPICS_GATEWAY/message-reaction-remove-emoji)
|
|
270
|
-
|
|
271
|
-
## Rich Presence Spectate Approval
|
|
272
|
-
|
|
273
|
-
#### February 26, 2020
|
|
274
|
-
|
|
275
|
-
The [Spectate](#DOCS_GAME_SDK_ACTIVITIES/onactivityspectate) functionality of Rich Presence no longer requires whitelisting or approval.
|
|
276
|
-
|
|
277
|
-
## Gateway Intents
|
|
278
|
-
|
|
279
|
-
#### February 14, 2020
|
|
280
|
-
|
|
281
|
-
We've added documentation around a brand new feature: [Gateway Intents!](#DOCS_TOPICS_GATEWAY/gateway-intents) Gateway Intents are a great way to specify which events you want to receive from our gateway. Go on, save yourself some bandwidth and CPU usage.
|
|
282
|
-
|
|
283
|
-
Using Intents will change the behavior of some existing events and commands, so please refer to:
|
|
284
|
-
|
|
285
|
-
- [Guild Create](#DOCS_TOPICS_GATEWAY/guild-create)
|
|
286
|
-
- [Request Guild Members](#DOCS_TOPICS_GATEWAY/request-guild-members)
|
|
287
|
-
- [Guild Member Add](#DOCS_TOPICS_GATEWAY/guild-member-add)
|
|
288
|
-
- [Guild Member Remove](#DOCS_TOPICS_GATEWAY/guild-member-remove)
|
|
289
|
-
- [Guild Member Update](#DOCS_TOPICS_GATEWAY/guild-member-update)
|
|
290
|
-
- [Presence Update](#DOCS_TOPICS_GATEWAY/presence-update)
|
|
291
|
-
- [List Guild Members](#DOCS_RESOURCES_GUILD/list-guild-members)
|
|
292
|
-
|
|
293
|
-
## IP Discovery Updates
|
|
294
|
-
|
|
295
|
-
#### December 6, 2019
|
|
296
|
-
|
|
297
|
-
Updated our [IP discovery message](#DOCS_TOPICS_VOICE_CONNECTIONS/ip-discovery). The old message is deprecated and will be removed in the future.
|
|
298
|
-
|
|
299
|
-
## GameSDK Version 2.5.6
|
|
300
|
-
|
|
301
|
-
#### November 27, 2019
|
|
302
|
-
|
|
303
|
-
Fixed a bug from the 2.5.5 release that caused network handshakes to fail, resulting in no networking data being sent. The networking manager and integrated lobby networking should be full operational again after updating.
|
|
304
|
-
|
|
305
|
-
## GameSDK Version 2.5.5
|
|
306
|
-
|
|
307
|
-
#### November 14, 2019
|
|
308
|
-
|
|
309
|
-
We've shipped some updates to the GameSDK, including support for Linux as well as the IL2CPP backend system for Unity. These changes also fixed a bug in the [`SetUserAchievement()`](#DOCS_GAME_SDK_ACHIEVEMENTS/setuserachievement) method.
|
|
310
|
-
|
|
311
|
-
Get the latest at the top of the [Getting Started](#DOCS_GAME_SDK_SDK_STARTER_GUIDE/step-1-get-the-thing) documentation. If you're looking for help interacting with the GameSDK or want to report a bug, join us on the [official Discord](https://discord.gg/discord-developers).
|
|
312
|
-
|
|
313
|
-
## Changes to Special Channels
|
|
314
|
-
|
|
315
|
-
#### August 22, 2019
|
|
316
|
-
|
|
317
|
-
News Channels are now changed to [Announcement Channels](#DOCS_GAME_AND_SERVER_MANAGEMENT_SPECIAL_CHANNELS/announcement-channels). Developer License owners will continue to get access to them (both existing and new). Underlying channel type (GUILD_NEWS = 5) remains the same.
|
|
318
|
-
|
|
319
|
-
## More Precise Rate Limits
|
|
320
|
-
|
|
321
|
-
#### August 12, 2019
|
|
322
|
-
|
|
323
|
-
You can now get more precise rate limit reset times, via a new request header. Check out the [rate limits](#DOCS_TOPICS_RATE_LIMITS/) documentation for more information.
|
|
324
|
-
|
|
325
|
-
## Bot Tokens for Achievements
|
|
326
|
-
|
|
327
|
-
#### July 18, 2019
|
|
328
|
-
|
|
329
|
-
You can now use Bot tokens for authorization headers against the HTTP API for [Achievements](#DOCS_GAME_SDK_ACHIEVEMENTS/the-api-way).
|
|
330
|
-
|
|
331
|
-
## Additional Team Information
|
|
332
|
-
|
|
333
|
-
#### June 19, 2019
|
|
334
|
-
|
|
335
|
-
Additional information around Teams has been added to both the API and the documentation. The [Teams](#DOCS_TOPICS_TEAMS/teams) page now includes information about the team and team member objects. Additionally, the [Get Current Application Information](#DOCS_TOPICS_OAUTH2/get-current-bot-application-information) endpoint now returns a `team` object if that application belongs to a team. That documentation has also been updated to includes fields that were missing for applications that are games sold on Discord.
|
|
336
|
-
|
|
337
|
-
## Added Info Around Nitro Boosting Experiment
|
|
338
|
-
|
|
339
|
-
#### May 29, 2019
|
|
340
|
-
|
|
341
|
-
Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](#DOCS_RESOURCES_CHANNEL/message-object-message-types), as well as some [new fields on guilds](#DOCS_RESOURCES_GUILD/guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change.
|
|
342
|
-
|
|
343
|
-
## Deprecation of Discord-RPC Rich Presence SDK
|
|
344
|
-
|
|
345
|
-
#### April 29, 2019
|
|
346
|
-
|
|
347
|
-
The [Discord-RPC](https://github.com/discord/discord-rpc) implementation of Rich Presence has been deprecated in favor of Discord's new GameSDK. If you're interested in using Rich Presence, please read our [SDK Starter Guide](#DOCS_GAME_SDK_SDK_STARTER_GUIDE/) and check out the relevant functions in the [Activity Manager](#DOCS_GAME_SDK_ACTIVITIES/).
|
|
348
|
-
|
|
349
|
-
## New Invite Object Fields
|
|
350
|
-
|
|
351
|
-
#### April 18, 2019
|
|
352
|
-
|
|
353
|
-
The [Invite Object](#DOCS_RESOURCES_INVITE/invite-object) now includes two additional fields, `target_user` and `target_user_type`.
|
|
354
|
-
|
|
355
|
-
## Ask to Join & Rich Presence SDK
|
|
356
|
-
|
|
357
|
-
#### January 14, 2019
|
|
358
|
-
|
|
359
|
-
Ask to Join no longer requires approval or whitelisting to use. You are welcome to create in-game UI, but all Ask to Join requests are also now handled by the Discord overlay.
|
|
360
|
-
|
|
361
|
-
There have also been some small additions to the Rich Presence SDK. The previously undocumented `UpdateHandlers()` function is now documented.
|
|
362
|
-
|
|
363
|
-
## Documentation: Dispatch Store Listings
|
|
364
|
-
|
|
365
|
-
#### December 11, 2018
|
|
366
|
-
|
|
367
|
-
Dispatch documentation around store listings has been removed. Store pages for the Discord Store are now managed entirely within the [Developer Portal](https://discord.com/developers).
|
|
368
|
-
|
|
369
|
-
## Enhancement: User Object
|
|
370
|
-
|
|
371
|
-
#### November 30, 2018
|
|
372
|
-
|
|
373
|
-
The [User object](#DOCS_RESOURCES_USER/user-object) now includes two new additional fields, `premium_type` and `flags`. These can be used to know the Nitro status of a user, or determine which HypeSquad house a user is in.
|
|
374
|
-
|
|
375
|
-
## Documentation Fix: List of Open DMS in Certain Payloads
|
|
376
|
-
|
|
377
|
-
#### June 19, 2018
|
|
378
|
-
|
|
379
|
-
The documentation has been updated to correctly note that the `private_channels` field in the [Ready](#DOCS_TOPICS_GATEWAY/ready) should be an empty array, as well as the response from `/users/@me/channels` for a bot user. This change has been in effect for a long time, but the documentation was not updated.
|
|
380
|
-
|
|
381
|
-
## Deprecation: RPC online member count and members list
|
|
382
|
-
|
|
383
|
-
#### June 11, 2018
|
|
384
|
-
|
|
385
|
-
We released server changes that allow guilds to represent an incomplete state of the member list in our clients, which results in inaccurate member lists and online counts over RPC. These fields are now deprecated and will now return an empty members array and an online count of 0 moving forward.
|
|
386
|
-
|
|
387
|
-
## Enhancement: New Message Properties
|
|
388
|
-
|
|
389
|
-
#### February 5, 2018
|
|
390
|
-
|
|
391
|
-
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](#DOCS_RESOURCES_CHANNEL/message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.
|
|
392
|
-
|
|
393
|
-
## Enhancement: Get Guild Emoji Endpoint
|
|
394
|
-
|
|
395
|
-
#### January 30, 2018
|
|
396
|
-
|
|
397
|
-
The [Get Guild Emoji](#DOCS_RESOURCES_EMOJI/get-guild-emoji) response now also includes a user object if the emoji was added by a user.
|
|
398
|
-
|
|
399
|
-
## Deprecation: Accept Invite Endpoint
|
|
400
|
-
|
|
401
|
-
#### January 23, 2018
|
|
402
|
-
|
|
403
|
-
The [Accept Invite](#DOCS_RESOURCES_INVITE/) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](#DOCS_RESOURCES_GUILD/add-guild-member) endpoint should be used in its place.
|
|
404
|
-
|
|
405
|
-
## Semi-Breaking Change: Very Large Bot Sharding
|
|
406
|
-
|
|
407
|
-
#### January 3, 2018
|
|
408
|
-
|
|
409
|
-
Additional sharding requirements and information for bots in over 100,000 guilds has been added. This requires a small change in numbers of shards for affected bots. See the [documentation](#DOCS_TOPICS_GATEWAY/sharding-for-very-large-bots) for more information.
|
|
410
|
-
|
|
411
|
-
## New Feature: Rich Presence
|
|
412
|
-
|
|
413
|
-
#### November 9, 2017
|
|
414
|
-
|
|
415
|
-
Rich Presence is now live and available for all developers! Rich Presence allows developers to closely integrate with Discord in a number of new, cool ways like:
|
|
416
|
-
|
|
417
|
-
- Showing more information about a user's current game in their profile
|
|
418
|
-
- Allowing users to post invitations to join their party or spectate their game in chat
|
|
419
|
-
- Displaying "Spectate" and "Ask to Join" buttons on users' profiles
|
|
420
|
-
|
|
421
|
-
For more information, check out our [Rich Presence site](https://discord.com/rich-presence). To get started on development, [read the docs](#DOCS_RICH_PRESENCE_HOW_TO/)!
|
|
422
|
-
|
|
423
|
-
## Breaking Change: API & Gateway Below v6 Discontinued
|
|
424
|
-
|
|
425
|
-
#### October 16, 2017
|
|
426
|
-
|
|
427
|
-
[API](#DOCS_REFERENCE/api-versioning) and [Gateway](#DOCS_TOPICS_GATEWAY/gateways-gateway-versions) versions below v6 are now discontinued after being previously deprecated. Version 6 is now the default API and Gateway version. Attempting to use a version below 6 will result in an error.
|
|
428
|
-
|
|
429
|
-
## New Feature: Channel Categories
|
|
430
|
-
|
|
431
|
-
#### September 20, 2017
|
|
432
|
-
|
|
433
|
-
Changes have been made throughout the documentation to reflect the addition of channel categories to Discord. These includes an additional field—`parent_id`—to the base [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object and a new [channel category example](#DOCS_RESOURCES_CHANNEL/channel-object-example-channel-category).
|
|
434
|
-
|
|
435
|
-
## New Feature: Emoji Endpoints
|
|
436
|
-
|
|
437
|
-
#### September 10, 2017
|
|
438
|
-
|
|
439
|
-
[Emoji endpoints](#DOCS_RESOURCES_EMOJI/emoji-resource) have been added to the API. Bots can now manage guild emojis to their robo-hearts' content!
|
|
440
|
-
|
|
441
|
-
## Breaking Change: Presence Activity Objects
|
|
442
|
-
|
|
443
|
-
#### August 16, 2017
|
|
444
|
-
|
|
445
|
-
The `type` field in the [activity object](#DOCS_TOPICS_GATEWAY/activity-object) for [Gateway Status Update](#DOCS_TOPICS_GATEWAY/update-presence) and [Presence Update](#DOCS_TOPICS_GATEWAY/presence-update) payloads is no longer optional when the activity object is not null.
|
|
446
|
-
|
|
447
|
-
## Breaking Change: Default Channels
|
|
448
|
-
|
|
449
|
-
#### August 3, 2017
|
|
450
|
-
|
|
451
|
-
After today, we are changing how default channels function. The "default" channel for a given user is now the channel with the highest position that their permissions allow them to see. New guilds will no longer have a default channel with the same id as the guild. Existing guilds will not have their #general channel id changed. It is possible, if permissions are set in such a way, that a user will not have a default channel in a guild.
|
|
452
|
-
|
|
453
|
-
We saw a use case in many servers where the previously-default #general channel was being repurposed as an announcement-only, non-writable channel for new members by using bots to clear the entire message history. Now, that channel can simply be deleted and re-created with the desired permissions. This change also allows dynamic default channels for users based on permissions.
|
|
454
|
-
|
|
455
|
-
We are also rolling out a change in conjunction that will allow Discord to remember your last-visited channel in a guild across sessions. Newly-joined users will be directed to the guild's default channel on first join; existing members will return to whichever channel they last visited.
|
|
456
|
-
|
|
457
|
-
## New Feature: Audit Logs
|
|
458
|
-
|
|
459
|
-
#### July 24, 2017
|
|
460
|
-
|
|
461
|
-
Audit logs are here! Well, they've been here all along, but now we've got [documentation](#DOCS_RESOURCES_AUDIT_LOG/) about them. Check it out, but remember: with great power comes great responsibility.
|
|
462
|
-
|
|
463
|
-
## Breaking Change: Version 6
|
|
464
|
-
|
|
465
|
-
#### July 19, 2017
|
|
466
|
-
|
|
467
|
-
- [Channel](#DOCS_RESOURCES_CHANNEL/channel-object) Object
|
|
468
|
-
- `is_private` removed
|
|
469
|
-
- [`type`](#DOCS_RESOURCES_CHANNEL/channel-object-channel-types) is now an integer
|
|
470
|
-
- `recipient` is now `recipients`, an array of [user](#DOCS_RESOURCES_USER/user-object) objects
|
|
471
|
-
- [Message](#DOCS_RESOURCES_CHANNEL/message-object) Object
|
|
472
|
-
- [`type`](#DOCS_RESOURCES_CHANNEL/message-object-message-types) added to support system messages
|
|
473
|
-
- [Status Update](#DOCS_TOPICS_GATEWAY/update-presence-gateway-presence-update-structure) Object
|
|
474
|
-
- `idle_since` renamed to `since`
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# Introduction
|
|
2
|
-
|
|
3
|
-
You’ve found the Discord Developer Documentation! These pages are dedicated to showing you all the ways that you can use Discord to make cool stuff. Whether you’re looking to create awesome bots for your community, empower your applications with our API, or hook us right into your game with Rich Presence or the GameSDK, Discord has something for you.
|
|
4
|
-
|
|
5
|
-
All of our [documentation is on GitHub](https://github.com/discord/discord-api-docs) and we <3 corrections and improvements!
|
|
6
|
-
|
|
7
|
-
## Bugs
|
|
8
|
-
|
|
9
|
-
If you believe you're experiencing a bug with our API or want to report incorrect documentation, open an issue on our [issue tracker](https://github.com/discord/discord-api-docs/issues).
|
|
10
|
-
|
|
11
|
-
## Bots and Apps
|
|
12
|
-
|
|
13
|
-
Bots and apps are the lifeblood of the Discord development community. They come in all shapes and sizes, from small hobby projects for your server with friends, to huge projects that live in hundreds of thousands of servers. We love seeing the unique, fun, and sometimes downright strange (in a good way) creations that come from our community.
|
|
14
|
-
|
|
15
|
-
Discord offers an open API to serve requests for both bots and OAuth2 integrations. So whether you’re making your own [`/wumpus` commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/) or looking to [`Log In With Discord`](#DOCS_TOPICS_OAUTH2/), we’ve got you covered.
|
|
16
|
-
|
|
17
|
-
So go do it! Go! Go [make an app](https://discord.com/developers/applications) and create something awesome.
|
|
18
|
-
|
|
19
|
-
## Games
|
|
20
|
-
|
|
21
|
-
We love games, and we love helping game developers. If YOU have a game that you want to supercharge with Discord, then we have just the thing for you.
|
|
22
|
-
|
|
23
|
-
#### Your Game On Discord
|
|
24
|
-
|
|
25
|
-
If you haven’t yet noticed, Discord allows you to [sell your game](https://discord.com/sell-your-game) right from Discord servers! We’ve got a whole suite of tools to help bring your game to life on Discord. Need networking? Have [networking](#DOCS_GAME_SDK_NETWORKING/)! Want a friends list? Take [relationships](#DOCS_GAME_SDK_RELATIONSHIPS/) too!
|
|
26
|
-
|
|
27
|
-
#### Rich Presence
|
|
28
|
-
|
|
29
|
-
No matter where your game lives, it should have a first-class experience in Discord. [Rich Presence](https://discord.com/rich-presence) is the way to make that a reality! We got tired of exchanging usernames, friend codes, and lobby passwords, so we created Rich Presence, an easy-to-use, easy-to-integrate way to get people playing games together that lets you:
|
|
30
|
-
|
|
31
|
-
- Display rich game data on your players’ profiles
|
|
32
|
-
- Empower them to send game invites to each other
|
|
33
|
-
- Ask to Join and Spectate their friends' games
|
|
34
|
-
- Spend more time playing together and less time setting up
|
|
35
|
-
|
|
36
|
-
It’s free, easy, and self-serve, so check out [the GameSDK Activity Manager](#DOCS_GAME_SDK_ACTIVITIES/) and get started!
|
|
37
|
-
|
|
38
|
-
## Still need some help?
|
|
39
|
-
|
|
40
|
-
Join the [Official Discord Developers server](https://discord.gg/discord-developers) for support and discussion regarding Discord's APIs.
|
|
41
|
-
|
|
42
|
-
## Go Make Cool Stuff!
|
|
43
|
-
|
|
44
|
-
We love our developers, and we plan to keep making practical tools so that YOU can keep making cool stuff. Build a bot, integrate our account system, or put us right in your game; whatever you do, do it with Discord.
|
|
45
|
-
|
|
46
|
-
We can’t wait to see what you make.
|
|
47
|
-
|
|
48
|
-
-- Discord
|