RequestGuildMembers

data class RequestGuildMembers(val guildId: Snowflake, val query: Optional<String> = Optional.Missing(), val limit: OptionalInt = OptionalInt.Missing, val presences: OptionalBoolean = OptionalBoolean.Missing, val userIds: Optional<Set<Snowflake>> = Optional.Missing(), val nonce: Optional<String> = Optional.Missing()) : Command(source)

A representation of the Discord Request Guild Members command.

When connecting to a Gateway Discord will send members up to Identify.largeThreshold, any additional members can be requested via this command. Sending this command will result in a variable amount of GuildMembersChunk events being send until all requested members have been returned.

While usage of this command isn't strictly limited to privileged intents, certain combinations are:

Other notable behavior:

Parameters

guildId

id of the guild on which to execute the command.

query

prefix to match usernames against. Use an empty string to match against all members.

limit

maximum number of members to match against when using a query. Use 0 to request all members.

presences

Whether GuildMembersChunkData.presences should be present in the response.

userIds

The ids of the user to match against.

nonce

A nonce to identify the GuildMembersChunkData.nonce responses.

Constructors

Link copied to clipboard
constructor(guildId: Snowflake, query: Optional<String> = Optional.Missing(), limit: OptionalInt = OptionalInt.Missing, presences: OptionalBoolean = OptionalBoolean.Missing, userIds: Optional<Set<Snowflake>> = Optional.Missing(), nonce: Optional<String> = Optional.Missing())

Types

Link copied to clipboard
object Nonce

Properties

Link copied to clipboard
@SerialName(value = "guild_id")
val guildId: Snowflake
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "user_ids")
val userIds: Optional<Set<Snowflake>>