Package net.dv8tion.jda.api.utils.cache

Enum CacheFlag

java.lang.Object

java.lang.Enum<CacheFlag>

net.dv8tion.jda.api.utils.cache.CacheFlag

All Implemented Interfaces:

Serializable, Comparable<CacheFlag>

public enum CacheFlag
extends Enum<CacheFlag>

Flags used to enable cache services for JDA.
Check the flag descriptions to see which intents are required to use them.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVITY	Enables cache for Member.getActivities()
CLIENT_STATUS	Enables cache for Member.getOnlineStatus(ClientType)
EMOJI	Enables cache for Guild.getEmojiCache()
FORUM_TAGS	Enables cache for IPostContainer.getAvailableTagCache() and ThreadChannel.getAppliedTags()
MEMBER_OVERRIDES	Enables cache for IPermissionContainer.getMemberPermissionOverrides()
ONLINE_STATUS	Enables cache for Member.getOnlineStatus() This is enabled implicitly by ACTIVITY and CLIENT_STATUS.
ROLE_TAGS	Enables cache for Role.getTags()
SCHEDULED_EVENTS	Enables cache for Guild.getScheduledEventCache()
STICKER	Enables cache for Guild.getStickerCache()
VOICE_STATE	Enables cache for Member.getVoiceState() This will always be cached for self member.

Method Summary

Modifier and Type	Method	Description
static EnumSet<CacheFlag>	getPrivileged()	Collects all cache flags that require privileged intents
GatewayIntent	getRequiredIntent()	The required GatewayIntent for this cache flag.
boolean	isPresence()	Whether this cache flag is for presence information of a member.
static CacheFlag	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CacheFlag[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACTIVITY

public static final CacheFlag ACTIVITY

Enables cache for Member.getActivities()

Requires GUILD_PRESENCES intent to be enabled.

VOICE_STATE

public static final CacheFlag VOICE_STATE

Enables cache for Member.getVoiceState()
This will always be cached for self member.

Requires GUILD_VOICE_STATES intent to be enabled.

EMOJI

public static final CacheFlag EMOJI

Enables cache for Guild.getEmojiCache()

Requires GUILD_EMOJIS_AND_STICKERS intent to be enabled.

STICKER

public static final CacheFlag STICKER

Enables cache for Guild.getStickerCache()

Requires GUILD_EMOJIS_AND_STICKERS intent to be enabled.

CLIENT_STATUS

public static final CacheFlag CLIENT_STATUS

Enables cache for Member.getOnlineStatus(ClientType)

Requires GUILD_PRESENCES intent to be enabled.

MEMBER_OVERRIDES

public static final CacheFlag MEMBER_OVERRIDES

Enables cache for IPermissionContainer.getMemberPermissionOverrides()

ROLE_TAGS

public static final CacheFlag ROLE_TAGS

Enables cache for Role.getTags()

FORUM_TAGS

public static final CacheFlag FORUM_TAGS

Enables cache for IPostContainer.getAvailableTagCache() and ThreadChannel.getAppliedTags()

ONLINE_STATUS

public static final CacheFlag ONLINE_STATUS

Enables cache for Member.getOnlineStatus()
This is enabled implicitly by ACTIVITY and CLIENT_STATUS.

Requires GUILD_PRESENCES intent to be enabled.

Since:

4.3.0

SCHEDULED_EVENTS

public static final CacheFlag SCHEDULED_EVENTS

Enables cache for Guild.getScheduledEventCache()

Requires SCHEDULED_EVENTS intent to be enabled.

Method Details

values

public static CacheFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheFlag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRequiredIntent

@Nullable
public GatewayIntent getRequiredIntent()

The required GatewayIntent for this cache flag.

Returns:

The required intent, or null if no intents are required.

isPresence

public boolean isPresence()

Whether this cache flag is for presence information of a member.

Returns:

True, if this is for presences

getPrivileged

@Nonnull
public static EnumSet<CacheFlag> getPrivileged()

Collects all cache flags that require privileged intents

Returns:

EnumSet of the cache flags that require the privileged intents