Skip to main content

RequestGuildMembers

@discordeno/bot


Documentation / @discordeno/bot / RequestGuildMembers

Interface: RequestGuildMembers

Defined in: packages/types/dist/types/discordeno.d.ts:484

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

Properties

guildId

guildId: BigString

Defined in: packages/types/dist/types/discordeno.d.ts:486

id of the guild to get members for


limit

limit: number

Defined in: packages/types/dist/types/discordeno.d.ts:490

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: packages/types/dist/types/discordeno.d.ts:496

Nonce to identify the Guild Members Chunk response


presences?

optional presences: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:492

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


query?

optional query: string

Defined in: packages/types/dist/types/discordeno.d.ts:488

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


userIds?

optional userIds: BigString[]

Defined in: packages/types/dist/types/discordeno.d.ts:494

Used to specify which users you wish to fetch