Support gateway intents and configurable member caching

[MinnDevelopment]

Pull Request Etiquette

• I have checked the PRs for upcoming features/bug fixes.
• I have read the contributing guidelines.

Changes

• Internal code
• Library interface (affecting end-user code)
• Documentation
• Other: _____

Closes Issue: NaN

Description

With the new gateway intents we can allow users to disable specific events rather than just guild subscriptions. This supercedes setGuildSubscriptionsEnabled with setMemberCachePolicy and setDisabledIntents.

Examples

You can do quite a lot more fine-tuning with these changes especially in terms of caching of members. (I'm still trying to figure out how to do member chunking with this system properly)

Disable Member Cache

import static net.dv8tion.jda.api.utils.MemberCachePolicy.*;
void example(JDABuilder builder) {
// Only cache members in voice channels
  builder.setMemberCachePolicy(VOICE);
// Only cache members who are online
  builder.setMemberCachePolicy(ONLINE);
// Disable all user/member caching
  builder.setMemberCachePolicy(NONE);
// Only cache members who are online AND in a voice channel
  builder.setMemberCachePolicy(ONLINE.and(VOICE));
// Only cache members who are online OR in a voice channel
  builder.setMemberCachyPolicy(ONLINE.or(VOICE));
// Custom
  builder.setMemberCachePolicy((member) -> member.getGuild().getIdLong() == 123L);
}

Disable or Enable Intents

Note: The discord api allows to disable GUILD_CREATE and similar events, we don't allow that and they will always be implicitly enabled.

import static net.dv8tion.jda.api.requests.GatewayInent.*;
void example(JDABuilder builder) { 
// Only listen for MESSAGE_CREATE
  builder.setEnabledIntents(GatewayIntent.GUILD_MESSAGES);
// Don't listen to GUILD_MESSAGE_TYPING
  builder.setDisabledIntents(GatewayIntent.GUILD_MESSAGE_TYPING);
// Don't listen to any events
  builder.setDisabledIntents(EnumSet.allOf(GatewayIntent.class));
}

Changes to the defaults

We are not making a breaking change here, don't worry thats for later :)
I have added a few new factory methods to JDABuilder and DefaultShardManagerBuilder which will require the bot developer to decide which gateway intents are needed for their bot.

JDABuilder.createDefault(token) now has a different default behavior which will not be a take-all-cache-all system. Instead it will default to disable chunking and caching of non-voice members. Additionally, the intents GUILD_PRESENCES and GUILD_MEMBERS will be disabled by this factory method as this is how the API will work in the future.

You can keep using the deprecated constructor to opt-out of using the limited gateway intents for the time being. However, discord will enforce this in the future.

[binaryoverload]

Hi,

Curious to know why the ChannelUpdatePermissions events have been deprecated. I can't find a reason as to why this is!

[Andre601]

Hi,

Curious to know why the ChannelUpdatePermissions events have been deprecated. I can't find a reason as to why this is!

Most likely because PermissionOverrideUpdateEvent exists, which has a getChannel() and getMember() option to get what permissions where updated in what channel (and for who).
At least that's what I understand from the XChannelUpdatePermissionsEvent

[binaryoverload]

That actually makes a lot of sense, thanks!