Package net.dv8tion.jda.internal

Class JDAImpl

java.lang.Object

net.dv8tion.jda.internal.JDAImpl

All Implemented Interfaces:

IGuildChannelContainer<Channel>, JDA

public class JDAImpl
extends Object
implements JDA

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.JDA

JDA.ShardInfo, JDA.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	LOG
ShutdownReason	shutdownReason

Constructor Summary

Constructors

Constructor	Description
JDAImpl(AuthorizationConfig authConfig)
JDAImpl(AuthorizationConfig authConfig, SessionConfig sessionConfig, ThreadingConfig threadConfig, MetaConfig metaConfig, RestConfig restConfig)

Method Summary

Modifier and Type	Method	Description
void	addEventListener(Object... listeners)	Adds all provided listeners to the event-listeners that will be used to handle events.
boolean	awaitShutdown(long timeout, TimeUnit unit)	Blocks the current thread until JDA.getStatus() returns JDA.Status.SHUTDOWN.
JDA	awaitStatus(JDA.Status status, JDA.Status... failOn)	This method will block until JDA has reached the specified connection status.
boolean	cacheMember(Member member)
int	cancelRequests()	Cancels all currently scheduled RestAction requests.
boolean	chunkGuild(long id)
RestAction<ApplicationEmoji>	createApplicationEmoji(String name, Icon icon)	Creates a new ApplicationEmoji for this bot.
GuildActionImpl	createGuild(String name)	Constructs a new Guild with the specified name Use the returned GuildAction to provide further details and settings for the resulting Guild!
RestAction<Void>	createGuildFromTemplate(String code, String name, Icon icon)	Constructs a new Guild from the specified template code.
TestEntitlementCreateAction	createTestEntitlement(long skuId, long ownerId, TestEntitlementCreateAction.OwnerType ownerType)	Constructs a new Entitlement with the skuId and the type.
RestAction<Void>	deleteCommandById(String commandId)	Delete the global command for this id.
RestAction<Void>	deleteTestEntitlement(long entitlementId)	Deletes a test entitlement by its id.
CommandEditAction	editCommandById(Command.Type type, String id)	Edit an existing global command by id.
ApplicationManager	getApplicationManager()	Returns the ApplicationManager that manages the application associated with the bot.
ScheduledExecutorService	getAudioLifeCyclePool()
CacheView<AudioManager>	getAudioManagerCache()	CacheView of all cached AudioManagers created for this JDA instance.
AbstractCacheView<AudioManager>	getAudioManagersView()
IAudioSendFactory	getAudioSendFactory()
AuthorizationConfig	getAuthorizationConfig()
EnumSet<CacheFlag>	getCacheFlags()	The cache flags that have been enabled for this JDA session.
ExecutorService	getCallbackPool()	ExecutorService used to handle RestAction callbacks and completions.
SnowflakeCacheView<Category>	getCategoryCache()	Sorted SnowflakeCacheView of Category.
<T extends Channel> T	getChannelById(Class<T> type, long id)	Get a channel of the specified type by id.
ChannelCacheView<Channel>	getChannelCache()	Unified cache of all channels associated with this shard or guild.
ChannelCacheViewImpl<Channel>	getChannelsView()
WebSocketClient	getClient()
ConcurrentMap<String,String>	getContextMap()
DirectAudioControllerImpl	getDirectAudioController()	Direct access to audio (dis-)connect requests.
SnowflakeCacheView<RichCustomEmoji>	getEmojiCache()	Unified SnowflakeCacheView of all cached Custom Emojis visible to this JDA session.
EntityBuilder	getEntityBuilder()
EventCache	getEventCache()
IEventManager	getEventManager()	The EventManager used by this JDA instance.
SnowflakeCacheView<ForumChannel>	getForumChannelCache()	SnowflakeCacheView of ForumChannel.
String	getGateway()
EnumSet<GatewayIntent>	getGatewayIntents()	The GatewayIntents for this JDA session.
long	getGatewayPing()	The time in milliseconds that discord took to respond to our last heartbeat This roughly represents the WebSocket ping of this session
ScheduledExecutorService	getGatewayPool()	ScheduledExecutorService used to send WebSocket messages to discord.
String	getGatewayUrl()
SnowflakeCacheView<Guild>	getGuildCache()	SnowflakeCacheView of all cached Guilds visible to this JDA session.
GuildChannel	getGuildChannelById(long id)	Get GuildChannel for the provided ID.
GuildChannel	getGuildChannelById(ChannelType type, long id)	Get GuildChannel for the provided ID.
GuildSetupController	getGuildSetupController()
SnowflakeCacheViewImpl<Guild>	getGuildsView()
okhttp3.OkHttpClient	getHttpClient()	The OkHttpClient used for handling http requests from RestActions.
String	getIdentifierString()
String	getInviteUrl(Collection<Permission> permissions)	Creates an authorization invite url for the currently logged in Bot-Account.
String	getInviteUrl(Permission... permissions)	Creates an authorization invite url for the currently logged in Bot-Account.
int	getLargeThreshold()
int	getMaxBufferSize()
int	getMaxReconnectDelay()	This value is the maximum amount of time, in seconds, that JDA will wait between reconnect attempts.
SnowflakeCacheView<MediaChannel>	getMediaChannelCache()	SnowflakeCacheView of MediaChannel.
List<Guild>	getMutualGuilds(Collection<User> users)	Gets all Guilds that contain all given users as their members.
List<Guild>	getMutualGuilds(User... users)	Gets all Guilds that contain all given users as their members.
SnowflakeCacheView<NewsChannel>	getNewsChannelCache()	Sorted SnowflakeCacheView of NewsChannel.
Presence	getPresence()	The Presence controller for the current session.
PrivateChannel	getPrivateChannelById(long id)	This returns the PrivateChannel which has the same id as the one provided.
PrivateChannel	getPrivateChannelById(String id)	This returns the PrivateChannel which has the same id as the one provided.
SnowflakeCacheView<PrivateChannel>	getPrivateChannelCache()	SnowflakeCacheView of all cached PrivateChannels visible to this JDA session.
ScheduledExecutorService	getRateLimitPool()	ScheduledExecutorService used to handle rate-limits for RestAction executions.
List<Object>	getRegisteredListeners()	Immutable List of Objects that have been registered as EventListeners.
Requester	getRequester()
long	getResponseTotal()	This value is the total amount of JSON responses that discord has sent.
SnowflakeCacheView<Role>	getRoleCache()	Unified SnowflakeCacheView of all cached Roles visible to this JDA session.
SnowflakeCacheView<ScheduledEvent>	getScheduledEventCache()	SnowflakeCacheView of all cached ScheduledEvents visible to this JDA session.
SelfUser	getSelfUser()	Returns the currently logged in account represented by SelfUser.
SessionController	getSessionController()
SessionController.ShardedGateway	getShardedGateway()
JDA.ShardInfo	getShardInfo()	The shard information used when creating this instance of JDA.
ShardManager	getShardManager()	Returns the ShardManager that manages this JDA instances or null if this instance is not managed by any ShardManager.
SnowflakeCacheView<StageChannel>	getStageChannelCache()	Sorted SnowflakeCacheView of StageChannel.
JDA.Status	getStatus()	Gets the current Status of the JDA instance.
SnowflakeCacheView<TextChannel>	getTextChannelCache()	Sorted SnowflakeCacheView of TextChannel.
SnowflakeCacheView<ThreadChannel>	getThreadChannelCache()	SnowflakeCacheView of ThreadChannel.
String	getToken()	The login token that is currently being used for Discord authentication.
Set<String>	getUnavailableGuilds()	Set of Guild IDs for guilds that were marked unavailable by the gateway.
SnowflakeCacheView<User>	getUserCache()	SnowflakeCacheView of all cached Users visible to this JDA session.
SnowflakeCacheViewImpl<User>	getUsersView()
SnowflakeCacheView<VoiceChannel>	getVoiceChannelCache()	Sorted SnowflakeCacheView of VoiceChannel.
VoiceDispatchInterceptor	getVoiceInterceptor()
WebSocketFactory	getWebSocketFactory()
void	handleEvent(GenericEvent event)
boolean	hasSelfUser()
void	initRequester()
boolean	isAutoReconnect()	Used to determine whether or not autoReconnect is enabled for JDA.
boolean	isBulkDeleteSplittingEnabled()	Used to determine if JDA will process MESSAGE_DELETE_BULK messages received from Discord as a single MessageBulkDeleteEvent or split the deleted messages up and fire multiple MessageDeleteEvents, one for each deleted message.
boolean	isCacheFlagSet(CacheFlag flag)
boolean	isEventPassthrough()
boolean	isIntent(GatewayIntent intent)
boolean	isRawEvents()
boolean	isUnavailable(long guildId)	Whether the guild is unavailable.
<E extends GenericEvent> Once.Builder<E>	listenOnce(Class<E> eventType)	Returns a reusable builder for a one-time event listener.
int	login()
int	login(String gatewayUrl, JDA.ShardInfo shardInfo, Compression compression, boolean validateToken, int intents, GatewayEncoding encoding)
int	login(JDA.ShardInfo shardInfo, Compression compression, boolean validateToken, int intents, GatewayEncoding encoding)
CacheRestAction<PrivateChannel>	openPrivateChannelById(long userId)	Opens a PrivateChannel with the provided user by id.
void	removeEventListener(Object... listeners)	Removes all provided listeners from the event-listeners and no longer uses them to handle events.
void	resetGatewayUrl()
RestAction<ApplicationEmoji>	retrieveApplicationEmojiById(String emojiId)	Retrieves an application emoji together with its respective creator.
RestAction<List<ApplicationEmoji>>	retrieveApplicationEmojis()	Retrieves a list of Application Emojis together with their respective creators.
RestAction<ApplicationInfo>	retrieveApplicationInfo()	Retrieves the ApplicationInfo for the application that owns the logged in Bot-Account.
RestAction<Command>	retrieveCommandById(String id)	Retrieves the existing Command instance by id.
RestAction<List<Command>>	retrieveCommands(boolean withLocalizations)	Retrieves the list of global commands.
RestAction<Entitlement>	retrieveEntitlementById(long entitlementId)	Retrieves an Entitlement by its id.
EntitlementPaginationAction	retrieveEntitlements()	A PaginationAction implementation which allows you to iterate over Entitlements that are applicable to the logged in application.
RestAction<List<StickerPack>>	retrieveNitroStickerPacks()	Retrieves a list of all the public StickerPacks used for nitro.
RestAction<List<RoleConnectionMetadata>>	retrieveRoleConnectionMetadata()	Retrieves the currently configured RoleConnectionMetadata records for this application.
RestAction<StickerUnion>	retrieveSticker(StickerSnowflake sticker)	Attempts to retrieve a Sticker object based on the provided snowflake reference.
CacheRestAction<User>	retrieveUserById(long id)	Attempts to retrieve a User object based on the provided id.
RestAction<Webhook>	retrieveWebhookById(String webhookId)	Retrieves a Webhook by its id.
void	setAudioSendFactory(IAudioSendFactory factory)
void	setAutoReconnect(boolean autoReconnect)	Sets whether or not JDA should try to automatically reconnect if a connection-error is encountered.
void	setChunkingFilter(ChunkingFilter filter)
void	setContext()
void	setEventManager(IEventManager eventManager)	Changes the internal EventManager.
void	setGatewayPing(long ping)
void	setMemberCachePolicy(MemberCachePolicy policy)
void	setRequestTimeoutRetry(boolean retryOnTimeout)	Whether the Requester should retry when a SocketTimeoutException occurs.
JDA	setRequiredScopes(Collection<String> scopes)	Configures the required scopes applied to the JDA.getInviteUrl(Permission...) and similar methods.
void	setResponseTotal(int responseTotal)
void	setSelfUser(SelfUser selfUser)
void	setShardManager(ShardManager shardManager)
void	setStatus(JDA.Status status)
void	setToken(String token)
void	shutdown()	Shuts down this JDA instance, closing all its connections.
void	shutdownInternals(ShutdownEvent event)
void	shutdownNow()	Shuts down this JDA instance instantly, closing all its connections.
void	shutdownRequester()
boolean	unloadUser(long userId)	Attempts to remove the user with the provided id from the cache.
CommandListUpdateAction	updateCommands()	Configures the complete list of global commands.
RestAction<List<RoleConnectionMetadata>>	updateRoleConnectionMetadata(Collection<? extends RoleConnectionMetadata> records)	Updates the currently configured RoleConnectionMetadata records for this application.
CommandCreateAction	upsertCommand(CommandData command)	Creates or updates a global command.
void	usedPrivateChannel(long id)
void	verifyToken()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IGuildChannelContainer

