Skip to main content

RequestGuildMembers

Documentation


Documentation / @discordeno/types / RequestGuildMembers

Interface: RequestGuildMembers

Defined in: discordeno/gateway.ts:10

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

Properties

guildId

guildId: BigString

Defined in: discordeno/gateway.ts:12

id of the guild to get members for


limit

limit: number

Defined in: discordeno/gateway.ts:16

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


nonce?

optional nonce?: string

Defined in: discordeno/gateway.ts:22

Nonce to identify the Guild Members Chunk response


presences?

optional presences?: boolean

Defined in: discordeno/gateway.ts:18

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


query?

optional query?: string

Defined in: discordeno/gateway.ts:14

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


userIds?

optional userIds?: BigString[]

Defined in: discordeno/gateway.ts:20

Used to specify which users you wish to fetch