discord4j.core

Class DiscordClientBuilder

java.lang.Object

discord4j.core.DiscordClientBuilder

public final class DiscordClientBuilder
extends Object

Builder suited for creating a DiscordClient.

Allows creating a Discord client for a single shard with many configurable options. You can reuse this builder for sharding as long as you set the setShardIndex(Integer) and setShardCount(Integer) options, or setIdentifyOptions(IdentifyOptions).

Constructor Summary

Constructors

Constructor and Description
DiscordClientBuilder(String token) Initialize a new builder with the given token.

Method Summary

Modifier and Type	Method and Description
DiscordClient	build() Create a client ready to connect to Discord.
FluxProcessor<Event,Event>	getEventProcessor() Deprecated.
Scheduler	getEventScheduler() Deprecated.
GatewayClientFactory	getGatewayClientFactory() Deprecated.
GatewayObserver	getGatewayObserver() Deprecated.
PayloadTransformer	getIdentifyLimiter() Deprecated.
IdentifyOptions	getIdentifyOptions() Deprecated.
Presence	getInitialPresence() Deprecated.
JacksonResourceProvider	getJacksonResourceProvider() Deprecated.
RetryOptions	getRetryOptions() Deprecated.
RouterFactory	getRouterFactory() Deprecated.
RouterOptions	getRouterOptions() Deprecated.
Integer	getShardCount() Deprecated.
Integer	getShardIndex() Deprecated.
StoreService	getStoreService() Deprecated.
String	getToken() Deprecated.
Scheduler	getVoiceConnectionScheduler() Deprecated.
DiscordClientBuilder	setEventProcessor(FluxProcessor<Event,Event> eventProcessor) Set a new FluxProcessor used to queue Discord events in conjunction with EventDispatcher.
DiscordClientBuilder	setEventScheduler(Scheduler eventScheduler) Set a new Scheduler used to publish events through EventDispatcher.
DiscordClientBuilder	setGatewayClientFactory(GatewayClientFactory gatewayClientFactory) Set a new GatewayClientFactory to this builder, allowing you to configure the underlying GatewayClient used when logging in with the resulting clients.
DiscordClientBuilder	setGatewayObserver(GatewayObserver gatewayObserver) Set a new GatewayObserver to this builder.
DiscordClientBuilder	setIdentifyLimiter(PayloadTransformer identifyLimiter) Set a new PayloadTransformer to this builder.
DiscordClientBuilder	setIdentifyOptions(IdentifyOptions identifyOptions) Set a new IdentifyOptions to this builder.
DiscordClientBuilder	setInitialPresence(Presence initialPresence) Set a new Presence object used when identifying to the Gateway.
DiscordClientBuilder	setJacksonResourceProvider(JacksonResourceProvider jacksonResourceProvider) Set a new JacksonResourceProvider to this builder, dedicated to provide an ObjectMapper for serialization and deserialization of data.
DiscordClientBuilder	setRetryOptions(RetryOptions retryOptions) Set a new RetryOptions to this builder.
DiscordClientBuilder	setRouterFactory(RouterFactory routerFactory) Set a new RouterFactory used to create a Router that executes Discord REST API requests.
DiscordClientBuilder	setRouterOptions(RouterOptions routerOptions) Sets a new RouterOptions used to configure a RouterFactory.
DiscordClientBuilder	setShardCount(Integer shardCount) Change the shard count.
DiscordClientBuilder	setShardIndex(Integer shardIndex) Change the shard index.
DiscordClientBuilder	setStoreService(StoreService storeService) Set a new StoreService to this builder, used to create Store instances on login to cache entities.
DiscordClientBuilder	setToken(String token) Change the token stored in this builder.
DiscordClientBuilder	setVoiceConnectionScheduler(Scheduler voiceConnectionScheduler) Set a new Scheduler for voice sending tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscordClientBuilder

public DiscordClientBuilder(String token)

Initialize a new builder with the given token.

Parameters:

token - the bot token used to authenticate to Discord

Method Detail

getToken

@Deprecated
public String getToken()

Deprecated.

Retrieve the token set in this builder.

Returns:

the current bot token

setToken

public DiscordClientBuilder setToken(String token)

Change the token stored in this builder.

Parameters:

token - the new bot token

Returns:

this builder

getShardIndex

@Nullable
 @Deprecated
public Integer getShardIndex()

Deprecated.

Retrieve the current shard index.

Returns:

the current shard index, can be null

setShardIndex

public DiscordClientBuilder setShardIndex(@Nullable
                                          Integer shardIndex)

Change the shard index. Can override shard index set in setIdentifyOptions(IdentifyOptions).

Validation is only performed during build(). Make sure the following holds:

0 <= shardIndex < shardCount

Parameters:

shardIndex - the new shard index, can be set to null to use the value under setIdentifyOptions(IdentifyOptions) if set, or fallback to a default

Returns:

this builder

getShardCount

@Nullable
 @Deprecated
public Integer getShardCount()

Deprecated.

Retrieve the current shard count, can be null