getCategories, getCategoriesByName, getCategoryById, getCategoryById, getChannelById, getForumChannelById, getForumChannelById, getForumChannels, getForumChannelsByName, getGuildChannelById, getGuildChannelById, getMediaChannelById, getMediaChannelById, getMediaChannels, getMediaChannelsByName, getNewsChannelById, getNewsChannelById, getNewsChannels, getNewsChannelsByName, getStageChannelById, getStageChannelById, getStageChannels, getStageChannelsByName, getTextChannelById, getTextChannelById, getTextChannels, getTextChannelsByName, getThreadChannelById, getThreadChannelById, getThreadChannels, getThreadChannelsByName, getVoiceChannelById, getVoiceChannelById, getVoiceChannels, getVoiceChannelsByName

Methods inherited from interface net.dv8tion.jda.api.JDA

awaitReady, awaitShutdown, awaitShutdown, awaitStatus, createTestEntitlement, deleteCommandById, deleteTestEntitlement, editCommandById, getAudioManagers, getEmojiById, getEmojiById, getEmojis, getEmojisByName, getGuildById, getGuildById, getGuilds, getGuildsByName, getPrivateChannels, getRestPing, getRoleById, getRoleById, getRoles, getRolesByName, getScheduledEventById, getScheduledEventById, getScheduledEvents, getScheduledEventsByName, getUserById, getUserById, getUserByTag, getUserByTag, getUsers, getUsersByName, installAuxiliaryPort, openPrivateChannelById, retrieveApplicationEmojiById, retrieveCommandById, retrieveCommands, retrieveEntitlementById, retrieveUserById, retrieveWebhookById, setRequiredScopes, upsertCommand

