Package com.mewna.catnip.shard

Enum Class GatewayIntent

java.lang.Object

java.lang.Enum<GatewayIntent>

com.mewna.catnip.shard.GatewayIntent

All Implemented Interfaces:

Serializable, Comparable<GatewayIntent>, Constable

public enum GatewayIntent
extends Enum<GatewayIntent>

A list of "gateway intents" that tell Discord which events you do and don't want to receive. Events are grouped into intents, which can be thought of as high-level categories of events. Some intents can be privileged. Privileged intents can only be set by bots in <=100 guilds; bots will be prevented from joining more guilds when attempting to use privileged intents unless they are specifically whitelisted by Discord.

Since:

1/16/20.

Author:

amy

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
DIRECT_MESSAGE_REACTIONS	DiscordEvent.MESSAGE_REACTION_ADD DiscordEvent.MESSAGE_REACTION_REMOVE DiscordEvent.MESSAGE_REACTION_REMOVE_ALL DiscordEvent.MESSAGE_REACTION_REMOVE_EMOJI
DIRECT_MESSAGE_TYPING	DiscordEvent.TYPING_START Note that this toggles TYPING_START events in direct messages only.
DIRECT_MESSAGES	DiscordEvent.MESSAGE_CREATE DiscordEvent.MESSAGE_UPDATE DiscordEvent.MESSAGE_DELETE DiscordEvent.CHANNEL_PINS_UPDATE
GUILD_BANS	DiscordEvent.GUILD_BAN_ADD DiscordEvent.GUILD_BAN_REMOVE
GUILD_EMOJIS	DiscordEvent.GUILD_EMOJIS_UPDATE
GUILD_INTEGRATIONS	DiscordEvent.GUILD_INTEGRATIONS_UPDATE
GUILD_INVITES	INVITE_CREATE INVITE_DELETE Note that these events are currently undocumented!
GUILD_MEMBERS	DiscordEvent.GUILD_MEMBER_ADD DiscordEvent.GUILD_MEMBER_UPDATE DiscordEvent.GUILD_MEMBER_REMOVE
GUILD_MESSAGE_REACTIONS	DiscordEvent.MESSAGE_REACTION_ADD DiscordEvent.MESSAGE_REACTION_REMOVE DiscordEvent.MESSAGE_REACTION_REMOVE_ALL DiscordEvent.MESSAGE_REACTION_REMOVE_EMOJI
GUILD_MESSAGE_TYPING	DiscordEvent.TYPING_START Note that this toggles TYPING_START events in guilds only.
GUILD_MESSAGES	DiscordEvent.MESSAGE_CREATE DiscordEvent.MESSAGE_UPDATE DiscordEvent.MESSAGE_DELETE DiscordEvent.MESSAGE_DELETE_BULK
GUILD_PRESENCES	DiscordEvent.PRESENCE_UPDATE Note that bots cannot receive presence updates in DMs. This is a privileged intent.
GUILD_VOICE_STATES	DiscordEvent.VOICE_STATE_UPDATE
GUILD_WEBHOOKS	DiscordEvent.WEBHOOKS_UPDATE
GUILDS	Encapsulates the following events: DiscordEvent.GUILD_CREATE DiscordEvent.GUILD_UPDATE DiscordEvent.GUILD_DELETE DiscordEvent.GUILD_ROLE_CREATE DiscordEvent.GUILD_ROLE_UPDATE DiscordEvent.GUILD_ROLE_DELETE DiscordEvent.CHANNEL_CREATE DiscordEvent.CHANNEL_UPDATE DiscordEvent.CHANNEL_DELETE DiscordEvent.CHANNEL_PINS_UPDATE

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALL_INTENT_EVENTS
static final Set<GatewayIntent>	ALL_INTENTS
static final Set<GatewayIntent>	UNPRIVILEGED_INTENTS

Method Summary

Modifier and Type	Method	Description
List<String>	events()
static long	from(Iterable<GatewayIntent> intents)
boolean	privileged()
int	value()
static GatewayIntent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GatewayIntent[]	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

GUILDS

public static final GatewayIntent GUILDS

Encapsulates the following events:

