Skip to main content
Version: 0.37.112

GatewayRequestGuildMembersDataWithQuery

https://discord.com/developers/docs/topics/gateway-events#request-guild-members

Hierarchy

Index

Properties

Properties

guild_id

guild_id: string

ID of the guild to get members for

limit

limit: number

Maximum number of members to send matching the query; a limit of 0 can be used with an empty string query to return all members

optionalnonce

nonce?: string

Nonce to identify the Guild Members Chunk response

Nonce can only be up to 32 bytes. If you send an invalid nonce it will be ignored and the reply member_chunk(s) will not have a nonce set.

See https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk

optionalpresences

presences?: boolean

Used to specify if we want the presences of the matched members

query

query: string

String that username starts with, or an empty string to return all members