Field Details

LOG

public static final org.slf4j.Logger LOG

shutdownReason

public ShutdownReason shutdownReason

Constructor Details

JDAImpl

public JDAImpl(AuthorizationConfig authConfig)

JDAImpl

public JDAImpl(AuthorizationConfig authConfig,
 SessionConfig sessionConfig,
 ThreadingConfig threadConfig,
 MetaConfig metaConfig,
 RestConfig restConfig)

Method Details

handleEvent

public void handleEvent(@Nonnull
 GenericEvent event)

isRawEvents

public boolean isRawEvents()

isEventPassthrough

public boolean isEventPassthrough()

isCacheFlagSet

public boolean isCacheFlagSet(CacheFlag flag)

isIntent

public boolean isIntent(GatewayIntent intent)

getLargeThreshold

public int getLargeThreshold()

getMaxBufferSize

public int getMaxBufferSize()

chunkGuild

public boolean chunkGuild(long id)

setChunkingFilter

public void setChunkingFilter(ChunkingFilter filter)

cacheMember

public boolean cacheMember(Member member)

setMemberCachePolicy

public void setMemberCachePolicy(MemberCachePolicy policy)

getSessionController

public SessionController getSessionController()

getGuildSetupController

public GuildSetupController getGuildSetupController()

getVoiceInterceptor

public VoiceDispatchInterceptor getVoiceInterceptor()

usedPrivateChannel

public void usedPrivateChannel(long id)

initRequester

public void initRequester()

login

public int login()

login

public int login(JDA.ShardInfo shardInfo,
 Compression compression,
 boolean validateToken,
 int intents,
 GatewayEncoding encoding)

login

public int login(String gatewayUrl,
 JDA.ShardInfo shardInfo,
 Compression compression,
 boolean validateToken,
 int intents,
 GatewayEncoding encoding)

getGateway

public String getGateway()

getShardedGateway

public SessionController.ShardedGateway getShardedGateway()

getContextMap

public ConcurrentMap<String,String> getContextMap()

setContext

public void setContext()

setToken

public void setToken(String token)

setStatus

public void setStatus(JDA.Status status)

verifyToken

public void verifyToken()

getAuthorizationConfig

public AuthorizationConfig getAuthorizationConfig()

getToken

@Nonnull
public String getToken()

Description copied from interface: JDA

The login token that is currently being used for Discord authentication.

Specified by:

getToken in interface JDA

Returns:

Never-null, 18 character length string containing the auth token.

isBulkDeleteSplittingEnabled

public boolean isBulkDeleteSplittingEnabled()

Description copied from interface: JDA

Used to determine if JDA will process MESSAGE_DELETE_BULK messages received from Discord as a single MessageBulkDeleteEvent or split the deleted messages up and fire multiple MessageDeleteEvents, one for each deleted message.

By default, 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

Specified by:

isBulkDeleteSplittingEnabled in interface JDA

Returns:

Whether or not JDA currently handles the BULK_MESSAGE_DELETE event by splitting it into individual MessageDeleteEvents or not.

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)

Description copied from interface: JDA

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

Default is true.

Specified by:

setAutoReconnect in interface JDA

Parameters:

autoReconnect - If true - enables autoReconnect

setRequestTimeoutRetry

public void setRequestTimeoutRetry(boolean retryOnTimeout)

Description copied from interface: JDA

Whether the Requester should retry when a SocketTimeoutException occurs.

Specified by:

setRequestTimeoutRetry in interface JDA

Parameters:

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

isAutoReconnect

public boolean isAutoReconnect()

Description copied from interface: JDA

Used to determine whether or not autoReconnect is enabled for JDA.

Specified by:

isAutoReconnect in interface JDA

Returns:

True if JDA will attempt to automatically reconnect when a connection-error is encountered.

getStatus

@Nonnull
public JDA.Status getStatus()

Description copied from interface: JDA

Gets the current Status of the JDA instance.

Specified by:

getStatus in interface JDA

Returns:

Current JDA status.

getGatewayIntents

@Nonnull
public EnumSet<GatewayIntent> getGatewayIntents()

Description copied from interface: JDA

The GatewayIntents for this JDA session.

Specified by:

getGatewayIntents in interface JDA

Returns:

EnumSet of active gateway intents

getCacheFlags

@Nonnull
public EnumSet<CacheFlag> getCacheFlags()

Description copied from interface: JDA

The cache flags that have been enabled for this JDA session.

Specified by:

getCacheFlags in interface JDA

Returns:

Copy of the EnumSet of cache flags for this session

unloadUser

public boolean unloadUser(long userId)

Description copied from interface: JDA

Attempts to remove the user with the provided id from the cache.
If you attempt to remove the SelfUser this will simply return false.

This should be used by an implementation of MemberCachePolicy as an upstream request to remove a member.

Specified by:

unloadUser in interface JDA

Parameters:

userId - The target user id

Returns:

True, if the cache was changed

getGatewayPing

public long getGatewayPing()

Description copied from interface: JDA

The time in milliseconds that discord took to respond to our last heartbeat
This roughly represents the WebSocket ping of this session

RestAction request times do not correlate to this value!

The GatewayPingEvent indicates an update to this value.

Specified by:

getGatewayPing in interface JDA

Returns:

time in milliseconds between heartbeat and the heartbeat ack response

See Also:

• Getting RestAction ping

awaitStatus

@Nonnull
public JDA awaitStatus(@Nonnull
 JDA.Status status,
 @Nonnull
 JDA.Status... failOn)
                throws InterruptedException

Description copied from interface: JDA

This method will block until JDA has reached the specified connection status.

Login Cycle

1. INITIALIZING
2. INITIALIZED
3. LOGGING_IN
4. CONNECTING_TO_WEBSOCKET
5. IDENTIFYING_SESSION
6. AWAITING_LOGIN_CONFIRMATION
7. LOADING_SUBSYSTEMS
8. CONNECTED

Specified by:

