Skip to main content
Module

x/discord_api_types/v8.ts>GatewayRequestGuildMembersData

Up to date Discord API Typings, versioned by the API version
discordjs/discord-api-types
Go to Latest
interface GatewayRequestGuildMembersData
Deprecated
Deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

import { type GatewayRequestGuildMembersData } from "https://deno.land/x/discord_api_types@0.37.11/v8.ts";

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

Properties

guild_id: Snowflake

ID of the guild to get members for

optional
query: string

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

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

optional
presences: boolean

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

optional
user_ids: Snowflake | Snowflake[]

Used to specify which users you wish to fetch

optional
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#guild-members-chunk