kord-gateway/dev.kord.gateway.builder/RequestGuildMembersBuilder

RequestGuildMembersBuilder

class RequestGuildMembersBuilder(var guildId: Snowflake)(source)

A builder for a RequestGuildMembers command.

Parameters

guildId

The id of the guild on which to execute the command.

Constructors

RequestGuildMembersBuilder

constructor(guildId: Snowflake)

Properties

guildId

var guildId: Snowflake

limit

var limit: Int?

The maximum number of members to match against when using a query. Use 0 to request all members. Intent.GuildMembers is required when setting the query to "" and limit to 0.

nonce

var nonce: String?

A nonce to identify the GuildMembersChunkData.nonce responses.

presences

var presences: Boolean?

Whether GuildMembersChunkData.presences should be present in the response. Intent.GuildPresences is required to enable presences.

query

var query: String?

The prefix to match usernames against. Use an empty string to match against all members. Intent.GuildMembers is required when setting the query to "" and limit to 0.

userIds

var userIds: MutableSet<Snowflake>

The ids of the user to match against.

Functions

requestAllMembers

fun requestAllMembers()

Utility function that sets the required fields for requesting all members.

toRequest

fun toRequest(): RequestGuildMembers