Skip to content

Commit

Permalink
Add presences field to Guild Members Chunk (#1116)
Browse files Browse the repository at this point in the history
  • Loading branch information
@cakedan @msciotti
cakedan authored and msciotti committed Oct 22, 2019
1 parent 070621f commit 5454bdf
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/topics/Gateway.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,12 +371,13 @@ Used to request all members for a guild or a list of guilds. When initially conn

###### Guild Request Members Structure

| Field | Type | Description |
| -------- | -------------------------------- | -------------------------------------------------------------------------- |
| guild_id | snowflake or array of snowflakes | id of the guild(s) to get members for |
| query | string | string that username starts with, or an empty string to return all members |
| limit | integer | maximum number of members to send or 0 to request all members matched |
| user_ids | snowflake or array of snowflakes | used to specify which users you wish to fetch |
| Field | Type | Description | Required |
| ---------- | -------------------------------- | -------------------------------------------------------------------------- | ------------------------ |
| guild_id | snowflake or array of snowflakes | id of the guild(s) to get members for | true |
| query? | string | string that username starts with, or an empty string to return all members | one of query or user_ids |
| limit | integer | maximum number of members to send or 0 to request all members matched | true |
| presences? | boolean | used to specify if we want the presences of the matched members | false |
| user_ids? | snowflake or array of snowflakes | used to specify which users you wish to fetch | one of query or user_ids |

###### Guild Request Members

Expand Down Expand Up @@ -638,11 +639,12 @@ Sent in response to [Guild Request Members](#DOCS_TOPICS_GATEWAY/request-guild-m

###### Guild Members Chunk Event Fields

| Field | Type | Description |
| ---------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| guild_id | snowflake | the id of the guild |
| members | array of [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) objects | set of guild members |
| not_found? | array | if passing an invalid id to `REQUEST_GUILD_MEMBERS`, it will be returned here |
| Field | Type | Description |
| ---------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| guild_id | snowflake | the id of the guild |
| members | array of [guild member](#DOCS_RESOURCES_GUILD/guild-member-object) objects | set of guild members |
| not_found? | array | if passing an invalid id to `REQUEST_GUILD_MEMBERS`, it will be returned here |
| presences? | array of [presence](#DOCS_TOPICS_GATEWAY/presence) objects | if passing true to `REQUEST_GUILD_MEMBERS`, presences of the returned members will be here |

#### Guild Role Create

Expand Down

0 comments on commit 5454bdf

Please sign in to comment.