java.lang.Object
- java.lang.Enum<GatewayIntent>
- - net.dv8tion.jda.api.requests.GatewayIntent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GatewayIntent>
```
public enum GatewayIntent
extends java.lang.Enum<GatewayIntent>
```
Flags which enable or disable specific events from the discord gateway.
The way to use these is very simple. Go through each intent in the following list and decide whether your bot will need these events or not.
1. GUILD_MEMBERS - This is a privileged gateway intent that is used to update user information and join/leaves (including kicks). This is required to cache all members of a guild (including chunking)
2. GUILD_BANS - This will only track guild bans and unbans
3. GUILD_EMOJIS - This will only track guild emote create/modify/delete. Most bots don't need this since they just use the emote id anyway.
4. GUILD_WEBHOOKS - This will only track guild webhook create/update/delete. Most bots don't need this since related events don't contain any useful information about webhook changes.
5. GUILD_INVITES - This will only track invite create/delete. Most bots don't make use of invites since they are added through OAuth2 authorization by administrators.
6. GUILD_VOICE_STATES - Required to properly get information of members in voice channels and cache them. You cannot connect to a voice channel without this intent.
7. GUILD_PRESENCES - This is a privileged gateway intent this is only used to track activity and online-status of a user.
8. GUILD_MESSAGES - This is used to receive incoming messages in guilds (servers), most bots will need this for commands.
9. GUILD_MESSAGE_REACTIONS - This is used to track reactions on messages in guilds (servers). Can be useful to make a paginated embed or reaction role management.
10. GUILD_MESSAGE_TYPING - This is used to track when a user starts typing in guilds (servers). Almost no bot will have a use for this.
11. DIRECT_MESSAGES - This is used to receive incoming messages in private channels (DMs). You can still send private messages without this intent.
12. DIRECT_MESSAGE_REACTIONS - This is used to track reactions on messages in private channels (DMs).
13. DIRECT_MESSAGE_TYPING - This is used to track when a user starts typing in private channels (DMs). Almost no bot will have a use for this.
If an intent is not specifically mentioned to be privileged, it is not required to be on the whitelist to use if (and its related events). To get whitelisted you either need to contact discord support (for bots in more than 100 guilds) or enable it in the developer dashboard of your application.
You must use ChunkingFilter.NONE if GUILD_MEMBERS is disabled. To enable chunking the discord api requires the privileged GUILD_MEMBERS intent.
See Also:

JDABuilder.disableIntents(GatewayIntent, GatewayIntent...), JDABuilder.enableIntents(GatewayIntent, GatewayIntent...), DefaultShardManagerBuilder.disableIntents(GatewayIntent, GatewayIntent...), DefaultShardManagerBuilder.enableIntents(GatewayIntent, GatewayIntent...)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DIRECT_MESSAGE_REACTIONS`	Message reaction events in private channels.
`DIRECT_MESSAGE_TYPING`	Typing events in private channels.
`DIRECT_MESSAGES`	Message events in private channels.
`GUILD_BANS`	Ban events.
`GUILD_EMOJIS`	Emote add/update/delete events.
`GUILD_INVITES`	Invite events.
`GUILD_MEMBERS`	PRIVILEGED INTENT Events which inform us about member update/leave/join of a guild.
`GUILD_MESSAGE_REACTIONS`	Message reaction events in guilds.
`GUILD_MESSAGE_TYPING`	Typing start events in guilds.
`GUILD_MESSAGES`	Message events from text channels in guilds.
`GUILD_PRESENCES`	PRIVILEGED INTENT Presence updates.
`GUILD_VOICE_STATES`	Voice state events.
`GUILD_WEBHOOKS`	Webhook events.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALL_INTENTS`	Bitmask with all intents enabled.
`static int`	`DEFAULT`	All intents with some disabled: GUILD_MEMBERS (because its privileged) GUILD_PRESENCES (because its privileged) GUILD_WEBHOOKS because its not useful for most bots GUILD_MESSAGE_TYPING because its not useful for most bots DIRECT_MESSAGE_TYPING because its not useful for most bots To use these intents you have to pass no other intents to `createLight(token)` or `createDefault(token)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static java.util.EnumSet<GatewayIntent>`	`from(java.util.Collection<java.lang.Class<? extends GenericEvent>> events, java.util.Collection<CacheFlag> flags)`	Parse the required GatewayIntents from the provided `Event Types` and `CacheFlags`.
`static java.util.EnumSet<GatewayIntent>`	`fromCacheFlags(java.util.Collection<CacheFlag> flags)`	Parse the required GatewayIntents from the provided `CacheFlags`.
`static java.util.EnumSet<GatewayIntent>`	`fromCacheFlags(CacheFlag flag, CacheFlag... other)`	Parse the required GatewayIntents from the provided `CacheFlags`.
`static java.util.EnumSet<GatewayIntent>`	`fromEvents(java.lang.Class<? extends GenericEvent>... events)`	Parse the required GatewayIntents from the provided `Event Types`.
`static java.util.EnumSet<GatewayIntent>`	`fromEvents(java.util.Collection<java.lang.Class<? extends GenericEvent>> events)`	Parse the required GatewayIntents from the provided `Event Types`.
`static java.util.EnumSet<GatewayIntent>`	`getIntents(int raw)`	Converts a bitmask into an `EnumSet` of enum values.
`int`	`getOffset()`	The offset of the intent flag within a bitmask This means `getRawValue() == 1 << getOffset()`
`static int`	`getRaw(java.util.Collection<GatewayIntent> set)`	Converts the given intents to a bitmask
`static int`	`getRaw(GatewayIntent intent, GatewayIntent... set)`	Converts the given intents to a bitmask
`int`	`getRawValue()`	The raw bitmask value for this intent
`static GatewayIntent`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static GatewayIntent[]`	`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 Detail
  - GUILD_MEMBERS