awaitStatus in interface JDA

Parameters:

status - The init status to wait for, once JDA has reached the specified stage of the startup cycle this method will return.

failOn - Optional failure states that will force a premature return

Returns:

The current JDA instance, for chaining convenience

Throws:

InterruptedException - If this thread is interrupted while waiting

awaitShutdown

public boolean awaitShutdown(long timeout,
 @Nonnull
 TimeUnit unit)
                      throws InterruptedException

Description copied from interface: JDA

Blocks the current thread until JDA.getStatus() returns JDA.Status.SHUTDOWN.
This can be useful in certain situations like disabling class loading.

Note that shutdown time depends on the length of the rate-limit queue. You can use JDA.shutdownNow() to cancel all pending requests and immediately shutdown.

Example

 jda.shutdown();
 // Allow at most 10 seconds for remaining requests to finish
 if (!jda.awaitShutdown(10, TimeUnit.SECONDS)) {
     jda.shutdownNow(); // Cancel all remaining requests
     jda.awaitShutdown(); // Wait until shutdown is complete (indefinitely)
 }
 

This will not implicitly call shutdown(), you are responsible to ensure that the shutdown process has started.

Specified by:

awaitShutdown in interface JDA

Parameters:

timeout - The maximum time to wait, or 0 to wait indefinitely

unit - The time unit for the duration

Returns:

False, if the timeout has elapsed before the shutdown has completed, true otherwise.

Throws:

InterruptedException - If the current thread is interrupted while waiting

cancelRequests

public int cancelRequests()

Description copied from interface: JDA

Cancels all currently scheduled RestAction requests.
When a RestAction is cancelled, a CancellationException will be provided to the failure callback. This means RestAction.queue(Consumer, Consumer) will invoke the second callback and RestAction.complete() will throw an exception.

This is only recommended as an extreme last measure to avoid backpressure. If you want to stop requests on shutdown you should use JDA.shutdownNow() instead of this method.

Specified by:

cancelRequests in interface JDA

Returns:

how many requests were cancelled

See Also:

• RestAction.setCheck(BooleanSupplier)

getRateLimitPool

@Nonnull
public ScheduledExecutorService getRateLimitPool()

Description copied from interface: JDA

ScheduledExecutorService used to handle rate-limits for RestAction executions. This is also used in other parts of JDA related to http requests.

Specified by:

getRateLimitPool in interface JDA

Returns:

The ScheduledExecutorService used for http request handling

getGatewayPool

@Nonnull
public ScheduledExecutorService getGatewayPool()

Description copied from interface: JDA

ScheduledExecutorService used to send WebSocket messages to discord.
This involves initial setup of guilds as well as keeping the connection alive.

Specified by:

getGatewayPool in interface JDA

Returns:

The ScheduledExecutorService used for WebSocket transmissions

getCallbackPool

@Nonnull
public ExecutorService getCallbackPool()

Description copied from interface: JDA

ExecutorService used to handle RestAction callbacks and completions. This is also used for handling Message.Attachment downloads when needed.
By default this uses the CommonPool of the runtime.

Specified by:

getCallbackPool in interface JDA

Returns:

The ExecutorService used for callbacks

getHttpClient

@Nonnull
public okhttp3.OkHttpClient getHttpClient()

Description copied from interface: JDA

The OkHttpClient used for handling http requests from RestActions.

Specified by:

getHttpClient in interface JDA

Returns:

The http client

getDirectAudioController

@Nonnull
public DirectAudioControllerImpl getDirectAudioController()

Description copied from interface: JDA

Direct access to audio (dis-)connect requests.
This should not be used when normal audio operation is desired.

The correct way to open and close an audio connection is through the Guild's AudioManager.

Specified by:

getDirectAudioController in interface JDA

Returns:

The DirectAudioController for this JDA instance

getMutualGuilds

@Nonnull
public List<Guild> getMutualGuilds(@Nonnull
 User... users)

Description copied from interface: JDA

Gets all Guilds that contain all given users as their members.

Specified by:

getMutualGuilds in interface JDA

Parameters:

users - The users which all the returned Guilds must contain.

Returns:

Immutable list of all Guild instances which have all Users in them.

See Also:

• Guild.isMember(UserSnowflake)

getMutualGuilds

@Nonnull
public List<Guild> getMutualGuilds(@Nonnull
 Collection<User> users)

Description copied from interface: JDA

Gets all Guilds that contain all given users as their members.

Specified by:

getMutualGuilds in interface JDA

Parameters:

users - The users which all the returned Guilds must contain.

Returns:

Immutable list of all Guild instances which have all Users in them.

retrieveUserById

@Nonnull
public CacheRestAction<User> retrieveUserById(long id)

Description copied from interface: JDA

Attempts to retrieve a User object based on the provided id.

If JDA.getUserById(long) is cached, this will directly return the user in a completed RestAction without making a request. When both GUILD_PRESENCES and GUILD_MEMBERS intents are disabled this will always make a request even if the user is cached. You can use action.useCache(false) to force an update.

The returned RestAction can encounter the following Discord errors:

• ErrorResponse.UNKNOWN_USER
  Occurs when the provided id does not refer to a User known by Discord. Typically occurs when developers provide an incomplete id (cut short).

Specified by:

retrieveUserById in interface JDA

Parameters:

id - The id of the requested User.

Returns:

CacheRestAction - Type: User
On request, gets the User with id matching provided id from Discord.

getAudioManagerCache

@Nonnull
public CacheView<AudioManager> getAudioManagerCache()

Description copied from interface: JDA

CacheView of all cached AudioManagers created for this JDA instance.
AudioManagers are created when first retrieved via Guild.getAudioManager(). Using this will perform better than calling Guild.getAudioManager() iteratively as that would cause many useless audio managers to be created!

AudioManagers are cross-session persistent!

Specified by:

getAudioManagerCache in interface JDA

Returns:

CacheView

getGuildCache

@Nonnull
public SnowflakeCacheView<Guild> getGuildCache()

Description copied from interface: JDA

SnowflakeCacheView of all cached Guilds visible to this JDA session.

Specified by:

getGuildCache in interface JDA

Returns:

SnowflakeCacheView

getUnavailableGuilds

@Nonnull
public Set<String> getUnavailableGuilds()

Description copied from interface: JDA

Set of Guild IDs for guilds that were marked unavailable by the gateway.
When a guild becomes unavailable a GuildUnavailableEvent is emitted and a GuildAvailableEvent is emitted when it becomes available again. During the time a guild is unavailable it its not reachable through cache such as JDA.getGuildById(long).

Specified by:

getUnavailableGuilds in interface JDA

Returns:

Possibly-empty set of guild IDs for unavailable guilds

isUnavailable

public boolean isUnavailable(long guildId)

Description copied from interface: JDA