• DiscordEvent.GUILD_CREATE
• DiscordEvent.GUILD_UPDATE
• DiscordEvent.GUILD_DELETE
• DiscordEvent.GUILD_ROLE_CREATE
• DiscordEvent.GUILD_ROLE_UPDATE
• DiscordEvent.GUILD_ROLE_DELETE
• DiscordEvent.CHANNEL_CREATE
• DiscordEvent.CHANNEL_UPDATE
• DiscordEvent.CHANNEL_DELETE
• DiscordEvent.CHANNEL_PINS_UPDATE

GUILD_MEMBERS

public static final GatewayIntent GUILD_MEMBERS

• DiscordEvent.GUILD_MEMBER_ADD
• DiscordEvent.GUILD_MEMBER_UPDATE
• DiscordEvent.GUILD_MEMBER_REMOVE

GUILD_BANS

public static final GatewayIntent GUILD_BANS

• DiscordEvent.GUILD_BAN_ADD
• DiscordEvent.GUILD_BAN_REMOVE

GUILD_EMOJIS

public static final GatewayIntent GUILD_EMOJIS

• DiscordEvent.GUILD_EMOJIS_UPDATE

GUILD_INTEGRATIONS

public static final GatewayIntent GUILD_INTEGRATIONS

• DiscordEvent.GUILD_INTEGRATIONS_UPDATE

GUILD_WEBHOOKS

public static final GatewayIntent GUILD_WEBHOOKS

• DiscordEvent.WEBHOOKS_UPDATE

GUILD_INVITES

public static final GatewayIntent GUILD_INVITES

• INVITE_CREATE
• INVITE_DELETE

Note that these events are currently undocumented!

GUILD_VOICE_STATES

public static final GatewayIntent GUILD_VOICE_STATES

• DiscordEvent.VOICE_STATE_UPDATE

GUILD_PRESENCES

public static final GatewayIntent GUILD_PRESENCES

• DiscordEvent.PRESENCE_UPDATE

Note that bots cannot receive presence updates in DMs.
This is a privileged intent.

GUILD_MESSAGES

public static final GatewayIntent GUILD_MESSAGES

• DiscordEvent.MESSAGE_CREATE
• DiscordEvent.MESSAGE_UPDATE
• DiscordEvent.MESSAGE_DELETE
• DiscordEvent.MESSAGE_DELETE_BULK

GUILD_MESSAGE_REACTIONS

public static final GatewayIntent GUILD_MESSAGE_REACTIONS

• DiscordEvent.MESSAGE_REACTION_ADD
• DiscordEvent.MESSAGE_REACTION_REMOVE
• DiscordEvent.MESSAGE_REACTION_REMOVE_ALL
• DiscordEvent.MESSAGE_REACTION_REMOVE_EMOJI

GUILD_MESSAGE_TYPING

public static final GatewayIntent GUILD_MESSAGE_TYPING

• DiscordEvent.TYPING_START

Note that this toggles TYPING_START events in guilds only.

DIRECT_MESSAGES

public static final GatewayIntent DIRECT_MESSAGES

• DiscordEvent.MESSAGE_CREATE
• DiscordEvent.MESSAGE_UPDATE
• DiscordEvent.MESSAGE_DELETE
• DiscordEvent.CHANNEL_PINS_UPDATE

DIRECT_MESSAGE_REACTIONS

public static final GatewayIntent DIRECT_MESSAGE_REACTIONS

• DiscordEvent.MESSAGE_REACTION_ADD
• DiscordEvent.MESSAGE_REACTION_REMOVE
• DiscordEvent.MESSAGE_REACTION_REMOVE_ALL
• DiscordEvent.MESSAGE_REACTION_REMOVE_EMOJI

DIRECT_MESSAGE_TYPING

public static final GatewayIntent DIRECT_MESSAGE_TYPING

• DiscordEvent.TYPING_START

Note that this toggles TYPING_START events in direct messages only.

Field Details

ALL_INTENTS

public static final Set<GatewayIntent> ALL_INTENTS

UNPRIVILEGED_INTENTS

public static final Set<GatewayIntent> UNPRIVILEGED_INTENTS

ALL_INTENT_EVENTS

public static final Set<String> ALL_INTENT_EVENTS

Method Details

values

public static GatewayIntent[] 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 GatewayIntent 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

from

public static long from(@Nonnull
 Iterable<GatewayIntent> intents)

value

public int value()

privileged

public boolean privileged()

events

public List<String> events()