Returns:

the current shard count

setShardCount

public DiscordClientBuilder setShardCount(@Nullable
                                          Integer shardCount)

Change the shard count.

Validation is only performed during build(). Make sure the following holds:

0 <= shardIndex < shardCount

Parameters:

shardCount - the new shard count, can be set to null to use a default value

Returns:

this builder

getStoreService

@Nullable
 @Deprecated
public StoreService getStoreService()

Deprecated.

Get the current StoreService factory, used to create Store instances on login to cache entities.

Can be null if automatic discovery is to be used.

Returns:

the current StoreService factory, null if automatic discovery should be used

setStoreService

public DiscordClientBuilder setStoreService(@Nullable
                                            StoreService storeService)

Set a new StoreService to this builder, used to create Store instances on login to cache entities.

Parameters:

storeService - a new StoreService factory, can be null to enable automatic discovery

Returns:

this builder

getEventProcessor

@Nullable
 @Deprecated
public FluxProcessor<Event,Event> getEventProcessor()

Deprecated.

Get the current FluxProcessor used to queue Discord events in conjunction with EventDispatcher. Can be null if a default EmitterProcessor is used.

Returns:

a FluxProcessor dedicated to queue events, can be null when using a default value

setEventProcessor

public DiscordClientBuilder setEventProcessor(@Nullable
                                              FluxProcessor<Event,Event> eventProcessor)

Set a new FluxProcessor used to queue Discord events in conjunction with EventDispatcher.

Parameters:

eventProcessor - a new FluxProcessor used in this builder. Can be left null if a default EmitterProcessor is used

Returns:

this builder

getEventScheduler

@Nullable
 @Deprecated
public Scheduler getEventScheduler()

Deprecated.

Get the current Scheduler used to publish events through EventDispatcher.

Returns:

the current Scheduler for event dispatching, can be null when using a default value

setEventScheduler

public DiscordClientBuilder setEventScheduler(@Nullable
                                              Scheduler eventScheduler)

Set a new Scheduler used to publish events through EventDispatcher.

Parameters:

eventScheduler - a new Scheduler for event dispatching. Can be null to use a default value

Returns:

this builder

getJacksonResourceProvider

@Nullable
 @Deprecated
public JacksonResourceProvider getJacksonResourceProvider()

Deprecated.

Get the current JacksonResourceProvider, providing an ObjectMapper for serialization and deserialization of data.

Returns:

the current resource provider for object serialization and deserialization, can be null when using a default value

setJacksonResourceProvider

public DiscordClientBuilder setJacksonResourceProvider(@Nullable
                                                       JacksonResourceProvider jacksonResourceProvider)

Set a new JacksonResourceProvider to this builder, dedicated to provide an ObjectMapper for serialization and deserialization of data.

Parameters:

jacksonResourceProvider - the new resource provider for serialization and deserialization, use null to use a default one

Returns:

this builder

getRouterFactory

@Nullable
 @Deprecated
public RouterFactory getRouterFactory()

Deprecated.

Get the current RouterFactory used to create a Router that executes Discord REST API requests.

Returns:

the current RouterFactory used to create a Router that perform API requests

setRouterFactory

public DiscordClientBuilder setRouterFactory(@Nullable
                                             RouterFactory routerFactory)

Set a new RouterFactory used to create a Router that executes Discord REST API requests.

The resulting client will utilize the produced Router for every request. When performing sharding operations, it is expected that the underlying Router instance to be shared across shards in order to properly coordinate rate-limits on global endpoints. For those cases, use SingleRouterFactory.

Parameters:

routerFactory - a new RouterFactory to create a Router that performs API requests. Pass null to use a default value

Returns:

this builder

getRouterOptions

@Nullable
 @Deprecated
public RouterOptions getRouterOptions()

Deprecated.

Return the current RouterOptions used to configure RouterFactory instances.

Returns:

the current RouterOptions used by this client

setRouterOptions

public DiscordClientBuilder setRouterOptions(@Nullable
                                             RouterOptions routerOptions)

Sets a new RouterOptions used to configure a RouterFactory.

RouterOptions instances provide a way to override the Scheduler used for retrieving API responses and scheduling rate limiting actions. It also allows changing the behavior associated with API errors through RouterOptions.Builder#onClientResponse(ResponseFunction).

If you use a default RouterFactory, it will use the supplied RouterOptions to configure itself while building this client.

Calling this method while sharding clients will not apply the supplied options as requests on the coordinated Router implementation have already begun. Use ShardingClientBuilder.setRouterOptions(RouterOptions) instead.

Parameters:

routerOptions - a new RouterOptions to configure a RouterFactory

Returns:

this builder

getGatewayClientFactory

@Nullable
 @Deprecated
public GatewayClientFactory getGatewayClientFactory()

Deprecated.

Get the current GatewayClientFactory to use with the resulting clients.

Returns:

the currently installed factory, or null if using a DefaultGatewayClientFactory

setGatewayClientFactory