Whether the guild is unavailable. If this returns true, the guild id should be in JDA.getUnavailableGuilds().

Specified by:

isUnavailable in interface JDA

Parameters:

guildId - The guild id

Returns:

True, if this guild is unavailable

getRoleCache

@Nonnull
public SnowflakeCacheView<Role> getRoleCache()

Description copied from interface: JDA

Unified SnowflakeCacheView of all cached Roles visible to this JDA session.

Specified by:

getRoleCache in interface JDA

Returns:

Unified SnowflakeCacheView

See Also:

• CacheView.allSnowflakes(...)

getEmojiCache

@Nonnull
public SnowflakeCacheView<RichCustomEmoji> getEmojiCache()

Description copied from interface: JDA

Unified SnowflakeCacheView of all cached Custom Emojis visible to this JDA session.

Specified by:

getEmojiCache in interface JDA

Returns:

Unified SnowflakeCacheView

See Also:

• CacheView.allSnowflakes(...)

createApplicationEmoji

@Nonnull
public RestAction<ApplicationEmoji> createApplicationEmoji(@Nonnull
 String name,
 @Nonnull
 Icon icon)

Description copied from interface: JDA

Creates a new ApplicationEmoji for this bot.

Note that the bot is limited to 2000 Application Emojis (normal and animated).

Specified by:

createApplicationEmoji in interface JDA

Parameters:

name - The name for the new emoji (2-32 characters)

icon - The Icon for the new emoji

Returns:

RestAction - Type: ApplicationEmoji

retrieveApplicationEmojis

@Nonnull
public RestAction<List<ApplicationEmoji>> retrieveApplicationEmojis()

Description copied from interface: JDA

Retrieves a list of Application Emojis together with their respective creators.

Specified by:

retrieveApplicationEmojis in interface JDA

Returns:

RestAction - Type: List of ApplicationEmoji

retrieveApplicationEmojiById

@Nonnull
public RestAction<ApplicationEmoji> retrieveApplicationEmojiById(@Nonnull
 String emojiId)

Description copied from interface: JDA

Retrieves an application emoji together with its respective creator.

Specified by:

retrieveApplicationEmojiById in interface JDA

Parameters:

emojiId - The emoji id

Returns:

RestAction - Type: ApplicationEmoji

retrieveSticker

@Nonnull
public RestAction<StickerUnion> retrieveSticker(@Nonnull
 StickerSnowflake sticker)

Description copied from interface: JDA

Attempts to retrieve a Sticker object based on the provided snowflake reference.
This works for both StandardSticker and GuildSticker, and you can resolve them using the provided StickerUnion.

If the sticker is not one of the supported Types, the request fails with IllegalArgumentException.

The returned RestAction can encounter the following Discord errors:

• UNKNOWN_STICKER
  Occurs when the provided id does not refer to a sticker known by Discord.

Specified by:

retrieveSticker in interface JDA

Parameters:

sticker - The reference of the requested Sticker.
Can be RichSticker, StickerItem, or Sticker.fromId(long).

Returns:

RestAction - Type: StickerUnion
On request, gets the sticker with id matching provided id from Discord.

retrieveNitroStickerPacks

@Nonnull
public RestAction<List<StickerPack>> retrieveNitroStickerPacks()

Description copied from interface: JDA

Retrieves a list of all the public StickerPacks used for nitro.

Specified by:

retrieveNitroStickerPacks in interface JDA

Returns:

RestAction - Type: List of StickerPack

getScheduledEventCache

@Nonnull
public SnowflakeCacheView<ScheduledEvent> getScheduledEventCache()

Description copied from interface: JDA

SnowflakeCacheView of all cached ScheduledEvents visible to this JDA session.

This requires CacheFlag.SCHEDULED_EVENTS to be enabled.

Specified by:

getScheduledEventCache in interface JDA

Returns:

SnowflakeCacheView

getChannelCache

@Nonnull
public ChannelCacheView<Channel> getChannelCache()

Description copied from interface: IGuildChannelContainer

Unified cache of all channels associated with this shard or guild.

This ChannelCacheView stores all channels in individually typed maps based on ChannelType. You can use ChannelCacheView.getElementById(ChannelType, long) or ChannelCacheView.ofType(Class) to filter out more specific types.

Specified by:

getChannelCache in interface IGuildChannelContainer<Channel>

Returns:

ChannelCacheView

getCategoryCache

@Nonnull
public SnowflakeCacheView<Category> getCategoryCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of Category.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getCategoryCache in interface IGuildChannelContainer<Channel>

Returns:

SortedSnowflakeCacheView

getTextChannelCache

@Nonnull
public SnowflakeCacheView<TextChannel> getTextChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of TextChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getTextChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SortedSnowflakeCacheView

getNewsChannelCache

@Nonnull
public SnowflakeCacheView<NewsChannel> getNewsChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of NewsChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getNewsChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SortedSnowflakeCacheView

getVoiceChannelCache

@Nonnull
public SnowflakeCacheView<VoiceChannel> getVoiceChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of VoiceChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getVoiceChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SortedSnowflakeCacheView

getStageChannelCache

@Nonnull
public SnowflakeCacheView<StageChannel> getStageChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of StageChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getStageChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SortedSnowflakeCacheView

getThreadChannelCache

@Nonnull
public SnowflakeCacheView<ThreadChannel> getThreadChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of ThreadChannel.

These threads can also represent posts in ForumChannels.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getThreadChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SnowflakeCacheView

getForumChannelCache

@Nonnull
public SnowflakeCacheView<ForumChannel> getForumChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of ForumChannel.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getForumChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SnowflakeCacheView

getMediaChannelCache

@Nonnull
public SnowflakeCacheView<MediaChannel> getMediaChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of MediaChannel.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getMediaChannelCache in interface IGuildChannelContainer<Channel>

Returns:

SnowflakeCacheView

getPrivateChannelCache

@Nonnull
public SnowflakeCacheView<PrivateChannel> getPrivateChannelCache()

Description copied from interface: JDA

SnowflakeCacheView of all cached PrivateChannels visible to this JDA session.

Specified by:

getPrivateChannelCache in interface JDA

Returns:

SnowflakeCacheView

getPrivateChannelById

public PrivateChannel getPrivateChannelById(@Nonnull
 String id)

Description copied from interface: JDA

This returns the PrivateChannel which has the same id as the one provided.
If there is no known PrivateChannel with an id that matches the provided one, then this returns null.

Specified by:

getPrivateChannelById in interface JDA

Parameters:

id - The id of the PrivateChannel.

Returns:

Possibly-null PrivateChannel with matching id.

getPrivateChannelById

public PrivateChannel getPrivateChannelById(long id)

Description copied from interface: JDA

This returns the PrivateChannel which has the same id as the one provided.
If there is no known PrivateChannel with an id that matches the provided one, then this returns null.

