discord4j.core

Class DiscordClientBuilder<C,O extends RouterOptions>

java.lang.Object

discord4j.rest.RestClientBuilder<C,O>

discord4j.core.DiscordClientBuilder<C,O>

public final class DiscordClientBuilder<C,O extends RouterOptions>
extends RestClientBuilder<C,O>

Builder suited for creating a DiscordClient. To acquire an instance, see create(String).

Nested Class Summary

Nested classes/interfaces inherited from class discord4j.rest.RestClientBuilder

RestClientBuilder.Config

Field Summary

Fields inherited from class discord4j.rest.RestClientBuilder

clientFactory, exchangeStrategies, globalRateLimiter, jacksonResources, optionsModifier, reactorResources, requestQueueFactory, responseTransformers, token

Method Summary

Modifier and Type	Method and Description
C	build() Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a DefaultRouter that is capable of working in monolithic environments.
C	build(Function<O,Router> routerFactory) Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a custom Router factory.
static DiscordClientBuilder<DiscordClient,RouterOptions>	create(String token) Initialize a new builder with the given token.
DiscordClientBuilder<C,O>	setDebugMode(boolean debugMode) Deprecated. for removal, please use Hooks.onOperatorDebug() at the start of your application

Methods inherited from class discord4j.rest.RestClientBuilder

createRest, onClientResponse, setExchangeStrategies, setExtraOptions, setGlobalRateLimiter, setJacksonResources, setReactorResources, setRequestQueueFactory, setToken

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DiscordClientBuilder<DiscordClient,RouterOptions> create(String token)

Initialize a new builder with the given token.

Parameters:

token - the bot token used to authenticate to Discord

setDebugMode

@Deprecated
public DiscordClientBuilder<C,O> setDebugMode(boolean debugMode)

Deprecated. for removal, please use Hooks.onOperatorDebug() at the start of your application

Whether to enable Hooks.onOperatorDebug() when building a DiscordClient. This is a global hook to enrich stack traces in case of errors for easier debugging at a performance cost. In production or higher load scenarios, we recommend setting this to false and looking for better alternatives such as the Reactor debug agent.

Parameters:

debugMode - true to enable debug mode. Setting this to false will not reset the hook if previously enabled.

Returns:

this builder

See Also:

Reactor Reference: Production-ready Global Debugging

build

public C build()

Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a DefaultRouter that is capable of working in monolithic environments.

Overrides:

build in class RestClientBuilder<C,O extends RouterOptions>

Returns:

a configured DiscordClient based on this builder parameters

build

public C build(Function<O,Router> routerFactory)

Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a custom Router factory. The resulting DiscordClient will use the produced Router for every request.

Overrides:

build in class RestClientBuilder<C,O extends RouterOptions>

Parameters:

routerFactory - the factory of Router implementation

Returns:

a configured DiscordClient based on this builder parameters