Skip to content

Commit

Permalink
undocument private channels
Browse files Browse the repository at this point in the history
  • Loading branch information
night committed Apr 7, 2021
1 parent ca5064c commit f36156d
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/topics/Gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -732,15 +732,14 @@ Sent on connection to the websocket. Defines the heartbeat interval that the cli

The ready event is dispatched when a client has completed the initial handshake with the gateway (for new sessions). The ready event can be the largest and most complex event the gateway will send, as it contains all the state required for a client to begin interacting with the rest of the platform.

`guilds` are the guilds of which your bot is a member. They start out as unavailable when you connect to the gateway. As they become available, your bot will be notified via [Guild Create](#DOCS_TOPICS_GATEWAY/guild-create) events. `private_channels` will be an empty array. As bots receive private messages, they will be notified via [Channel Create](#DOCS_TOPICS_GATEWAY/channel-create) events.
`guilds` are the guilds of which your bot is a member. They start out as unavailable when you connect to the gateway. As they become available, your bot will be notified via [Guild Create](#DOCS_TOPICS_GATEWAY/guild-create) events.

###### Ready Event Fields

| Field | Type | Description |
|------------------|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| v | integer | [gateway version](#DOCS_TOPICS_GATEWAY/gateways-gateway-versions) |
| user | [user](#DOCS_RESOURCES_USER/user-object) object | information about the user including email |
| private_channels | array | empty array |
| guilds | array of [Unavailable Guild](#DOCS_RESOURCES_GUILD/unavailable-guild-object) objects | the guilds the user is in |
| session_id | string | used for resuming connections |
| shard? | array of two integers (shard_id, num_shards) | the [shard information](#DOCS_TOPICS_GATEWAY/sharding) associated with this session, if sent when identifying |
Expand Down

0 comments on commit f36156d

Please sign in to comment.