Specified by:

getPrivateChannelById in interface JDA

Parameters:

id - The id of the PrivateChannel.

Returns:

Possibly-null PrivateChannel with matching id.

getChannelById

public <T extends Channel> T getChannelById(@Nonnull
 Class<T> type,
 long id)

Description copied from interface: IGuildChannelContainer

Get a channel of the specified type by id.

This will automatically check for all channel types and cast to the specified class. If a channel with the specified id does not exist, or exists but is not an instance of the provided class, this returns null.

Specified by:

getChannelById in interface IGuildChannelContainer<Channel>

Type Parameters:

T - The type argument for the class

Parameters:

type - Class of a channel type

id - The snowflake id of the channel

Returns:

The casted channel, if it exists and is assignable to the provided class, or null

getGuildChannelById

public GuildChannel getGuildChannelById(long id)

Description copied from interface: IGuildChannelContainer

Get GuildChannel for the provided ID.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

To get more specific channel types you can use one of the following:

• IGuildChannelContainer.getChannelById(Class, long)
• IGuildChannelContainer.getTextChannelById(long)
• IGuildChannelContainer.getNewsChannelById(long)
• IGuildChannelContainer.getStageChannelById(long)
• IGuildChannelContainer.getVoiceChannelById(long)
• IGuildChannelContainer.getCategoryById(long)
• IGuildChannelContainer.getForumChannelById(long)

Specified by:

getGuildChannelById in interface IGuildChannelContainer<Channel>

Parameters:

id - The ID of the channel

Returns:

The GuildChannel or null

getGuildChannelById

public GuildChannel getGuildChannelById(@Nonnull
 ChannelType type,
 long id)

Description copied from interface: IGuildChannelContainer

Get GuildChannel for the provided ID.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().
This is meant for systems that use a dynamic ChannelType and can profit from a simple function to get the channel instance.

To get more specific channel types you can use one of the following:

• IGuildChannelContainer.getChannelById(Class, long)
• IGuildChannelContainer.getTextChannelById(long)
• IGuildChannelContainer.getNewsChannelById(long)
• IGuildChannelContainer.getStageChannelById(long)
• IGuildChannelContainer.getVoiceChannelById(long)
• IGuildChannelContainer.getCategoryById(long)
• IGuildChannelContainer.getForumChannelById(long)

Specified by:

getGuildChannelById in interface IGuildChannelContainer<Channel>

Parameters:

type - The ChannelType

id - The ID of the channel

Returns:

The GuildChannel or null

openPrivateChannelById

@Nonnull
public CacheRestAction<PrivateChannel> openPrivateChannelById(long userId)

Description copied from interface: JDA

Opens a PrivateChannel with the provided user by id.
This will fail with UNKNOWN_USER if the user does not exist.

If the channel is cached, this will directly return the channel in a completed RestAction without making a request. You can use action.useCache(false) to force an update.

Example

 public void sendMessage(JDA jda, long userId, String content) {
     jda.openPrivateChannelById(userId)
        .flatMap(channel -> channel.sendMessage(content))
        .queue();
 }
 

Specified by:

openPrivateChannelById in interface JDA

Parameters:

userId - The id of the target user

Returns:

CacheRestAction - Type: PrivateChannel

See Also:

• User.openPrivateChannel()

getUserCache

@Nonnull
public SnowflakeCacheView<User> getUserCache()

Description copied from interface: JDA

SnowflakeCacheView of all cached Users visible to this JDA session.

Specified by:

getUserCache in interface JDA

Returns:

SnowflakeCacheView

hasSelfUser

public boolean hasSelfUser()

getSelfUser

@Nonnull
public SelfUser getSelfUser()

Description copied from interface: JDA

Returns the currently logged in account represented by SelfUser.
Account settings cannot be modified using this object. If you wish to modify account settings please use the AccountManager which is accessible by SelfUser.getManager().

Specified by:

getSelfUser in interface JDA

Returns:

The currently logged in account.

shutdownNow

public void shutdownNow()

Description copied from interface: JDA

Shuts down this JDA instance instantly, closing all its connections. After this command is issued the JDA Instance can not be used anymore. This will also cancel all queued RestActions.

If you want this instance to shutdown without cancelling enqueued RestActions use shutdown()

This will interrupt the default JDA event thread, due to the gateway connection being interrupted.

Specified by:

shutdownNow in interface JDA

See Also:

• JDA.shutdown()

shutdown

public void shutdown()

Description copied from interface: JDA

Shuts down this JDA instance, closing all its connections. After this command is issued the JDA Instance can not be used anymore. Already enqueued RestActions are still going to be executed.

If you want this instance to shutdown without executing, use shutdownNow()

This will interrupt the default JDA event thread, due to the gateway connection being interrupted.

Specified by:

shutdown in interface JDA

See Also:

• JDA.shutdownNow()

shutdownInternals

public void shutdownInternals(ShutdownEvent event)

shutdownRequester

public void shutdownRequester()

getResponseTotal

public long getResponseTotal()

Description copied from interface: JDA

This value is the total amount of JSON responses that discord has sent.
This value resets every time the websocket has to perform a full reconnect (not resume).

Specified by:

getResponseTotal in interface JDA

Returns:

Never-negative long containing total response amount.

getMaxReconnectDelay

public int getMaxReconnectDelay()

Description copied from interface: JDA

This value is the maximum amount of time, in seconds, that JDA will wait between reconnect attempts.
Can be set using JDABuilder.setMaxReconnectDelay(int).

Specified by:

getMaxReconnectDelay in interface JDA

Returns:

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

getShardInfo

@Nonnull
public JDA.ShardInfo getShardInfo()

Description copied from interface: JDA

The shard information used when creating this instance of JDA.
Represents the information provided to JDABuilder.useSharding(int, int).

Specified by:

getShardInfo in interface JDA

Returns:

The shard information for this shard

getPresence

@Nonnull
public Presence getPresence()

Description copied from interface: JDA

The Presence controller for the current session.
Used to set Activity and OnlineStatus information.

Specified by:

getPresence in interface JDA

Returns:

The never-null Presence for this session.

getEventManager

@Nonnull
public IEventManager getEventManager()

Description copied from interface: JDA

The EventManager used by this JDA instance.

Specified by:

getEventManager in interface JDA

Returns:

The IEventManager

setEventManager

public void setEventManager(IEventManager eventManager)

Description copied from interface: JDA

Changes the internal EventManager.

The default EventManager is InterfacedEventListener.
There is also an AnnotatedEventManager available.

Specified by:

setEventManager in interface JDA

Parameters:

eventManager - The new EventManager to use

addEventListener

public void addEventListener(@Nonnull
 Object... listeners)

Description copied from interface: JDA