```
public static final GatewayIntent GUILD_MEMBERS
```
    PRIVILEGED INTENT Events which inform us about member update/leave/join of a guild.
    This is required to chunk all members of a guild. Without this enabled you have to use ChunkingFilter.NONE!
    This will also update user information such as name/avatar.
  - GUILD_BANS
```
public static final GatewayIntent GUILD_BANS
```
    Ban events.
  - GUILD_EMOJIS
```
public static final GatewayIntent GUILD_EMOJIS
```
    Emote add/update/delete events.
  - GUILD_WEBHOOKS
```
public static final GatewayIntent GUILD_WEBHOOKS
```
    Webhook events.
  - GUILD_INVITES
```
public static final GatewayIntent GUILD_INVITES
```
    Invite events.
  - GUILD_VOICE_STATES
```
public static final GatewayIntent GUILD_VOICE_STATES
```
    Voice state events. This is used to determine which members are connected to a voice channel.
  - GUILD_PRESENCES
```
public static final GatewayIntent GUILD_PRESENCES
```
    PRIVILEGED INTENT Presence updates. This is used to lazy load members and update user properties such as name/avatar.
    This is a very heavy intent! Presence updates are 99% of traffic the bot will receive. To get user update events you should consider using GUILD_MEMBERS instead.
    This intent is primarily used to track Member.getOnlineStatus() and Member.getActivities().
  - GUILD_MESSAGES
```
public static final GatewayIntent GUILD_MESSAGES
```
    Message events from text channels in guilds.
  - GUILD_MESSAGE_REACTIONS
```
public static final GatewayIntent GUILD_MESSAGE_REACTIONS
```
    Message reaction events in guilds.
  - GUILD_MESSAGE_TYPING
```
public static final GatewayIntent GUILD_MESSAGE_TYPING
```
    Typing start events in guilds.
  - DIRECT_MESSAGES
```
public static final GatewayIntent DIRECT_MESSAGES
```
    Message events in private channels.
  - DIRECT_MESSAGE_REACTIONS
```
public static final GatewayIntent DIRECT_MESSAGE_REACTIONS
```
    Message reaction events in private channels.
  - DIRECT_MESSAGE_TYPING
```
public static final GatewayIntent DIRECT_MESSAGE_TYPING
```
    Typing events in private channels.
- Field Detail
  - ALL_INTENTS
```
public static final int ALL_INTENTS
```
    Bitmask with all intents enabled.
    To use all intents in your own code you should use EnumSet.allOf(GatewayIntent.class) instead. This value only represents the raw bitmask used in JDA.
    You can use EnumSet.noneOf(GatewayIntent.class) to achieve the opposite.
  - DEFAULT
```
public static final int DEFAULT
```
    All intents with some disabled:
    
    GUILD_MEMBERS (because its privileged)
    
    GUILD_PRESENCES (because its privileged)
    
    GUILD_WEBHOOKS because its not useful for most bots
    
    GUILD_MESSAGE_TYPING because its not useful for most bots
    
    DIRECT_MESSAGE_TYPING because its not useful for most bots
    
    To use these intents you have to pass no other intents to createLight(token) or createDefault(token). You can further configure intents by using enableIntents(intents) and disableIntents(intents).
