Package net.dv8tion.jda.api.sharding

Class DefaultShardManagerBuilder

java.lang.Object

net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder

public class DefaultShardManagerBuilder
extends Object

Used to create new instances of JDA's default ShardManager implementation.

A single DefaultShardManagerBuilder can be reused multiple times. Each call to build() creates a new ShardManager instance using the same information.

Since:

3.4.0

Author:

Aljoscha Grebe

Method Summary

Modifier and Type	Method	Description
DefaultShardManagerBuilder	addEventListenerProvider(IntFunction<Object> listenerProvider)	Adds the provided listener provider to the list of listener providers that will be used to create listeners.
DefaultShardManagerBuilder	addEventListenerProviders(Collection<IntFunction<Object>> listenerProviders)	Adds the provided listener providers to the list of listener providers that will be used to create listeners.
DefaultShardManagerBuilder	addEventListeners(Object... listeners)	Adds all provided listeners to the list of listeners that will be used to populate the DefaultShardManager object.
DefaultShardManagerBuilder	addEventListeners(Collection<Object> listeners)	Adds all provided listeners to the list of listeners that will be used to populate the DefaultShardManager object.
ShardManager	build()	Builds a new ShardManager instance and uses the provided token to start the login process.
ShardManager	build(boolean login)	Builds a new ShardManager instance.
static DefaultShardManagerBuilder	create(String token, Collection<GatewayIntent> intents)	Creates a DefaultShardManagerBuilder with the predefined token.
static DefaultShardManagerBuilder	create(String token, GatewayIntent intent, GatewayIntent... intents)	Creates a DefaultShardManagerBuilder with the predefined token.
static DefaultShardManagerBuilder	create(Collection<GatewayIntent> intents)	Creates a completely empty DefaultShardManagerBuilder with the predefined intents.
static DefaultShardManagerBuilder	create(GatewayIntent intent, GatewayIntent... intents)	Creates a completely empty DefaultShardManagerBuilder with the predefined intents.
static DefaultShardManagerBuilder	createDefault(String token)	Creates a DefaultShardManagerBuilder with recommended default settings.
static DefaultShardManagerBuilder	createDefault(String token, Collection<GatewayIntent> intents)	Creates a DefaultShardManagerBuilder with recommended default settings.
static DefaultShardManagerBuilder	createDefault(String token, GatewayIntent intent, GatewayIntent... intents)	Creates a DefaultShardManagerBuilder with recommended default settings.
static DefaultShardManagerBuilder	createLight(String token)	Creates a DefaultShardManagerBuilder with low memory profile settings.
static DefaultShardManagerBuilder	createLight(String token, Collection<GatewayIntent> intents)	Creates a DefaultShardManagerBuilder with low memory profile settings.
static DefaultShardManagerBuilder	createLight(String token, GatewayIntent intent, GatewayIntent... intents)	Creates a DefaultShardManagerBuilder with low memory profile settings.
DefaultShardManagerBuilder	disableCache(Collection<CacheFlag> flags)	Disable specific cache flags.
DefaultShardManagerBuilder	disableCache(CacheFlag flag, CacheFlag... flags)	Disable specific cache flags.
DefaultShardManagerBuilder	disableIntents(Collection<GatewayIntent> intents)	Disable the specified GatewayIntents.
DefaultShardManagerBuilder	disableIntents(GatewayIntent intent, GatewayIntent... intents)	Disable the specified GatewayIntents.
DefaultShardManagerBuilder	enableCache(Collection<CacheFlag> flags)	Enable specific cache flags.
DefaultShardManagerBuilder	enableCache(CacheFlag flag, CacheFlag... flags)	Enable specific cache flags.
DefaultShardManagerBuilder	enableIntents(Collection<GatewayIntent> intents)	Enable the specified GatewayIntents.
DefaultShardManagerBuilder	enableIntents(GatewayIntent intent, GatewayIntent... intents)	Enable the specified GatewayIntents.
DefaultShardManagerBuilder	removeEventListenerProvider(IntFunction<Object> listenerProvider)	Removes the provided listener provider from the list of listener providers.
DefaultShardManagerBuilder	removeEventListenerProviders(Collection<IntFunction<Object>> listenerProviders)	Removes all provided listener providers from the list of listener providers.
DefaultShardManagerBuilder	removeEventListeners(Object... listeners)	Removes all provided listeners from the list of listeners.
DefaultShardManagerBuilder	removeEventListeners(Collection<Object> listeners)	Removes all provided listeners from the list of listeners.
DefaultShardManagerBuilder	setActivity(Activity activity)	Sets the Activity for our session.
DefaultShardManagerBuilder	setActivityProvider(IntFunction<? extends Activity> activityProvider)	Sets the Activity for our session.
DefaultShardManagerBuilder	setAudioPool(ScheduledExecutorService pool)	Sets the ScheduledExecutorService used by the audio WebSocket connection.
DefaultShardManagerBuilder	setAudioPool(ScheduledExecutorService pool, boolean automaticShutdown)	Sets the ScheduledExecutorService used by the audio WebSocket connection.
DefaultShardManagerBuilder	setAudioPoolProvider(ThreadPoolProvider<? extends ScheduledExecutorService> provider)	Sets the ScheduledExecutorService used by the audio WebSocket connection.
DefaultShardManagerBuilder	setAudioSendFactory(IAudioSendFactory factory)	Changes the factory used to create IAudioSendSystem objects which handle the sending loop for audio packets.
DefaultShardManagerBuilder	setAutoReconnect(boolean autoReconnect)	Sets whether or not JDA should try to reconnect if a connection-error is encountered.
DefaultShardManagerBuilder	setBulkDeleteSplittingEnabled(boolean enabled)	If enabled, JDA will separate the bulk delete event into individual delete events, but this isn't as efficient as handling a single event would be.
DefaultShardManagerBuilder	setCallbackPool(ExecutorService executor)	Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks.
DefaultShardManagerBuilder	setCallbackPool(ExecutorService executor, boolean automaticShutdown)	Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks.
DefaultShardManagerBuilder	setCallbackPoolProvider(ThreadPoolProvider<? extends ExecutorService> provider)	Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks.
DefaultShardManagerBuilder	setChunkingFilter(ChunkingFilter filter)	The ChunkingFilter to filter which guilds should use member chunking.
DefaultShardManagerBuilder	setCompression(Compression compression)	Sets the compression algorithm used with the gateway connection, this will decrease the amount of used bandwidth for the running bot instance for the cost of a few extra cycles for decompression.
DefaultShardManagerBuilder	setContextEnabled(boolean enable)	Whether JDA should use a synchronized MDC context for all of its controlled threads.
DefaultShardManagerBuilder	setContextMap(IntFunction<? extends ConcurrentMap<String,String>> provider)	Sets the MDC mappings provider to use in JDA.
DefaultShardManagerBuilder	setDisabledIntents(Collection<GatewayIntent> intents)	Configures which events will be disabled.
DefaultShardManagerBuilder	setDisabledIntents(GatewayIntent intent, GatewayIntent... intents)	Configures which events will be disabled.
DefaultShardManagerBuilder	setEnabledIntents(Collection<GatewayIntent> intents)	Configures which events will be enabled.
DefaultShardManagerBuilder	setEnabledIntents(GatewayIntent intent, GatewayIntent... intents)	Configures which events will be enabled.
DefaultShardManagerBuilder	setEnableShutdownHook(boolean enable)	Enables/Disables the use of a Shutdown hook to clean up the ShardManager and it's JDA instances.
DefaultShardManagerBuilder	setEventManagerProvider(IntFunction<? extends IEventManager> eventManagerProvider)	Sets a provider to change the internally used EventManager.
DefaultShardManagerBuilder	setEventPassthrough(boolean enable)	Whether JDA should store the raw DataObject for every discord event, accessible through getRawData().
DefaultShardManagerBuilder	setEventPool(ExecutorService executor)	Sets the ExecutorService that should be used by the event proxy to schedule events.
DefaultShardManagerBuilder	setEventPool(ExecutorService executor, boolean automaticShutdown)	Sets the ExecutorService that should be used by the event proxy to schedule events.
DefaultShardManagerBuilder	setEventPoolProvider(ThreadPoolProvider<? extends ExecutorService> provider)	Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks.
DefaultShardManagerBuilder	setGatewayEncoding(GatewayEncoding encoding)	Choose which GatewayEncoding JDA should use.
DefaultShardManagerBuilder	setGatewayPool(ScheduledExecutorService pool)	Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
DefaultShardManagerBuilder	setGatewayPool(ScheduledExecutorService pool, boolean automaticShutdown)	Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
DefaultShardManagerBuilder	setGatewayPoolProvider(ThreadPoolProvider<? extends ScheduledExecutorService> provider)	Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
DefaultShardManagerBuilder	setHttpClient(okhttp3.OkHttpClient client)	Sets the OkHttpClient that will be used by JDAs requester.
DefaultShardManagerBuilder	setHttpClientBuilder(okhttp3.OkHttpClient.Builder builder)	Sets the Builder that will be used by JDA's requester.
DefaultShardManagerBuilder	setIdle(boolean idle)	Sets whether or not we should mark our sessions as afk This value can be changed at any time using DefaultShardManager#setIdleProvider(boolean).
DefaultShardManagerBuilder	setIdleProvider(IntFunction<Boolean> idleProvider)	Sets whether or not we should mark our sessions as afk This value can be changed at any time using DefaultShardManager#setIdleProvider(boolean).
DefaultShardManagerBuilder	setLargeThreshold(int threshold)	Decides the total number of members at which a guild should start to use lazy loading.
DefaultShardManagerBuilder	setMaxBufferSize(int bufferSize)	The maximum size, in bytes, of the buffer used for decompressing discord payloads.
DefaultShardManagerBuilder	setMaxReconnectDelay(int maxReconnectDelay)	Sets the maximum amount of time that JDA will back off to wait when attempting to reconnect the MainWebsocket.
DefaultShardManagerBuilder	setMemberCachePolicy(MemberCachePolicy policy)	Configure the member caching policy.
DefaultShardManagerBuilder	setRateLimitElastic(ExecutorService pool)	Sets the ExecutorService that should be used in the JDA request handler.
DefaultShardManagerBuilder	setRateLimitElastic(ExecutorService pool, boolean automaticShutdown)	Sets the ExecutorService that should be used in the JDA request handler.
DefaultShardManagerBuilder	setRateLimitElasticProvider(ThreadPoolProvider<? extends ExecutorService> provider)	Sets the ExecutorService that should be used in the JDA request handler.
DefaultShardManagerBuilder	setRateLimitScheduler(ScheduledExecutorService pool)	Sets the ScheduledExecutorService that should be used in the JDA rate-limit handler.
DefaultShardManagerBuilder	setRateLimitScheduler(ScheduledExecutorService pool, boolean automaticShutdown)	Sets the ScheduledExecutorService that should be used in the JDA rate-limit handler.
DefaultShardManagerBuilder	setRateLimitSchedulerProvider(ThreadPoolProvider<? extends ScheduledExecutorService> provider)	Sets the ScheduledExecutorService provider that should be used in the JDA rate-limit handler.
DefaultShardManagerBuilder	setRawEventsEnabled(boolean enable)	Whether JDA should fire RawGatewayEvent for every discord event.
DefaultShardManagerBuilder	setRequestTimeoutRetry(boolean retryOnTimeout)	Whether the Requester should retry when a SocketTimeoutException occurs.
DefaultShardManagerBuilder	setRestConfig(RestConfig config)	Custom RestConfig to use.
DefaultShardManagerBuilder	setRestConfigProvider(IntFunction<? extends RestConfig> provider)	Custom RestConfig to use.
DefaultShardManagerBuilder	setSessionController(SessionController controller)	Sets the SessionController for the resulting ShardManager instance.
DefaultShardManagerBuilder	setShards(int... shardIds)	Sets the list of shards the DefaultShardManager should contain.
DefaultShardManagerBuilder	setShards(int minShardId, int maxShardId)	Sets the range of shards the DefaultShardManager should contain.
DefaultShardManagerBuilder	setShards(Collection<Integer> shardIds)	Sets the range of shards the DefaultShardManager should contain.
DefaultShardManagerBuilder	setShardsTotal(int shardsTotal)	This will set the total amount of shards the DefaultShardManager should use.
DefaultShardManagerBuilder	setStatus(OnlineStatus status)	Sets the OnlineStatus our connection will display.
DefaultShardManagerBuilder	setStatusProvider(IntFunction<OnlineStatus> statusProvider)	Sets the OnlineStatus our connection will display.
DefaultShardManagerBuilder	setThreadFactory(ThreadFactory threadFactory)	Sets the ThreadFactory that will be used by the internal executor of the ShardManager.
DefaultShardManagerBuilder	setToken(String token)	Sets the token that will be used by the ShardManager instance to log in when build() is called.
DefaultShardManagerBuilder	setUseShutdownNow(boolean useShutdownNow)	Whether the ShardManager should use JDA#shutdownNow() instead of JDA#shutdown() to shutdown it's shards.
DefaultShardManagerBuilder	setVoiceDispatchInterceptor(VoiceDispatchInterceptor interceptor)	Configures a custom voice dispatch handler which handles audio connections.
DefaultShardManagerBuilder	setWebsocketFactory(WebSocketFactory factory)	Sets the WebSocketFactory that will be used by JDA's websocket client.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createDefault

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createDefault(@Nullable
 String token)