Adds all provided listeners to the event-listeners that will be used to handle events. This uses the InterfacedEventListener by default. To switch to the AnnotatedEventManager, use JDA.setEventManager(IEventManager).

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

Specified by:

addEventListener in interface JDA

Parameters:

listeners - The listener(s) which will react to events.

removeEventListener

public void removeEventListener(@Nonnull
 Object... listeners)

Description copied from interface: JDA

Removes all provided listeners from the event-listeners and no longer uses them to handle events.

Specified by:

removeEventListener in interface JDA

Parameters:

listeners - The listener(s) to be removed.

getRegisteredListeners

@Nonnull
public List<Object> getRegisteredListeners()

Description copied from interface: JDA

Immutable List of Objects that have been registered as EventListeners.

Specified by:

getRegisteredListeners in interface JDA

Returns:

List of currently registered Objects acting as EventListeners.

listenOnce

@Nonnull
public <E extends GenericEvent> Once.Builder<E> listenOnce(@Nonnull
 Class<E> eventType)

Description copied from interface: JDA

Returns a reusable builder for a one-time event listener.

Note that this method only works if the event manager is either the InterfacedEventManager or AnnotatedEventManager.
Other implementations can support it as long as they call EventListener.onEvent(GenericEvent).

Example:

Listening to a message from a channel and a user, after using a slash command:

 final Duration timeout = Duration.ofSeconds(5);
 event.reply("Reply in " + TimeFormat.RELATIVE.after(timeout) + " if you can!")
         .setEphemeral(true)
         .queue();

 event.getJDA().listenOnce(MessageReceivedEvent.class)
         .filter(messageEvent -> messageEvent.getChannel().getIdLong() == event.getChannel().getIdLong())
         .filter(messageEvent -> messageEvent.getAuthor().getIdLong() == event.getUser().getIdLong())
         .timeout(timeout, () -> {
             event.getHook().editOriginal("Timeout!").queue();
         })
         .subscribe(messageEvent -> {
             event.getHook().editOriginal("You sent: " + messageEvent.getMessage().getContentRaw()).queue();
         });
 

Specified by:

listenOnce in interface JDA

Parameters:

eventType - Type of the event to listen to

Returns:

The one-time event listener builder

retrieveCommands

@Nonnull
public RestAction<List<Command>> retrieveCommands(boolean withLocalizations)

Description copied from interface: JDA

Retrieves the list of global commands.
This list does not include guild commands! Use Guild.retrieveCommands() for guild commands.

Specified by:

retrieveCommands in interface JDA

Parameters:

withLocalizations - true if the localization data (such as name and description) should be included

Returns:

RestAction - Type: List of Command

retrieveCommandById

@Nonnull
public RestAction<Command> retrieveCommandById(@Nonnull
 String id)

Description copied from interface: JDA

Retrieves the existing Command instance by id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

retrieveCommandById in interface JDA

Parameters:

id - The command id

Returns:

RestAction - Type: Command

upsertCommand

@Nonnull
public CommandCreateAction upsertCommand(@Nonnull
 CommandData command)

Description copied from interface: JDA

Creates or updates a global command.
If a command with the same name exists, it will be replaced. This operation is idempotent. Commands will persist between restarts of your bot, you only have to create a command once.

To specify a complete list of all commands you can use JDA.updateCommands() instead.

You need the OAuth2 scope "applications.commands" in order to add commands to a guild.

Specified by:

upsertCommand in interface JDA

Parameters:

command - The CommandData for the command

Returns:

RestAction - Type: Command
The RestAction used to create or update the command

See Also:

• Commands.slash(...)
• Commands.message(...)
• Commands.user(...)
• Guild.upsertCommand(...)

updateCommands

@Nonnull
public CommandListUpdateAction updateCommands()

Description copied from interface: JDA

Configures the complete list of global commands.
This will replace the existing command list for this bot. You should only use this once on startup!

This operation is idempotent. Commands will persist between restarts of your bot, you only have to create a command once.

You need the OAuth2 scope "applications.commands" in order to add commands to a guild.

Examples

Set list to 2 commands:

 jda.updateCommands()
   .addCommands(Commands.slash("ping", "Gives the current ping"))
   .addCommands(Commands.slash("ban", "Ban the target user")
     .setGuildOnly(true)
     .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS))
     .addOption(OptionType.USER, "user", "The user to ban", true))
   .queue();
 

Delete all commands:

 jda.updateCommands().queue();
 

Specified by:

updateCommands in interface JDA

Returns:

CommandListUpdateAction

See Also:

• Guild.updateCommands()

editCommandById

@Nonnull
public CommandEditAction editCommandById(@Nonnull
 Command.Type type,
 @Nonnull
 String id)

Description copied from interface: JDA

Edit an existing global command by id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

editCommandById in interface JDA

Parameters:

type - The command type

id - The id of the command to edit

Returns:

CommandEditAction used to edit the command

deleteCommandById

@Nonnull
public RestAction<Void> deleteCommandById(@Nonnull
 String commandId)

Description copied from interface: JDA

Delete the global command for this id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

deleteCommandById in interface JDA

Parameters:

commandId - The id of the command that should be deleted

Returns:

RestAction

retrieveRoleConnectionMetadata

@Nonnull
public RestAction<List<RoleConnectionMetadata>> retrieveRoleConnectionMetadata()

Description copied from interface: JDA

Retrieves the currently configured RoleConnectionMetadata records for this application.

Specified by:

retrieveRoleConnectionMetadata in interface JDA

Returns:

RestAction - Type: List of RoleConnectionMetadata

See Also:

• Configuring App Metadata for Linked Roles

updateRoleConnectionMetadata

@Nonnull
public RestAction<List<RoleConnectionMetadata>> updateRoleConnectionMetadata(@Nonnull
 Collection<? extends RoleConnectionMetadata> records)

Description copied from interface: JDA

Updates the currently configured RoleConnectionMetadata records for this application.

Returns the updated connection metadata records on success.

Specified by:

updateRoleConnectionMetadata in interface JDA

Parameters:

records - The new records to set

Returns:

RestAction - Type: List of RoleConnectionMetadata

See Also:

• Configuring App Metadata for Linked Roles

createGuild

@Nonnull
public GuildActionImpl createGuild(@Nonnull
 String name)

Description copied from interface: JDA

Constructs a new Guild with the specified name
Use the returned GuildAction to provide further details and settings for the resulting Guild!

This RestAction does not provide the resulting Guild! It will be in a following GuildJoinEvent.

Specified by:

createGuild in interface JDA

Parameters:

name - The name of the resulting guild

Returns:

GuildAction
Allows for setting various details for the resulting Guild

createGuildFromTemplate

@Nonnull
public RestAction<Void> createGuildFromTemplate(@Nonnull
 String code,
 @Nonnull
 String name,
 Icon icon)

Description copied from interface: JDA