- Method Detail
  - values
```
public static GatewayIntent[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (GatewayIntent c : GatewayIntent.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GatewayIntent valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getRawValue
```
public int getRawValue()
```
    The raw bitmask value for this intent
    
    Returns:
    
    The raw bitmask value
  - getOffset
```
public int getOffset()
```
    The offset of the intent flag within a bitmask
    This means getRawValue() == 1 << getOffset()
    
    Returns:
    
    The offset
  - getIntents
```
@Nonnull
public static java.util.EnumSet<GatewayIntent> getIntents(int raw)
```
    Converts a bitmask into an EnumSet of enum values.
    
    Parameters:
    
    raw - The raw bitmask
    
    Returns:
    
    EnumSet of intents
  - getRaw
```
public static int getRaw(@Nonnull
                         java.util.Collection<GatewayIntent> set)
```
    Converts the given intents to a bitmask
    
    Parameters:
    
    set - The Collection of intents
    
    Returns:
    
    The bitmask for this set of intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If null is provided
  - getRaw
```
public static int getRaw(@Nonnull
                         GatewayIntent intent,
                         @Nonnull
                         GatewayIntent... set)
```
    Converts the given intents to a bitmask
    
    Parameters:
    
    intent - The first intent
    
    set - The remaining intents
    
    Returns:
    
    The bitmask for this set of intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If null is provided
  - fromCacheFlags
```
@Nonnull
public static java.util.EnumSet<GatewayIntent> fromCacheFlags(@Nonnull
                                                              CacheFlag flag,
                                                              @Nonnull
                                                              CacheFlag... other)
```
    Parse the required GatewayIntents from the provided CacheFlags.
    This creates an EnumSet based on CacheFlag.getRequiredIntent().
    
    Parameters:
    
    flag - The first cache flag
    
    other - Any additional cache flags
    
    Returns:
    
    EnumSet for the required intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If provided with null
  - fromCacheFlags
```
@Nonnull
public static java.util.EnumSet<GatewayIntent> fromCacheFlags(@Nonnull
                                                              java.util.Collection<CacheFlag> flags)
```
    Parse the required GatewayIntents from the provided CacheFlags.
    This creates an EnumSet based on CacheFlag.getRequiredIntent().
    
    Parameters:
    
    flags - The cache flags
    
    Returns:
    
    EnumSet for the required intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If provided with null
  - fromEvents
```
@Nonnull
@SafeVarargs
public static java.util.EnumSet<GatewayIntent> fromEvents(@Nonnull
                                                          java.lang.Class<? extends GenericEvent>... events)
```
    Parse the required GatewayIntents from the provided Event Types.
    
    Parameters:
    
    events - The event types
    
    Returns:
    
    EnumSet for the required intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If provided with null
  - fromEvents
```
@Nonnull
public static java.util.EnumSet<GatewayIntent> fromEvents(@Nonnull
                                                          java.util.Collection<java.lang.Class<? extends GenericEvent>> events)
```
    Parse the required GatewayIntents from the provided Event Types.
    
    Parameters:
    
    events - The event types
    
    Returns:
    
    EnumSet for the required intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If provided with null
  - from
```
@Nonnull
public static java.util.EnumSet<GatewayIntent> from(@Nonnull
                                                    java.util.Collection<java.lang.Class<? extends GenericEvent>> events,
                                                    @Nonnull
                                                    java.util.Collection<CacheFlag> flags)
```
    Parse the required GatewayIntents from the provided Event Types and CacheFlags.
    
    Parameters:
    
    events - The event types
    
    flags - The cache flags
    
    Returns:
    
    EnumSet for the required intents
    
    Throws:
    
    java.lang.IllegalArgumentException - If provided with null

Enum GatewayIntent

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GUILD_MEMBERS

GUILD_BANS

GUILD_EMOJIS

GUILD_WEBHOOKS

GUILD_INVITES

GUILD_VOICE_STATES

GUILD_PRESENCES

GUILD_MESSAGES

GUILD_MESSAGE_REACTIONS

GUILD_MESSAGE_TYPING

DIRECT_MESSAGES

DIRECT_MESSAGE_REACTIONS

DIRECT_MESSAGE_TYPING

Field Detail

ALL_INTENTS

DEFAULT

Method Detail

values

valueOf

getRawValue

getOffset

getIntents

getRaw

getRaw

fromCacheFlags

fromCacheFlags

fromEvents

fromEvents

from