Creates a DefaultShardManagerBuilder with recommended default settings.
Note that these defaults can potentially change in the future.

• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.DEFAULT
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• setEnabledIntents(Collection) is set to GatewayIntent.DEFAULT
• This disables CacheFlag.ACTIVITY and CacheFlag.CLIENT_STATUS

Parameters:

token - The bot token to use

Returns:

The new DefaultShardManagerBuilder

See Also:

• disableIntents(GatewayIntent, GatewayIntent...)
• enableIntents(GatewayIntent, GatewayIntent...)

createDefault

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createDefault(@Nullable
 String token,
 @Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Creates a DefaultShardManagerBuilder with recommended default settings.
Note that these defaults can potentially change in the future.

• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.DEFAULT
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• This disables CacheFlag.ACTIVITY and CacheFlag.CLIENT_STATUS

You can omit intents in this method to use GatewayIntent.DEFAULT and enable additional intents with enableIntents(Collection).

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intent - The intent to enable

intents - Any other intents to enable

Returns:

The new DefaultShardManagerBuilder

Throws:

IllegalArgumentException - If provided with null intents

createDefault

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createDefault(@Nullable
 String token,
 @Nonnull
 Collection<GatewayIntent> intents)

Creates a DefaultShardManagerBuilder with recommended default settings.
Note that these defaults can potentially change in the future.

• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.DEFAULT
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• This disables CacheFlag.ACTIVITY and CacheFlag.CLIENT_STATUS

You can omit intents in this method to use GatewayIntent.DEFAULT and enable additional intents with enableIntents(Collection).

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intents - The intents to enable

Returns:

The new DefaultShardManagerBuilder

Throws:

IllegalArgumentException - If provided with null intents

createLight

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createLight(@Nullable
 String token)

Creates a DefaultShardManagerBuilder with low memory profile settings.
Note that these defaults can potentially change in the future.

• setEnabledIntents(Collection) is set to GatewayIntent.DEFAULT
• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.NONE
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• This disables all existing CacheFlags

Parameters:

token - The bot token to use

Returns:

The new DefaultShardManagerBuilder

See Also:

• disableIntents(GatewayIntent, GatewayIntent...)
• enableIntents(GatewayIntent, GatewayIntent...)

createLight

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createLight(@Nullable
 String token,
 @Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Creates a DefaultShardManagerBuilder with low memory profile settings.
Note that these defaults can potentially change in the future.

• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.NONE
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• This disables all existing CacheFlags

You can omit intents in this method to use GatewayIntent.DEFAULT and enable additional intents with enableIntents(Collection).

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intent - The first intent to use

intents - The other gateway intents to use

Returns:

The new DefaultShardManagerBuilder

createLight

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder createLight(@Nullable
 String token,
 @Nonnull
 Collection<GatewayIntent> intents)

Creates a DefaultShardManagerBuilder with low memory profile settings.
Note that these defaults can potentially change in the future.

• setMemberCachePolicy(MemberCachePolicy) is set to MemberCachePolicy.NONE
• setChunkingFilter(ChunkingFilter) is set to ChunkingFilter.NONE
• This disables all existing CacheFlags

You can omit intents in this method to use GatewayIntent.DEFAULT and enable additional intents with enableIntents(Collection).

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intents - The gateway intents to use

Returns:

The new DefaultShardManagerBuilder

create

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder create(@Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Creates a completely empty DefaultShardManagerBuilder with the predefined intents.
You can use DefaultShardManagerBuilder.create(EnumSet.noneOf(GatewayIntent.class)) to disable all intents.
If you use this, you need to set the token using setToken(String) before calling build()

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

intent - The first intent

intents - The gateway intents to use

Returns:

The DefaultShardManagerBuilder instance

Throws:

IllegalArgumentException - If the provided intents are null

See Also:

• setToken(String)

create

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder create(@Nonnull
 Collection<GatewayIntent> intents)

Creates a completely empty DefaultShardManagerBuilder with the predefined intents.
If you use this, you need to set the token using setToken(String) before calling build()

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

intents - The gateway intents to use

Returns:

The DefaultShardManagerBuilder instance

Throws:

IllegalArgumentException - If the provided intents are null

See Also:

• setToken(String)

create

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder create(@Nullable
 String token,
 @Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Creates a DefaultShardManagerBuilder with the predefined token.
You can use DefaultShardManagerBuilder.create(token, EnumSet.noneOf(GatewayIntent.class)) to disable all intents.

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intent - The first gateway intent to use

intents - Additional gateway intents to use

Returns:

The DefaultShardManagerBuilder instance

Throws:

IllegalArgumentException - If the provided intents are null

See Also:

• setToken(String)

create

@Nonnull
@CheckReturnValue
public static DefaultShardManagerBuilder create(@Nullable
 String token,
 @Nonnull
 Collection<GatewayIntent> intents)

Creates a DefaultShardManagerBuilder with the predefined token.

If you don't enable certain intents, the cache will be disabled. For instance, if the GUILD_MEMBERS intent is disabled, then members will only be cached when a voice state is available. If both GUILD_MEMBERS and GUILD_VOICE_STATES are disabled then no members will be cached.

The individual CacheFlags will also be disabled if the required intent is not enabled.

Parameters:

token - The bot token to use

intents - The gateway intents to use

Returns:

The DefaultShardManagerBuilder instance

Throws:

IllegalArgumentException - If the provided intents are null

See Also:

• setToken(String)

setGatewayEncoding

@Nonnull
public DefaultShardManagerBuilder setGatewayEncoding(@Nonnull
 GatewayEncoding encoding)

Choose which GatewayEncoding JDA should use.

Parameters:

encoding - The GatewayEncoding (default: JSON)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If null is provided

Since:

4.2.1

setRawEventsEnabled

@Nonnull
public DefaultShardManagerBuilder setRawEventsEnabled(boolean enable)

Whether JDA should fire RawGatewayEvent for every discord event.
Default: false

Parameters:

enable - True, if JDA should fire RawGatewayEvent.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.0.0

setEventPassthrough

@Nonnull
public DefaultShardManagerBuilder setEventPassthrough(boolean enable)

Whether JDA should store the raw DataObject for every discord event, accessible through getRawData().
You can expect to receive the full gateway message payload, including sequence, event name and dispatch type of the events
You can read more about payloads here and the different events here.
Warning: be aware that enabling this could consume a lot of memory if your event objects have a long lifetime.
Default: false

Parameters:

enable - True, if JDA should add the raw DataObject to every discord event.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• Event.getRawData()

setRestConfigProvider

@Nonnull
public DefaultShardManagerBuilder setRestConfigProvider(@Nonnull
 IntFunction<? extends RestConfig> provider)

Custom RestConfig to use.
This can be used to customize how rate-limits are handled and configure a custom http proxy.

Parameters:

provider - The RestConfig provider to use

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If null is provided

setRestConfig

@Nonnull
public DefaultShardManagerBuilder setRestConfig(@Nonnull
 RestConfig config)

Custom RestConfig to use.
This can be used to customize how rate-limits are handled and configure a custom http proxy.

Parameters:

config - The RestConfig to use

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If null is provided

enableCache

@Nonnull
public DefaultShardManagerBuilder enableCache(@Nonnull
 Collection<CacheFlag> flags)

Enable specific cache flags.
This will not disable any currently set cache flags.

Parameters:

flags - The CacheFlags to enable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• enableCache(CacheFlag, CacheFlag...)
• disableCache(Collection)

enableCache

@Nonnull
public DefaultShardManagerBuilder enableCache(@Nonnull
 CacheFlag flag,
 @Nonnull
 CacheFlag... flags)

Enable specific cache flags.
This will not disable any currently set cache flags.

Parameters:

flag - CacheFlag to enable

flags - Other flags to enable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• enableCache(Collection)
• disableCache(CacheFlag, CacheFlag...)

disableCache

@Nonnull
public DefaultShardManagerBuilder disableCache(@Nonnull
 Collection<CacheFlag> flags)

Disable specific cache flags.
This will not enable any currently unset cache flags.

Parameters:

flags - The CacheFlags to disable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• disableCache(CacheFlag, CacheFlag...)
• enableCache(Collection)

disableCache

@Nonnull
public DefaultShardManagerBuilder disableCache(@Nonnull
 CacheFlag flag,
 @Nonnull
 CacheFlag... flags)

Disable specific cache flags.
This will not enable any currently unset cache flags.

Parameters:

flag - CacheFlag to disable

flags - Other flags to disable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• disableCache(Collection)
• enableCache(CacheFlag, CacheFlag...)

setMemberCachePolicy

@Nonnull
public DefaultShardManagerBuilder setMemberCachePolicy(@Nullable
 MemberCachePolicy policy)

Configure the member caching policy. This will decide whether to cache a member (and its respective user).
All members are cached by default. If a guild is enabled for chunking, all members will be cached for it.

You can use this to define a custom caching policy that will greatly improve memory usage.

It is not recommended to disable GatewayIntent.GUILD_MEMBERS when using MemberCachePolicy.ALL as the members cannot be removed from cache by a leave event without this intent.

Example

 public void configureCache(DefaultShardManagerBuilder builder) {
     // Cache members who are in a voice channel
     MemberCachePolicy policy = MemberCachePolicy.VOICE;
     // Cache members who are in a voice channel
     // AND are also online
     policy = policy.and(MemberCachePolicy.ONLINE);
     // Cache members who are in a voice channel
     // AND are also online
     // OR are the owner of the guild
     policy = policy.or(MemberCachePolicy.OWNER);
     // Cache members who have a role with the name "Moderator"
     policy = (member) -> member.getRoles().stream().map(Role::getName).anyMatch("Moderator"::equals);

     builder.setMemberCachePolicy(policy);
 }
 

Parameters:

policy - The MemberCachePolicy or null to use default MemberCachePolicy.ALL

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

See Also:

• MemberCachePolicy
• setEnabledIntents(Collection)

setSessionController

@Nonnull
public DefaultShardManagerBuilder setSessionController(@Nullable
 SessionController controller)

Sets the SessionController for the resulting ShardManager instance. This can be used to sync behaviour and state between shards of a bot and should be one and the same instance on all builders for the shards.

Parameters:

controller - The SessionController to use

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• SessionControllerAdapter

setVoiceDispatchInterceptor

@Nonnull
public DefaultShardManagerBuilder setVoiceDispatchInterceptor(@Nullable
 VoiceDispatchInterceptor interceptor)

Configures a custom voice dispatch handler which handles audio connections.

Parameters:

interceptor - The new voice dispatch handler, or null to use the default

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.0.0

See Also:

• VoiceDispatchInterceptor

setContextMap

@Nonnull
public DefaultShardManagerBuilder setContextMap(@Nullable
 IntFunction<? extends ConcurrentMap<String,String>> provider)

Sets the MDC mappings provider to use in JDA.
If sharding is enabled JDA will automatically add a jda.shard context with the format [SHARD_ID / TOTAL] where SHARD_ID and TOTAL are the shard configuration. Additionally it will provide context for the id via jda.shard.id and the total via jda.shard.total.

The manager will call this with a shardId and it is recommended to provide a different context map for each shard!
This automatically switches setContextEnabled(boolean) to true if the provided function is not null!

Parameters:

provider - The provider for modifiable context maps to use in JDA, or null to reset

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• MDC Javadoc

setContextEnabled

@Nonnull
public DefaultShardManagerBuilder setContextEnabled(boolean enable)

Whether JDA should use a synchronized MDC context for all of its controlled threads.
Default: true

Parameters:

enable - True, if JDA should provide an MDC context map

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• MDC Javadoc
• setContextMap(java.util.function.IntFunction)

setCompression

@Nonnull
public DefaultShardManagerBuilder setCompression(@Nonnull
 Compression compression)

Sets the compression algorithm used with the gateway connection, this will decrease the amount of used bandwidth for the running bot instance for the cost of a few extra cycles for decompression. Compression can be entirely disabled by setting this to Compression.NONE.
Default: Compression.ZLIB

We recommend to keep this on the default unless you have issues with the decompression
This mode might become obligatory in a future version, do not rely on this switch to stay.

Parameters:

compression - The compression algorithm to use for the gateway connection

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• Official Discord Documentation - Transport Compression

addEventListeners

@Nonnull
public DefaultShardManagerBuilder addEventListeners(@Nonnull
 Object... listeners)

Adds all provided listeners to the list of listeners that will be used to populate the DefaultShardManager object.
This uses the InterfacedEventListener by default.
To switch to the AnnotatedEventManager, use setEventManagerProvider(id -> new AnnotatedEventManager()).

Note: When using the InterfacedEventListener (default), given listener(s) must be instance of EventListener!

Parameters:

listeners - The listener(s) to add to the list.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• JDA.addEventListeners(Object...)

addEventListeners

@Nonnull
public DefaultShardManagerBuilder addEventListeners(@Nonnull
 Collection<Object> listeners)

Adds all provided listeners to the list of listeners that will be used to populate the DefaultShardManager object.
This uses the InterfacedEventListener by default.
To switch to the AnnotatedEventManager, use setEventManager(id -> new AnnotatedEventManager()).

Note: When using the InterfacedEventListener (default), given listener(s) must be instance of EventListener!

Parameters:

listeners - The listener(s) to add to the list.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• JDA.addEventListeners(Object...)

removeEventListeners

@Nonnull
public DefaultShardManagerBuilder removeEventListeners(@Nonnull
 Object... listeners)

Removes all provided listeners from the list of listeners.

Parameters:

listeners - The listener(s) to remove from the list.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• JDA.removeEventListeners(Object...)

removeEventListeners

@Nonnull
public DefaultShardManagerBuilder removeEventListeners(@Nonnull
 Collection<Object> listeners)

Removes all provided listeners from the list of listeners.

Parameters:

listeners - The listener(s) to remove from the list.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• JDA.removeEventListeners(Object...)

addEventListenerProvider

@Nonnull
public DefaultShardManagerBuilder addEventListenerProvider(@Nonnull
 IntFunction<Object> listenerProvider)

Adds the provided listener provider to the list of listener providers that will be used to create listeners. On shard creation (including shard restarts) the provider will have the shard id applied and must return a listener, which will be used, along all other listeners, to populate the listeners of the JDA object of that shard.
This uses the InterfacedEventListener by default.
To switch to the AnnotatedEventManager, use setEventManager(id -> new AnnotatedEventManager()).

Note: When using the InterfacedEventListener (default), given listener(s) must be instance of EventListener!

Parameters:

listenerProvider - The listener provider to add to the list of listener providers.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

addEventListenerProviders

@Nonnull
public DefaultShardManagerBuilder addEventListenerProviders(@Nonnull
 Collection<IntFunction<Object>> listenerProviders)

Adds the provided listener providers to the list of listener providers that will be used to create listeners. On shard creation (including shard restarts) each provider will have the shard id applied and must return a listener, which will be used, along all other listeners, to populate the listeners of the JDA object of that shard.
This uses the InterfacedEventListener by default.
To switch to the AnnotatedEventManager, use setEventManager(id -> new AnnotatedEventManager()).

Note: When using the InterfacedEventListener (default), given listener(s) must be instance of EventListener!

Parameters:

listenerProviders - The listener provider to add to the list of listener providers.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

removeEventListenerProvider

@Nonnull
public DefaultShardManagerBuilder removeEventListenerProvider(@Nonnull
 IntFunction<Object> listenerProvider)

Removes the provided listener provider from the list of listener providers.

Parameters:

listenerProvider - The listener provider to remove from the list of listener providers.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

removeEventListenerProviders

@Nonnull
public DefaultShardManagerBuilder removeEventListenerProviders(@Nonnull
 Collection<IntFunction<Object>> listenerProviders)

Removes all provided listener providers from the list of listener providers.

Parameters:

listenerProviders - The listener provider(s) to remove from the list of listener providers.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setAudioSendFactory

@Nonnull
public DefaultShardManagerBuilder setAudioSendFactory(@Nullable
 IAudioSendFactory factory)

Changes the factory used to create IAudioSendSystem objects which handle the sending loop for audio packets.
By default, JDA uses DefaultSendFactory.

Parameters:

factory - The new IAudioSendFactory to be used when creating new IAudioSendSystem objects.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setAutoReconnect

@Nonnull
public DefaultShardManagerBuilder setAutoReconnect(boolean autoReconnect)

Sets whether or not JDA should try to reconnect if a connection-error is encountered.
This will use an incremental reconnect (timeouts are increased each time an attempt fails).

Default: true (enabled)

Parameters:

autoReconnect - If true - enables autoReconnect

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setBulkDeleteSplittingEnabled

@Nonnull
public DefaultShardManagerBuilder setBulkDeleteSplittingEnabled(boolean enabled)

If enabled, JDA will separate the bulk delete event into individual delete events, but this isn't as efficient as handling a single event would be. It is recommended that BulkDelete Splitting be disabled and that the developer should instead handle the MessageBulkDeleteEvent.

Default: true (enabled)

Parameters:

enabled - True - The MESSAGE_DELETE_BULK will be split into multiple individual MessageDeleteEvents.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setEnableShutdownHook

@Nonnull
public DefaultShardManagerBuilder setEnableShutdownHook(boolean enable)

Enables/Disables the use of a Shutdown hook to clean up the ShardManager and it's JDA instances.
When the Java program closes shutdown hooks are run. This is used as a last-second cleanup attempt by JDA to properly close connections.

Default: true (enabled)

Parameters:

enable - True (default) - use shutdown hook to clean up the ShardManager and it's JDA instances if the Java program is closed.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setEventManagerProvider

@Nonnull
public DefaultShardManagerBuilder setEventManagerProvider(@Nonnull
 IntFunction<? extends IEventManager> eventManagerProvider)

Sets a provider to change the internally used EventManager.
There are 2 provided Implementations:

• InterfacedEventManager which uses the Interface EventListener (tip: use the ListenerAdapter).
  This is the default EventManager.
• AnnotatedEventManager which uses the Annotation @SubscribeEvent to mark the methods that listen for events.

You can also create your own EventManager (See IEventManager).

Parameters:

eventManagerProvider - A supplier for the new IEventManager to use.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setActivity

@Nonnull
public DefaultShardManagerBuilder setActivity(@Nullable
 Activity activity)

Sets the Activity for our session.
This value can be changed at any time in the Presence from a JDA instance.

Hint: You can create an Activity object using Activity.playing(String) or Activity.streaming(String, String) Activity.streaming(String, String)}.

Parameters:

activity - An instance of Activity (null allowed)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• Presence.setActivity(net.dv8tion.jda.api.entities.Activity)

setActivityProvider

@Nonnull
public DefaultShardManagerBuilder setActivityProvider(@Nullable
 IntFunction<? extends Activity> activityProvider)

Sets the Activity for our session.
This value can be changed at any time in the Presence from a JDA instance.

Hint: You can create an Activity object using Activity.playing(String) or Activity.streaming(String, String).

Parameters:

activityProvider - An instance of Activity (null allowed)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• Presence.setActivity(net.dv8tion.jda.api.entities.Activity)

setIdle

@Nonnull
public DefaultShardManagerBuilder setIdle(boolean idle)

Sets whether or not we should mark our sessions as afk
This value can be changed at any time using DefaultShardManager#setIdleProvider(boolean).

Parameters:

idle - boolean value that will be provided with our IDENTIFY packages to mark our sessions as afk or not. (default false)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• Presence.setIdle(boolean)

setIdleProvider

@Nonnull
public DefaultShardManagerBuilder setIdleProvider(@Nullable
 IntFunction<Boolean> idleProvider)

Sets whether or not we should mark our sessions as afk
This value can be changed at any time using DefaultShardManager#setIdleProvider(boolean).

Parameters:

idleProvider - boolean value that will be provided with our IDENTIFY packages to mark our sessions as afk or not. (default false)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• Presence.setIdle(boolean)

setStatus

@Nonnull
public DefaultShardManagerBuilder setStatus(@Nullable
 OnlineStatus status)

Sets the OnlineStatus our connection will display.
This value can be changed at any time in the Presence from a JDA instance.

Parameters:

status - Not-null OnlineStatus (default online)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - if the provided OnlineStatus is null or UNKNOWN

See Also:

• Presence.setStatusProvider(OnlineStatus)

setStatusProvider

@Nonnull
public DefaultShardManagerBuilder setStatusProvider(@Nullable
 IntFunction<OnlineStatus> statusProvider)

Sets the OnlineStatus our connection will display.
This value can be changed at any time in the Presence from a JDA instance.

Parameters:

statusProvider - Not-null OnlineStatus (default online)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - if the provided OnlineStatus is null or UNKNOWN

See Also:

• Presence.setStatusProvider(OnlineStatus)

setThreadFactory

@Nonnull
public DefaultShardManagerBuilder setThreadFactory(@Nullable
 ThreadFactory threadFactory)

Sets the ThreadFactory that will be used by the internal executor of the ShardManager.

Note: This will not affect Threads created by any JDA instance.

Parameters:

threadFactory - The ThreadFactory or null to reset to the default value.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setHttpClientBuilder

@Nonnull
public DefaultShardManagerBuilder setHttpClientBuilder(@Nullable
 okhttp3.OkHttpClient.Builder builder)

Sets the Builder that will be used by JDA's requester. This can be used to set things such as connection timeout and proxy.

Parameters:

builder - The new OkHttpClient.Builder to use.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setHttpClient

@Nonnull
public DefaultShardManagerBuilder setHttpClient(@Nullable
 okhttp3.OkHttpClient client)

Sets the OkHttpClient that will be used by JDAs requester.
This can be used to set things such as connection timeout and proxy.

Parameters:

client - The new OkHttpClient to use

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitScheduler

@Nonnull
public DefaultShardManagerBuilder setRateLimitScheduler(@Nullable
 ScheduledExecutorService pool)

Sets the ScheduledExecutorService that should be used in the JDA rate-limit handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.
This will override the rate-limit pool provider set from setRateLimitSchedulerProvider(ThreadPoolProvider).
This automatically disables the automatic shutdown of the rate-limit pool, you can enable it using setRateLimiPool(executor, true)

This is used mostly by the Rate-Limiter to handle backoff delays by using scheduled executions. Besides that it is also used by planned execution for RestAction.queueAfter(long, TimeUnit) and similar methods. Requests are handed off to the elastic pool for blocking execution.

Default: Shared ScheduledThreadPoolExecutor with (2 * log(shard_total)) threads.

Parameters:

pool - The thread-pool to use for rate-limit handling

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitScheduler

@Nonnull
public DefaultShardManagerBuilder setRateLimitScheduler(@Nullable
 ScheduledExecutorService pool,
 boolean automaticShutdown)

Sets the ScheduledExecutorService that should be used in the JDA rate-limit handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.
This will override the rate-limit pool provider set from setRateLimitSchedulerProvider(ThreadPoolProvider).

This is used mostly by the Rate-Limiter to handle backoff delays by using scheduled executions. Besides that it is also used by planned execution for RestAction.queueAfter(long, TimeUnit) and similar methods. Requests are handed off to the elastic pool for blocking execution.

Default: Shared ScheduledThreadPoolExecutor with (2 * log(shard_total)) threads.

Parameters:

pool - The thread-pool to use for rate-limit handling

automaticShutdown - Whether JDA.shutdown() should automatically shutdown this pool

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitSchedulerProvider

@Nonnull
public DefaultShardManagerBuilder setRateLimitSchedulerProvider(@Nullable
 ThreadPoolProvider<? extends ScheduledExecutorService> provider)

Sets the ScheduledExecutorService provider that should be used in the JDA rate-limit handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.

This is used mostly by the Rate-Limiter to handle backoff delays by using scheduled executions. Besides that it is also used by planned execution for RestAction.queueAfter(long, TimeUnit) and similar methods. Requests are handed off to the elastic pool for blocking execution.

Default: Shared ScheduledThreadPoolExecutor with (2 * log(shard_total)) threads.

Parameters:

provider - The thread-pool provider to use for rate-limit handling

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitElastic

@Nonnull
public DefaultShardManagerBuilder setRateLimitElastic(@Nullable
 ExecutorService pool)

Sets the ExecutorService that should be used in the JDA request handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.
This will override the rate-limit pool provider set from setRateLimitElasticProvider(ThreadPoolProvider).
This automatically disables the automatic shutdown of the rate-limit elastic pool, you can enable it using setRateLimitElastic(executor, true)

This is used mostly by the Rate-Limiter to execute the blocking HTTP requests at runtime.

Default: Executors.newCachedThreadPool() shared between all shards.

Parameters:

pool - The thread-pool to use for executing http requests

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitElastic

@Nonnull
public DefaultShardManagerBuilder setRateLimitElastic(@Nullable
 ExecutorService pool,
 boolean automaticShutdown)

Sets the ExecutorService that should be used in the JDA request handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.
This will override the rate-limit pool provider set from setRateLimitElasticProvider(ThreadPoolProvider).
This automatically disables the automatic shutdown of the rate-limit elastic pool, you can enable it using setRateLimitElastic(executor, true)

This is used mostly by the Rate-Limiter to execute the blocking HTTP requests at runtime.

Default: Executors.newCachedThreadPool() shared between all shards.

Parameters:

pool - The thread-pool to use for executing http requests

automaticShutdown - Whether JDA.shutdown() should automatically shutdown this pool

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setRateLimitElasticProvider

@Nonnull
public DefaultShardManagerBuilder setRateLimitElasticProvider(@Nullable
 ThreadPoolProvider<? extends ExecutorService> provider)

Sets the ExecutorService that should be used in the JDA request handler. Changing this can drastically change the JDA behavior for RestAction execution and should be handled carefully. Only change this pool if you know what you're doing.

This is used mostly by the Rate-Limiter to execute the blocking HTTP requests at runtime.

Default: Executors.newCachedThreadPool() shared between all shards.

Parameters:

provider - The thread-pool provider to use for executing http requests

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setGatewayPool

@Nonnull
public DefaultShardManagerBuilder setGatewayPool(@Nullable
 ScheduledExecutorService pool)

Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
Only change this pool if you know what you're doing.
This will override the worker pool provider set from setGatewayPoolProvider(ThreadPoolProvider).
This automatically disables the automatic shutdown of the main-ws pools, you can enable it using setGatewayPoolProvider(pool, true)

This is used to send various forms of session updates such as:

• Voice States - (Dis-)Connecting from channels
• Presence - Changing current activity or online status
• Guild Setup - Requesting Members of newly joined guilds
• Heartbeats - Regular updates to keep the connection alive (usually once a minute)

When nothing has to be sent the pool will only be used every 500 milliseconds to check the queue for new payloads. Once a new payload is sent we switch to "rapid mode" which means more tasks will be submitted until no more payloads have to be sent.

Default: Shared ScheduledThreadPoolExecutor with (log(shard_total)) threads.

Parameters:

pool - The thread-pool to use for main WebSocket workers

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setGatewayPool

@Nonnull
public DefaultShardManagerBuilder setGatewayPool(@Nullable
 ScheduledExecutorService pool,
 boolean automaticShutdown)

Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
Only change this pool if you know what you're doing.
This will override the worker pool provider set from setGatewayPoolProvider(ThreadPoolProvider).

This is used to send various forms of session updates such as:

• Voice States - (Dis-)Connecting from channels
• Presence - Changing current activity or online status
• Guild Setup - Requesting Members of newly joined guilds
• Heartbeats - Regular updates to keep the connection alive (usually once a minute)

When nothing has to be sent the pool will only be used every 500 milliseconds to check the queue for new payloads. Once a new payload is sent we switch to "rapid mode" which means more tasks will be submitted until no more payloads have to be sent.

Default: Shared ScheduledThreadPoolExecutor with (log(shard_total)) threads.

Parameters:

pool - The thread-pool to use for main WebSocket workers

automaticShutdown - Whether JDA.shutdown() should automatically shutdown this pool

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setGatewayPoolProvider

@Nonnull
public DefaultShardManagerBuilder setGatewayPoolProvider(@Nullable
 ThreadPoolProvider<? extends ScheduledExecutorService> provider)

Sets the ScheduledExecutorService that should be used for the JDA main WebSocket workers.
Only change this pool if you know what you're doing.

This is used to send various forms of session updates such as:

• Voice States - (Dis-)Connecting from channels
• Presence - Changing current activity or online status
• Guild Setup - Requesting Members of newly joined guilds
• Heartbeats - Regular updates to keep the connection alive (usually once a minute)

When nothing has to be sent the pool will only be used every 500 milliseconds to check the queue for new payloads. Once a new payload is sent we switch to "rapid mode" which means more tasks will be submitted until no more payloads have to be sent.

Default: Shared ScheduledThreadPoolExecutor with (log(shard_total)) threads.

Parameters:

provider - The thread-pool provider to use for main WebSocket workers

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setCallbackPool

@Nonnull
public DefaultShardManagerBuilder setCallbackPool(@Nullable
 ExecutorService executor)

Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks. By default JDA will use ForkJoinPool.commonPool()
Only change this pool if you know what you're doing.
This automatically disables the automatic shutdown of the callback pools, you can enable it using setCallbackPool(executor, true)

This is used to handle callbacks of RestAction.queue(), similarly it is used to finish RestAction.submit() and RestAction.complete() tasks which build on queue.

Default: ForkJoinPool.commonPool()

Parameters:

executor - The thread-pool to use for callback handling

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setCallbackPool

@Nonnull
public DefaultShardManagerBuilder setCallbackPool(@Nullable
 ExecutorService executor,
 boolean automaticShutdown)

Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks. By default JDA will use ForkJoinPool.commonPool()
Only change this pool if you know what you're doing.

This is used to handle callbacks of RestAction.queue(), similarly it is used to finish RestAction.submit() and RestAction.complete() tasks which build on queue.

Default: ForkJoinPool.commonPool()

Parameters:

executor - The thread-pool to use for callback handling

automaticShutdown - Whether JDA.shutdown() should automatically shutdown this pool

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setCallbackPoolProvider

@Nonnull
public DefaultShardManagerBuilder setCallbackPoolProvider(@Nullable
 ThreadPoolProvider<? extends ExecutorService> provider)

Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks. By default JDA will use ForkJoinPool.commonPool()
Only change this pool if you know what you're doing.

This is used to handle callbacks of RestAction.queue(), similarly it is used to finish RestAction.submit() and RestAction.complete() tasks which build on queue.

Default: ForkJoinPool.commonPool()

Parameters:

provider - The thread-pool provider to use for callback handling

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setEventPool

@Nonnull
public DefaultShardManagerBuilder setEventPool(@Nullable
 ExecutorService executor)

Sets the ExecutorService that should be used by the event proxy to schedule events. This will be done on the calling thread by default.

The executor will not be shutdown automatically when the shard is shutdown. To shut it down automatically use setEventPool(ExecutorService, boolean).

Default: Disabled

Parameters:

executor - The executor for the event proxy, or null to use calling thread

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

setEventPool

@Nonnull
public DefaultShardManagerBuilder setEventPool(@Nullable
 ExecutorService executor,
 boolean automaticShutdown)

Sets the ExecutorService that should be used by the event proxy to schedule events. This will be done on the calling thread by default.

Default: Disabled

Parameters:

executor - The executor for the event proxy, or null to use calling thread

automaticShutdown - True, if the executor should be shutdown when JDA shuts down

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

setEventPoolProvider

@Nonnull
public DefaultShardManagerBuilder setEventPoolProvider(@Nullable
 ThreadPoolProvider<? extends ExecutorService> provider)

Sets the ExecutorService that should be used in the JDA callback handler which mostly consists of RestAction callbacks. By default JDA will use ForkJoinPool.commonPool()
Only change this pool if you know what you're doing.

This is used to handle callbacks of RestAction.queue(), similarly it is used to finish RestAction.submit() and RestAction.complete() tasks which build on queue.

Default: Disabled

Parameters:

provider - The thread-pool provider to use for callback handling

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

setAudioPool

@Nonnull
public DefaultShardManagerBuilder setAudioPool(@Nullable
 ScheduledExecutorService pool)

Sets the ScheduledExecutorService used by the audio WebSocket connection. Used for sending keepalives and closing the connection.
Only change this pool if you know what you're doing.

Default: ScheduledThreadPoolExecutor with 1 thread

Parameters:

pool - The thread-pool to use for the audio WebSocket

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.1

setAudioPool

@Nonnull
public DefaultShardManagerBuilder setAudioPool(@Nullable
 ScheduledExecutorService pool,
 boolean automaticShutdown)

Sets the ScheduledExecutorService used by the audio WebSocket connection. Used for sending keepalives and closing the connection.
Only change this pool if you know what you're doing.

Default: ScheduledThreadPoolExecutor with 1 thread

Parameters:

pool - The thread-pool to use for the audio WebSocket

automaticShutdown - True, if the executor should be shutdown when JDA shuts down

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.1

setAudioPoolProvider

@Nonnull
public DefaultShardManagerBuilder setAudioPoolProvider(@Nullable
 ThreadPoolProvider<? extends ScheduledExecutorService> provider)

Sets the ScheduledExecutorService used by the audio WebSocket connection. Used for sending keepalives and closing the connection.
Only change this pool if you know what you're doing.

Default: ScheduledThreadPoolExecutor with 1 thread

Parameters:

provider - The thread-pool provider to use for the audio WebSocket

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.1

setMaxReconnectDelay

@Nonnull
public DefaultShardManagerBuilder setMaxReconnectDelay(int maxReconnectDelay)

Sets the maximum amount of time that JDA will back off to wait when attempting to reconnect the MainWebsocket.
Provided value must be 32 or greater.

Default: 900

Parameters:

maxReconnectDelay - The maximum amount of time that JDA will wait between reconnect attempts in seconds.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - Thrown if the provided maxReconnectDelay is less than 32.

setRequestTimeoutRetry

@Nonnull
public DefaultShardManagerBuilder setRequestTimeoutRetry(boolean retryOnTimeout)

Whether the Requester should retry when a SocketTimeoutException occurs.
Default: true

This value can be changed at any time with JDA.setRequestTimeoutRetry(boolean)!

Parameters:

retryOnTimeout - True, if the Request should retry once on a socket timeout

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setShards

@Nonnull
public DefaultShardManagerBuilder setShards(int... shardIds)

Sets the list of shards the DefaultShardManager should contain.

This does not have any effect if the total shard count is set to -1 (get recommended shards from discord).

Parameters:

shardIds - The list of shard ids

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setShards

@Nonnull
public DefaultShardManagerBuilder setShards(int minShardId,
 int maxShardId)

Sets the range of shards the DefaultShardManager should contain. This is useful if you want to split your shards between multiple JVMs or servers.

This does not have any effect if the total shard count is set to -1 (get recommended shards from discord).

Parameters:

minShardId - The lowest shard id the DefaultShardManager should contain

maxShardId - The highest shard id the DefaultShardManager should contain

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If either minShardId is negative, maxShardId is lower than shardsTotal or minShardId is lower than or equal to maxShardId

setShards

@Nonnull
public DefaultShardManagerBuilder setShards(@Nonnull
 Collection<Integer> shardIds)

Sets the range of shards the DefaultShardManager should contain. This is useful if you want to split your shards between multiple JVMs or servers.

This does not have any effect if the total shard count is set to -1 (get recommended shards from discord).

Parameters:

shardIds - The list of shard ids

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If either minShardId is negative, maxShardId is lower than shardsTotal or minShardId is lower than or equal to maxShardId

setShardsTotal

@Nonnull
public DefaultShardManagerBuilder setShardsTotal(int shardsTotal)

This will set the total amount of shards the DefaultShardManager should use.

If this is set to -1 JDA will automatically retrieve the recommended amount of shards from discord (default behavior).

Parameters:

shardsTotal - The number of overall shards or -1 if JDA should use the recommended amount from discord.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• setShards(int, int)

setToken

@Nonnull
public DefaultShardManagerBuilder setToken(@Nonnull
 String token)

Sets the token that will be used by the ShardManager instance to log in when build() is called.

To get a bot token:

1. Go to your Discord Applications
2. Create or select an already existing application
3. Verify that it has already been turned into a Bot. If you see the "Create a Bot User" button, click it.
4. Click the click to reveal link beside the Token label to show your Bot's token

Parameters:

token - The token of the account that you would like to login with.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If the token is either null or empty

setUseShutdownNow

@Nonnull
public DefaultShardManagerBuilder setUseShutdownNow(boolean useShutdownNow)

Whether the ShardManager should use JDA#shutdownNow() instead of JDA#shutdown() to shutdown it's shards.
Default: false

Parameters:

useShutdownNow - Whether the ShardManager should use JDA#shutdown() or not

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

See Also:

• JDA.shutdown()
• JDA.shutdownNow()

setWebsocketFactory

@Nonnull
public DefaultShardManagerBuilder setWebsocketFactory(@Nullable
 WebSocketFactory factory)

Sets the WebSocketFactory that will be used by JDA's websocket client. This can be used to set things such as connection timeout and proxy.

Parameters:

factory - The new WebSocketFactory to use.

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

setChunkingFilter

@Nonnull
public DefaultShardManagerBuilder setChunkingFilter(@Nullable
 ChunkingFilter filter)

The ChunkingFilter to filter which guilds should use member chunking.

Use setMemberCachePolicy(MemberCachePolicy) to configure which members to keep in cache from chunking.

Parameters:

filter - The filter to apply

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.0.0

See Also:

• ChunkingFilter.NONE
• ChunkingFilter.include(long...)
• ChunkingFilter.exclude(long...)

setDisabledIntents

@Nonnull
public DefaultShardManagerBuilder setDisabledIntents(@Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Configures which events will be disabled. Bots which did not enable presence/member updates in the developer dashboard are required to disable GatewayIntent.GUILD_PRESENCES and GatewayIntent.GUILD_MEMBERS!

It is not recommended to disable GatewayIntent.GUILD_MEMBERS when using MemberCachePolicy.ALL as the members cannot be removed from cache by a leave event without this intent.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intent - The first intent to disable

intents - Any other intents to disable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If null is provided

Since:

4.2.0

See Also:

• setMemberCachePolicy(MemberCachePolicy)

setDisabledIntents

@Nonnull
public DefaultShardManagerBuilder setDisabledIntents(@Nullable
 Collection<GatewayIntent> intents)

Configures which events will be disabled. Bots which did not enable presence/member updates in the developer dashboard are required to disable GatewayIntent.GUILD_PRESENCES and GatewayIntent.GUILD_MEMBERS!

It is not recommended to disable GatewayIntent.GUILD_MEMBERS when using MemberCachePolicy.ALL as the members cannot be removed from cache by a leave event without this intent.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intents - The intents to disable, or null to disable all intents (default: none)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

See Also:

• setMemberCachePolicy(MemberCachePolicy)

disableIntents

@Nonnull
public DefaultShardManagerBuilder disableIntents(@Nonnull
 Collection<GatewayIntent> intents)

Disable the specified GatewayIntents.
This will not enable any currently unset intents.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intents - The intents to disable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• enableIntents(Collection)

disableIntents

@Nonnull
public DefaultShardManagerBuilder disableIntents(@Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Disable the specified GatewayIntents.
This will not enable any currently unset intents.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intent - The intent to disable

intents - Other intents to disable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• enableIntents(GatewayIntent, GatewayIntent...)

setEnabledIntents

@Nonnull
public DefaultShardManagerBuilder setEnabledIntents(@Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Configures which events will be enabled. Bots which did not enable presence/member updates in the developer dashboard are required to disable GatewayIntent.GUILD_PRESENCES and GatewayIntent.GUILD_MEMBERS!

It is not recommended to disable GatewayIntent.GUILD_MEMBERS when using MemberCachePolicy.ALL as the members cannot be removed from cache by a leave event without this intent.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intent - The intent to enable

intents - Any other intents to enable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If null is provided

Since:

4.2.0

See Also:

• setMemberCachePolicy(MemberCachePolicy)

setEnabledIntents

@Nonnull
public DefaultShardManagerBuilder setEnabledIntents(@Nullable
 Collection<GatewayIntent> intents)

Configures which events will be enabled. Bots which did not enable presence/member updates in the developer dashboard are required to disable GatewayIntent.GUILD_PRESENCES and GatewayIntent.GUILD_MEMBERS!

It is not recommended to disable GatewayIntent.GUILD_MEMBERS when using MemberCachePolicy.ALL as the members cannot be removed from cache by a leave event without this intent.

If you disable certain intents you also have to disable related CacheFlags. This can be achieved using disableCache(CacheFlag, CacheFlag...). The required intents for each flag are documented in the CacheFlag enum.

Parameters:

intents - The intents to enable, or null to enable no intents (default: all)

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.2.0

See Also:

• setMemberCachePolicy(MemberCachePolicy)

enableIntents

@Nonnull
public DefaultShardManagerBuilder enableIntents(@Nonnull
 Collection<GatewayIntent> intents)

Enable the specified GatewayIntents.
This will not disable any currently set intents.

Parameters:

intents - The intents to enable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• disableIntents(Collection)

enableIntents

@Nonnull
public DefaultShardManagerBuilder enableIntents(@Nonnull
 GatewayIntent intent,
 @Nonnull
 GatewayIntent... intents)

Enable the specified GatewayIntents.
This will not disable any currently set intents.

Parameters:

intent - The intent to enable

intents - Other intents to enable

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If provided with null

See Also:

• enableIntents(GatewayIntent, GatewayIntent...)

setLargeThreshold

@Nonnull
public DefaultShardManagerBuilder setLargeThreshold(int threshold)

Decides the total number of members at which a guild should start to use lazy loading.
This is limited to a number between 50 and 250 (inclusive). If the chunking filter is set to ChunkingFilter.ALL this should be set to 250 (default) to minimize the amount of guilds that need to request members.

Parameters:

threshold - The threshold in [50, 250]

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Since:

4.0.0

setMaxBufferSize

@Nonnull
public DefaultShardManagerBuilder setMaxBufferSize(int bufferSize)

The maximum size, in bytes, of the buffer used for decompressing discord payloads.
If the maximum buffer size is exceeded a new buffer will be allocated instead.
Setting this to Integer.MAX_VALUE would imply the buffer will never be resized unless memory starvation is imminent.
Setting this to 0 would imply the buffer would need to be allocated again for every payload (not recommended).

Default: 2048

Parameters:

bufferSize - The maximum size the buffer should allow to retain

Returns:

The DefaultShardManagerBuilder instance. Useful for chaining.

Throws:

IllegalArgumentException - If the provided buffer size is negative

build

@Nonnull
public ShardManager build()
                   throws IllegalArgumentException

Builds a new ShardManager instance and uses the provided token to start the login process.
The login process runs in a different thread, so while this will return immediately, ShardManager has not finished loading, thus many ShardManager methods have the chance to return incorrect information.
The main use of this method is to start the JDA connect process and do other things in parallel while startup is being performed like database connection or local resource loading.

Note that this method is async and as such will not block until all shards are started.

Returns:

A ShardManager instance that has started the login process. It is unknown as to whether or not loading has finished when this returns.

Throws:

InvalidTokenException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

ErrorResponseException - If some other HTTP error occurred.

build

@Nonnull
public ShardManager build(boolean login)
                   throws IllegalArgumentException

Builds a new ShardManager instance. If the login parameter is true, then it will start the login process.
The login process runs in a different thread, so while this will return immediately, ShardManager has not finished loading, thus many ShardManager methods have the chance to return incorrect information.
The main use of this method is to start the JDA connect process and do other things in parallel while startup is being performed like database connection or local resource loading.

Note that this method is async and as such will not block until all shards are started.

Parameters:

login - Whether the login process will be started. If this is false, then you will need to manually call ShardManager.login() to start it.

Returns:

A ShardManager instance. If login is set to true, then the instance will have started the login process. It is unknown as to whether or not loading has finished when this returns.

Throws:

InvalidTokenException - If the provided token is invalid and login is true

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.