Constructs a new Guild from the specified template code.

This RestAction does not provide the resulting Guild! It will be in a following GuildJoinEvent.

Possible ErrorResponses include:

• Unknown Guild Template
  The template doesn't exist.

Specified by:

createGuildFromTemplate in interface JDA

Parameters:

code - The template code to use to create a guild

name - The name of the resulting guild

icon - The Icon to use, or null to use no icon

Returns:

RestAction

retrieveWebhookById

@Nonnull
public RestAction<Webhook> retrieveWebhookById(@Nonnull
 String webhookId)

Description copied from interface: JDA

Retrieves a Webhook by its id.
If the webhook does not belong to any known guild of this JDA session, it will be partial.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  We do not have the required permissions
• UNKNOWN_WEBHOOK
  A webhook with this id does not exist

Specified by:

retrieveWebhookById in interface JDA

Parameters:

webhookId - The webhook id

Returns:

RestAction - Type: Webhook
The webhook object.

See Also:

• Guild.retrieveWebhooks()
• IWebhookContainer.retrieveWebhooks()

getApplicationManager

@Nonnull
public ApplicationManager getApplicationManager()

Description copied from interface: JDA

Returns the ApplicationManager that manages the application associated with the bot.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

getApplicationManager in interface JDA

Returns:

The corresponding ApplicationManager

retrieveApplicationInfo

@Nonnull
public RestAction<ApplicationInfo> retrieveApplicationInfo()

Description copied from interface: JDA

Retrieves the ApplicationInfo for the application that owns the logged in Bot-Account.
This contains information about the owner of the currently logged in bot account!

Specified by:

retrieveApplicationInfo in interface JDA

Returns:

RestAction - Type: ApplicationInfo
The ApplicationInfo of the bot's application.

retrieveEntitlements

@Nonnull
public EntitlementPaginationAction retrieveEntitlements()

Description copied from interface: JDA

A PaginationAction implementation which allows you to iterate over Entitlements that are applicable to the logged in application.

Specified by:

retrieveEntitlements in interface JDA

Returns:

EntitlementPaginationAction

retrieveEntitlementById

@Nonnull
public RestAction<Entitlement> retrieveEntitlementById(long entitlementId)

Description copied from interface: JDA

Retrieves an Entitlement by its id.

Specified by:

retrieveEntitlementById in interface JDA

Parameters:

entitlementId - The id of the entitlement to retrieve

Returns:

RestAction - Type: Entitlement
The entitlement with the provided id

createTestEntitlement

@Nonnull
public TestEntitlementCreateAction createTestEntitlement(long skuId,
 long ownerId,
 @Nonnull
 TestEntitlementCreateAction.OwnerType ownerType)

Description copied from interface: JDA

Constructs a new Entitlement with the skuId and the type.
Use the returned TestEntitlementCreateAction to provide more details.

Specified by:

createTestEntitlement in interface JDA

Parameters:

skuId - The id of the SKU the entitlement is for

ownerId - The id of the owner of the entitlement

ownerType - The type of the owner of the entitlement

Returns:

TestEntitlementCreateAction
Allows for setting various details for the resulting Entitlement

deleteTestEntitlement

@Nonnull
public RestAction<Void> deleteTestEntitlement(long entitlementId)

Description copied from interface: JDA

Deletes a test entitlement by its id.

Specified by:

deleteTestEntitlement in interface JDA

Parameters:

entitlementId - The id of the entitlement to delete

Returns:

RestAction - Type: Void

setRequiredScopes

@Nonnull
public JDA setRequiredScopes(@Nonnull
 Collection<String> scopes)

Description copied from interface: JDA

Configures the required scopes applied to the JDA.getInviteUrl(Permission...) and similar methods.
To use slash commands you must add "applications.commands" to these scopes. The scope "bot" is always applied.

Specified by:

setRequiredScopes in interface JDA

Parameters:

scopes - The scopes to use with JDA.getInviteUrl(Permission...) and the likes

Returns:

The current JDA instance

getInviteUrl

@Nonnull
public String getInviteUrl(Permission... permissions)

Description copied from interface: JDA

Creates an authorization invite url for the currently logged in Bot-Account.
Example Format: https://discord.com/oauth2/authorize?scope=bot&client_id=288202953599221761&permissions=8

Hint: To enable a pre-selected Guild of choice append the parameter &guild_id=YOUR_GUILD_ID

Specified by:

getInviteUrl in interface JDA

Parameters:

permissions - The permissions to use in your invite, these can be changed by the link user.
If no permissions are provided the permissions parameter is omitted

Returns:

A valid OAuth2 invite url for the currently logged in Bot-Account

getInviteUrl

@Nonnull
public String getInviteUrl(Collection<Permission> permissions)

Description copied from interface: JDA

Creates an authorization invite url for the currently logged in Bot-Account.
Example Format: https://discord.com/oauth2/authorize?scope=bot&client_id=288202953599221761&permissions=8

Hint: To enable a pre-selected Guild of choice append the parameter &guild_id=YOUR_GUILD_ID

Specified by:

getInviteUrl in interface JDA

Parameters:

permissions - The permissions to use in your invite, these can be changed by the link user.
If no permissions are provided the permissions parameter is omitted

Returns:

A valid OAuth2 invite url for the currently logged in Bot-Account

setShardManager

public void setShardManager(ShardManager shardManager)

getShardManager

public ShardManager getShardManager()

Description copied from interface: JDA

Returns the ShardManager that manages this JDA instances or null if this instance is not managed by any ShardManager.

Specified by:

getShardManager in interface JDA

Returns:

The corresponding ShardManager or null if there is no such manager

getEntityBuilder

public EntityBuilder getEntityBuilder()

getAudioSendFactory

public IAudioSendFactory getAudioSendFactory()

setAudioSendFactory

public void setAudioSendFactory(IAudioSendFactory factory)

setGatewayPing

public void setGatewayPing(long ping)

getRequester

public Requester getRequester()

getWebSocketFactory

public WebSocketFactory getWebSocketFactory()

getClient

public WebSocketClient getClient()

getUsersView

public SnowflakeCacheViewImpl<User> getUsersView()

getGuildsView

public SnowflakeCacheViewImpl<Guild> getGuildsView()

getChannelsView

public ChannelCacheViewImpl<Channel> getChannelsView()

getAudioManagersView

public AbstractCacheView<AudioManager> getAudioManagersView()

setSelfUser

public void setSelfUser(SelfUser selfUser)

setResponseTotal

public void setResponseTotal(int responseTotal)

getIdentifierString

public String getIdentifierString()

getEventCache

public EventCache getEventCache()

getGatewayUrl

public String getGatewayUrl()

resetGatewayUrl

public void resetGatewayUrl()

getAudioLifeCyclePool

public ScheduledExecutorService getAudioLifeCyclePool()