Package discord4j.common.store.api

Enum Class StoreFlag

java.lang.Object

java.lang.Enum<StoreFlag>

discord4j.common.store.api.StoreFlag

All Implemented Interfaces:

Serializable, Comparable<StoreFlag>, Constable

public enum StoreFlag
extends Enum<StoreFlag>

Flag for signaling which store actions will be enabled or disabled.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL	Flag affecting operations related to channels.
EMOJI	Flag affecting operations related to guild emojis.
GUILD	Flag affecting operations related to guilds.
MEMBER	Flag affecting operations related to guild members.
MESSAGE	Flag affecting operations related to messages.
PRESENCE	Flag affecting operations related to presences.
ROLE	Flag affecting operations related to guild roles.
SCHEDULED_EVENT	Flag affecting operations related to guild scheduled events.
STAGE_INSTANCE	Flag affecting operations related to stage instances.
STICKER	Flag affecting operations related to guild stickers.
THREAD	Flag affecting operations related to threads.
USER	Flag affecting operations related to users.
VOICE_STATE	Flag affecting operations related to voice states.

Method Summary

Modifier and Type	Method	Description
static StoreFlag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StoreFlag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHANNEL

public static final StoreFlag CHANNEL

Flag affecting operations related to channels.

Updates:

• onChannelCreate
• onChannelDelete
• onChannelUpdate

Queries:

• countChannels
• countChannelsInGuild
• getChannels
• getChannelsInGuild
• getChannelById

EMOJI

public static final StoreFlag EMOJI

Flag affecting operations related to guild emojis.

Updates:

• onGuildEmojisUpdate

Queries:

• countEmojis
• countEmojisInGuild
• getEmojis
• getEmojisInGuild
• getEmojiById

GUILD

public static final StoreFlag GUILD

Flag affecting operations related to guilds.

Updates:

• onGuildCreate
• onGuildDelete
• onGuildUpdate

Queries:

• countGuilds
• getGuilds
• getGuildById

MEMBER

public static final StoreFlag MEMBER

Flag affecting operations related to guild members.

Updates:

• onGuildMemberAdd
• onGuildMemberRemove
• onGuildMembersChunk
• onGuildMemberUpdate
• onGuildMembersCompletion

Queries:

• countMembers
• countMembersInGuild
• countExactMembersInGuild
• getMembers
• getMembersInGuild
• getExactMembersInGuild
• getMemberById

MESSAGE

public static final StoreFlag MESSAGE

Flag affecting operations related to messages.

Updates:

• onMessageCreate
• onMessageDelete
• onMessageDeleteBulk
• onMessageReactionAdd
• onMessageReactionRemove
• onMessageReactionRemoveAll
• onMessageReactionRemoveEmoji
• onMessageUpdate

Queries:

• countMessages
• countMessagesInChannel
• getMessages
• getMessagesInChannel
• getMessageById

PRESENCE

public static final StoreFlag PRESENCE

Flag affecting operations related to presences.

Updates:

• onPresenceUpdate

Queries:

• countPresences
• countPresencesInGuild
• getPresences
• getPresencesInGuild
• getPresenceById

ROLE

public static final StoreFlag ROLE

Flag affecting operations related to guild roles.

Updates:

• onGuildRoleCreate
• onGuildRoleDelete
• onGuildRoleUpdate

Queries:

• countRoles
• countRolesInGuild
• getRoles
• getRolesInGuild
• getRoleById

USER

public static final StoreFlag USER

Flag affecting operations related to users.

Updates:

• onUserUpdate

Queries:

• countUsers
• getUsers
• getUserById

VOICE_STATE

public static final StoreFlag VOICE_STATE

Flag affecting operations related to voice states.

Updates:

• onVoiceStateUpdateDispatch

Queries:

• countVoiceStates
• countVoiceStatesInGuild
• countVoiceStatesInChannel
• getVoiceStates
• getVoiceStatesInChannel
• getVoiceStatesInGuild
• getVoiceStateById

STICKER

public static final StoreFlag STICKER

Flag affecting operations related to guild stickers.

Updates:

• onGuildStickersUpdate

Queries:

• countStickers
• countStickersInGuild
• getStickers
• getStickersInGuild
• getStickerById

SCHEDULED_EVENT

public static final StoreFlag SCHEDULED_EVENT

Flag affecting operations related to guild scheduled events.

Updates:

• onGuildScheduledEventCreate
• onGuildScheduledEventUpdate
• onGuildScheduledEventDelete
• onGuildScheduledEventUserAdd
• onGuildScheduledEventUserRemove

Queries:

• getScheduledEventsInGuild
• getScheduledEventById
• getScheduledEventUsersInEvent

THREAD

public static final StoreFlag THREAD

Flag affecting operations related to threads. Updates:

• onThreadCreate
• onThreadUpdate
• onThreadDelete
• onThreadListSync
• onThreadMemberUpdate
• onThreadMembersUpdate

Queries:

• getThreadMemberById
• getMembersInThread

Since:

3.3.0

STAGE_INSTANCE

public static final StoreFlag STAGE_INSTANCE

Flag affecting operations related to stage instances. Updates:

• onStageInstanceCreate
• onStageInstanceUpdate
• onStageInstanceDelete

Queries:

• getStageInstanceByChannelId

Since:

3.3.0

Method Details

values

public static StoreFlag[] values()

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

Returns:

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

valueOf

public static StoreFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null