public DiscordClientBuilder setGatewayClientFactory(@Nullable
                                                    GatewayClientFactory gatewayClientFactory)

Set a new GatewayClientFactory to this builder, allowing you to configure the underlying GatewayClient used when logging in with the resulting clients.

Parameters:

gatewayClientFactory - the new factory, or null to use a DefaultGatewayClientFactory

Returns:

this builder

getInitialPresence

@Nullable
 @Deprecated
public Presence getInitialPresence()

Deprecated.

Get the current Presence object used when identifying to the Gateway.

Returns:

the current presence status used for login. Can be null to use the value under setIdentifyOptions(IdentifyOptions) if set, or fallback to a default

setInitialPresence

public DiscordClientBuilder setInitialPresence(@Nullable
                                               Presence initialPresence)

Set a new Presence object used when identifying to the Gateway.

Parameters:

initialPresence - the new presence status used for login. Can be null to use the value under setIdentifyOptions(IdentifyOptions) if set, or fallback to a default

Returns:

this builder

getIdentifyOptions

@Nullable
 @Deprecated
public IdentifyOptions getIdentifyOptions()

Deprecated.

Get the current IdentifyOptions set in this builder. IdentifyOptions is a container object targeted to group all parameters applied on bot login, like shard information, initial status and even session identifier and sequence required to resume a session.

Options under getShardIndex(), getShardCount() and getInitialPresence() override the values in this object.

Returns:

the current set of bot identification options

setIdentifyOptions

public DiscordClientBuilder setIdentifyOptions(@Nullable
                                               IdentifyOptions identifyOptions)

Set a new IdentifyOptions to this builder. IdentifyOptions is a container object targeted to group all parameters applied on bot login, like shard information, initial status and even session identifier and sequence required to resume a session.

Options under setShardIndex(Integer), setShardCount(Integer) and setInitialPresence(Presence) override the values in this object.

Parameters:

identifyOptions - the new bot identification options. Can be set to null to use a default

Returns:

this builder

getRetryOptions

@Nullable
 @Deprecated
public RetryOptions getRetryOptions()

Deprecated.

Get the current RetryOptions set in this builder. RetryOptions is an advanced container object to parameterize the retry policy used in the gateway operations.

Returns:

the current retry policy, can be null if default is used

setRetryOptions

public DiscordClientBuilder setRetryOptions(@Nullable
                                            RetryOptions retryOptions)

Set a new RetryOptions to this builder. RetryOptions is an advanced container object to parameterize the retry policy used in the gateway operations.

Parameters:

retryOptions - the new retry policy. Can be set to null to use a default

Returns:

this builder

getGatewayObserver

@Nullable
 @Deprecated
public GatewayObserver getGatewayObserver()

Deprecated.

Get the current GatewayObserver set in this builder. GatewayObserver is used as a simple event listener for gateway connection lifecycle. User can be notified of broad lifecycle events like connections, resumes, reconnects and disconnects but also very specific ones like session sequence updates.

Returns:

an event listener for gateway lifecycle, can be null if default is used

See Also:

StoreInvalidator

setGatewayObserver

public DiscordClientBuilder setGatewayObserver(@Nullable
                                               GatewayObserver gatewayObserver)

Set a new GatewayObserver to this builder. GatewayObserver is used as a simple event listener for gateway connection lifecycle. User can be notified of broad lifecycle events like connections, resumes, reconnects and disconnects but also very specific ones like session sequence updates.

Parameters:

gatewayObserver - a new event listener for gateway lifecycle. Can be chained using GatewayObserver.then(GatewayObserver) to create a composite of an arbitrary number of listeners. Can be set to null to use a default

Returns:

this builder

getIdentifyLimiter

@Nullable
 @Deprecated
public PayloadTransformer getIdentifyLimiter()

Deprecated.

Get the current PayloadTransformer set in this builder. The transformer will be used as a rate limiting strategy dedicated to coordinate identify requests between shards.

Returns:

the current gateway limiter, for shard coordination, can be null if default is used

setIdentifyLimiter

public DiscordClientBuilder setIdentifyLimiter(@Nullable
                                               PayloadTransformer identifyLimiter)

Set a new PayloadTransformer to this builder. The transformer will be used as a rate limiting strategy dedicated to coordinate identify requests between shards.

Parameters:

identifyLimiter - the current limiter strategy, for shard coordination, can be null for a default

Returns:

this builder

getVoiceConnectionScheduler

@Deprecated
public Scheduler getVoiceConnectionScheduler()

Deprecated.

Get the current Scheduler for voice sending tasks.

Returns:

the scheduler for voice sending tasks

setVoiceConnectionScheduler

public DiscordClientBuilder setVoiceConnectionScheduler(Scheduler voiceConnectionScheduler)

Set a new Scheduler for voice sending tasks.

Parameters:

voiceConnectionScheduler - the new scheduler for voice sending tasks, must not be null

Returns:

this builder

build

public DiscordClient build()

Create a client ready to connect to Discord.

Returns:

a DiscordClient based on this builder parameters