Skip to main content

RequestGuildMembers

@discordeno/botDocs


Documentation / @discordeno/bot / RequestGuildMembers

Interface: RequestGuildMembers

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

Properties

guildId

guildId: BigString

id of the guild to get members for

Defined in

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


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

Defined in

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


nonce?

optional nonce: string

Nonce to identify the Guild Members Chunk response

Defined in

packages/types/dist/types/discordeno.d.ts:496


presences?

optional presences: boolean

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

Defined in

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


query?

optional query: string

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

Defined in

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


userIds?

optional userIds: BigString[]

Used to specify which users you wish to fetch

Defined in

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