Package discord4j.core.shard

Interface MemberRequestFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MemberRequestFilter

A filter to customize the guild member request strategy. Applied on each GUILD_CREATE returning a potentially delayed Mono that, if containing true, guild members should be requested.

The following built-in factories exist:

• all() to use a filter requesting ALL members on startup
• none() to disable this feature
• withLargeGuilds() to only request from large guilds (default)
• withGuilds(Snowflake...) to request from specific guilds

Field Summary

Fields

Modifier and Type	Field	Description
static final MemberRequestFilter	DEFAULT	Request members from all large guilds.

Method Summary

Modifier and Type	Method	Description
static MemberRequestFilter	all()	Request members from all guilds.
Mono<Boolean>	apply(discord4j.discordjson.json.GuildCreateData guildCreateData)	Obtain a Mono of Boolean for the given GuildCreateData.
default MemberRequestFilter	as(Function<Mono<Boolean>,Mono<Boolean>> transformer)	Transform this current MemberRequestFilter by applying the given Function to derive a new Mono of boolean.
static MemberRequestFilter	none()	Do not request guild members.
static MemberRequestFilter	withGuilds(Snowflake... guildIds)	Request guild members for the given guild Snowflake IDs.
static MemberRequestFilter	withLargeGuilds()	Request members from large guilds.

Field Details

DEFAULT

static final MemberRequestFilter DEFAULT

Request members from all large guilds.

Method Details

all

static MemberRequestFilter all()

Request members from all guilds.

Returns:

a MemberRequestFilter requesting members from all guilds

none

static MemberRequestFilter none()

Do not request guild members.

Returns:

a MemberRequestFilter not requesting any member

withLargeGuilds

static MemberRequestFilter withLargeGuilds()

Request members from large guilds.

Returns:

a MemberRequestFilter requesting members from large guilds

withGuilds

static MemberRequestFilter withGuilds(Snowflake... guildIds)

Request guild members for the given guild Snowflake IDs.

Returns:

a MemberRequestFilter requesting members from the given guilds

apply

Mono<Boolean> apply(discord4j.discordjson.json.GuildCreateData guildCreateData)

Obtain a Mono of Boolean for the given GuildCreateData. If the resulting sequence contains true, then members will be requested through the Gateway for this guild.

Parameters:

guildCreateData - the guild triggering this filter

Returns:

a Mono indicating if a guild should have their members requested

as

default MemberRequestFilter as(Function<Mono<Boolean>,Mono<Boolean>> transformer)

Transform this current MemberRequestFilter by applying the given Function to derive a new Mono of boolean.

Parameters:

transformer - the function to transform this MemberRequestFilter

Returns:

a transformed MemberRequestFilter