Package net.dv8tion.jda.api

Interface JDA

public interface JDA

The core of JDA. Acts as a registry system of JDA. All parts of the the API can be accessed starting from this class.

See Also:

JDABuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JDA.ShardInfo	Represents the information used to create this shard.
static class	JDA.Status	Represents the connection status of JDA and its Main WebSocket.

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.
default JDA	awaitReady()	This method will block until JDA has reached the status JDA.Status.CONNECTED.
JDA	awaitStatus(JDA.Status status)	This method will block until JDA has reached the specified connection status.
GuildAction	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!
AccountType	getAccountType()	The AccountType of the currently logged in account.
CacheView<AudioManager>	getAudioManagerCache()	CacheView of all cached AudioManagers created for this JDA instance.
default List<AudioManager>	getAudioManagers()	Immutable list of all created AudioManagers for this JDA instance!
ExecutorService	getCallbackPool()	ExecutorService used to handle RestAction callbacks and completions.
default List<Category>	getCategories()	Gets all Categories visible to the currently logged in account.
default List<Category>	getCategoriesByName(String name, boolean ignoreCase)	Gets a list of all Categories that have the same name as the one provided.
default Category	getCategoryById(long id)	Gets the Category that matches the provided id.
default Category	getCategoryById(String id)	Gets the Category that matches the provided id.
SnowflakeCacheView<Category>	getCategoryCache()	SnowflakeCacheView of all cached Categories visible to this JDA session.
DirectAudioController	getDirectAudioController()	Direct access to audio (dis-)connect requests.
default Emote	getEmoteById(long id)	Retrieves an emote matching the specified id if one is available in our cache.
default Emote	getEmoteById(String id)	Retrieves an emote matching the specified id if one is available in our cache.
SnowflakeCacheView<Emote>	getEmoteCache()	Unified SnowflakeCacheView of all cached Emotes visible to this JDA session.
default List<Emote>	getEmotes()	A collection of all to us known emotes (managed/restricted included).
default List<Emote>	getEmotesByName(String name, boolean ignoreCase)	An unmodifiable list of all Emotes that have the same name as the one provided.
IEventManager	getEventManager()	The EventManager used by this JDA instance.
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.
default Guild	getGuildById(long id)	This returns the Guild which has the same id as the one provided.
default Guild	getGuildById(String id)	This returns the Guild which has the same id as the one provided.
SnowflakeCacheView<Guild>	getGuildCache()	SnowflakeCacheView of all cached Guilds visible to this JDA session.
default GuildChannel	getGuildChannelById(long id)	Get GuildChannel for the provided ID.
default GuildChannel	getGuildChannelById(String id)	Get GuildChannel for the provided ID.
default GuildChannel	getGuildChannelById(ChannelType type, long id)	Get GuildChannel for the provided ID.
default GuildChannel	getGuildChannelById(ChannelType type, String id)	Get GuildChannel for the provided ID.
default List<Guild>	getGuilds()	An immutable List of all Guilds that the logged account is connected to.
default List<Guild>	getGuildsByName(String name, boolean ignoreCase)	An immutable list of all Guilds that have the same name as the one provided.
OkHttpClient	getHttpClient()	The OkHttpClient used for handling http requests from RestActions.
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	getMaxReconnectDelay()	This value is the maximum amount of time, in seconds, that JDA will wait between reconnect attempts.
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.
Presence	getPresence()	The Presence controller for the current session.
default PrivateChannel	getPrivateChannelById(long id)	This returns the PrivateChannel which has the same id as the one provided.
default 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.
default List<PrivateChannel>	getPrivateChannels()	An unmodifiable list of all known PrivateChannels.
ScheduledExecutorService	getRateLimitPool()	ScheduledExecutorService used to handle rate-limits for RestAction executions.
List<Object>	getRegisteredListeners()	Immutable List of Objects that have been registered as EventListeners.
long	getResponseTotal()	This value is the total amount of JSON responses that discord has sent.
default RestAction<Long>	getRestPing()	The time in milliseconds that discord took to respond to a REST request.
default Role	getRoleById(long id)	Retrieves the Role associated to the provided id.
default Role	getRoleById(String id)	Retrieves the Role associated to the provided id.
SnowflakeCacheView<Role>	getRoleCache()	Unified SnowflakeCacheView of all cached Roles visible to this JDA session.
default List<Role>	getRoles()	All Roles this JDA instance can see.
default List<Role>	getRolesByName(String name, boolean ignoreCase)	Retrieves all Roles visible to this JDA instance.
SelfUser	getSelfUser()	Returns the currently logged in account represented by SelfUser.
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.
JDA.Status	getStatus()	Gets the current Status of the JDA instance.
default StoreChannel	getStoreChannelById(long id)	Gets a StoreChannel that has the same id as the one provided.
default StoreChannel	getStoreChannelById(String id)	Gets a StoreChannel that has the same id as the one provided.
SnowflakeCacheView<StoreChannel>	getStoreChannelCache()	SnowflakeCacheView of all cached StoreChannels visible to this JDA session.
default List<StoreChannel>	getStoreChannels()	Gets all StoreChannels of all connected Guilds.
default List<StoreChannel>	getStoreChannelsByName(String name, boolean ignoreCase)	An unmodifiable list of all StoreChannels that have the same name as the one provided.
default TextChannel	getTextChannelById(long id)	This returns the TextChannel which has the same id as the one provided.
default TextChannel	getTextChannelById(String id)	This returns the TextChannel which has the same id as the one provided.
SnowflakeCacheView<TextChannel>	getTextChannelCache()	SnowflakeCacheView of all cached TextChannels visible to this JDA session.
default List<TextChannel>	getTextChannels()	An unmodifiable List of all TextChannels of all connected Guilds.
default List<TextChannel>	getTextChannelsByName(String name, boolean ignoreCase)	An unmodifiable list of all TextChannels that have the same name as the one provided.
String	getToken()	The login token that is currently being used for Discord authentication.
default User	getUserById(long id)	This returns the User which has the same id as the one provided.
default User	getUserById(String id)	This returns the User which has the same id as the one provided.
default User	getUserByTag(String tag)	Searches for a user that has the matching Discord Tag.
default User	getUserByTag(String username, String discriminator)	Searches for a user that has the matching Discord Tag.
SnowflakeCacheView<User>	getUserCache()	SnowflakeCacheView of all cached Users visible to this JDA session.
default List<User>	getUsers()	An immutable list of all Users that share a Guild with the currently logged in account.
default List<User>	getUsersByName(String name, boolean ignoreCase)	This immutable returns all Users that have the same username as the one provided.
default VoiceChannel	getVoiceChannelById(long id)	This returns the VoiceChannel which has the same id as the one provided.
default VoiceChannel	getVoiceChannelById(String id)	This returns the VoiceChannel which has the same id as the one provided.
default List<VoiceChannel>	getVoiceChannelByName(String name, boolean ignoreCase)	Deprecated. Replace with getVoiceChannelsByName(String, boolean)
SnowflakeCacheView<VoiceChannel>	getVoiceChannelCache()	SnowflakeCacheView of all cached VoiceChannels visible to this JDA session.
default List<VoiceChannel>	getVoiceChannels()	An unmodifiable list of all VoiceChannels of all connected Guilds.
default List<VoiceChannel>	getVoiceChannelsByName(String name, boolean ignoreCase)	An unmodifiable list of all VoiceChannels that have the same name as the one provided.
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.
void	removeEventListener(Object... listeners)	Removes all provided listeners from the event-listeners and no longer uses them to handle events.
RestAction<ApplicationInfo>	retrieveApplicationInfo()	Retrieves the ApplicationInfo for the application that owns the logged in Bot-Account.
RestAction<User>	retrieveUserById(long id)	Attempts to retrieve a User object based on the provided id.
RestAction<User>	retrieveUserById(String id)	Attempts to retrieve a User object based on the provided id.
default RestAction<Webhook>	retrieveWebhookById(long webhookId)	Retrieves a Webhook by its id.
RestAction<Webhook>	retrieveWebhookById(String webhookId)	Retrieves a Webhook by its id.
void	setAutoReconnect(boolean reconnect)	Sets whether or not JDA should try to automatically reconnect if a connection-error is encountered.
void	setEventManager(IEventManager manager)	Changes the internal EventManager.
void	setRequestTimeoutRetry(boolean retryOnTimeout)	Whether the Requester should retry when a SocketTimeoutException occurs.
void	shutdown()	Shuts down this JDA instance, closing all its connections.
void	shutdownNow()	Shuts down this JDA instance instantly, closing all its connections.

Method Detail

getStatus

@Nonnull
JDA.Status getStatus()

Gets the current Status of the JDA instance.

Returns:

Current JDA status.

getGatewayPing

long getGatewayPing()

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.

Returns:

time in milliseconds between heartbeat and the heartbeat ack response

See Also:

Getting RestAction ping

getRestPing

@Nonnull
default RestAction<Long> getRestPing()

The time in milliseconds that discord took to respond to a REST request.
This will request the current user from the API and calculate the time the response took.

Example

 jda.getRestPing().queue( (time) ->
     channel.sendMessageFormat("Ping: %d ms", time).queue()
 );
 

Returns:

RestAction - Type: long

Since:

4.0.0

See Also:

getGatewayPing()

awaitStatus

@Nonnull
JDA awaitStatus(@Nonnull
                JDA.Status status)
         throws InterruptedException

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

Parameters:

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

Returns:

The current JDA instance, for chaining convenience

Throws:

InterruptedException - If this thread is interrupted while waiting

IllegalArgumentException - If the provided status is null or not an init status (JDA.Status.isInit())

IllegalStateException - If JDA is shutdown during this wait period

awaitReady

@Nonnull
default JDA awaitReady()
                throws InterruptedException

This method will block until JDA has reached the status JDA.Status.CONNECTED.
This status means that JDA finished setting up its internal cache and is ready to be used.

Returns:

The current JDA instance, for chaining convenience

Throws:

InterruptedException - If this thread is interrupted while waiting

IllegalStateException - If JDA is shutdown during this wait period

getRateLimitPool

@Nonnull
ScheduledExecutorService getRateLimitPool()

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

Returns:

The ScheduledExecutorService used for http request handling

Since:

4.0.0

getGatewayPool

@Nonnull
ScheduledExecutorService getGatewayPool()

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

Returns:

The ScheduledExecutorService used for WebSocket transmissions

Since:

4.0.0

getCallbackPool

@Nonnull
ExecutorService getCallbackPool()

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.

Returns:

The ExecutorService used for callbacks

Since:

4.0.0

getHttpClient

@Nonnull
OkHttpClient getHttpClient()

The OkHttpClient used for handling http requests from RestActions.

Returns:

The http client

Since:

4.0.0

getDirectAudioController

@Nonnull
DirectAudioController getDirectAudioController()

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.

Returns:

The DirectAudioController for this JDA instance

Since:

4.0.0

setEventManager

void setEventManager(@Nullable
                     IEventManager manager)

Changes the internal EventManager.

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

Parameters:

manager - The new EventManager to use

addEventListener

void addEventListener(@Nonnull
                      Object... listeners)

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 setEventManager(IEventManager). Note: when using the InterfacedEventListener (default), given listener must be instance of EventListener!

Parameters:

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

Throws:

IllegalArgumentException - If either listeners or one of it's objects is null.

removeEventListener

void removeEventListener(@Nonnull
                         Object... listeners)

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

Parameters:

listeners - The listener(s) to be removed.

Throws:

IllegalArgumentException - If either listeners or one of it's objects is null.

getRegisteredListeners

@Nonnull
List<Object> getRegisteredListeners()

Immutable List of Objects that have been registered as EventListeners.

Returns:

List of currently registered Objects acting as EventListeners.

createGuild

@Nonnull
@CheckReturnValue
GuildAction createGuild(@Nonnull
                        String name)

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.

Parameters:

name - The name of the resulting guild

Returns:

GuildAction
Allows for setting various details for the resulting Guild

Throws:

IllegalStateException - If the currently logged in account is from

• AccountType.CLIENT and the account is in 100 or more guilds
• AccountType.BOT and the account is in 10 or more guilds

IllegalArgumentException - If the provided name is empty, null or not between 2-100 characters

getAudioManagerCache

@Nonnull
CacheView<AudioManager> getAudioManagerCache()

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!

Returns:

CacheView

getAudioManagers

@Nonnull
default List<AudioManager> getAudioManagers()

Immutable list of all created AudioManagers for this JDA instance!

Returns:

Immutable list of all created AudioManager instances

getUserCache

@Nonnull
SnowflakeCacheView<User> getUserCache()

SnowflakeCacheView of all cached Users visible to this JDA session.

Returns:

SnowflakeCacheView

getUsers

@Nonnull
default List<User> getUsers()

An immutable list of all Users that share a Guild with the currently logged in account.
This list will never contain duplicates and represents all Users that JDA can currently see.

If the developer is sharding, then only users from guilds connected to the specifically logged in shard will be returned in the List.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getUserCache() and use its more efficient versions of handling these values.

Returns:

Immutable list of all Users that are visible to JDA.

getUserById

@Nullable
default User getUserById(@Nonnull
                         String id)

This returns the User which has the same id as the one provided.
If there is no visible user with an id that matches the provided one, this returns null.

Parameters:

id - The id of the requested User.

Returns:

Possibly-null User with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getUserById

@Nullable
default User getUserById(long id)

This returns the User which has the same id as the one provided.
If there is no visible user with an id that matches the provided one, this returns null.

Parameters:

id - The id of the requested User.

Returns:

Possibly-null User with matching id.

getUserByTag

@Nullable
default User getUserByTag(@Nonnull
                          String tag)

Searches for a user that has the matching Discord Tag.
Format has to be in the form Username#Discriminator where the username must be between 2 and 32 characters (inclusive) matching the exact casing and the discriminator must be exactly 4 digits.

This only checks users that are known to the currently logged in account (shard). If a user exists with the tag that is not available in the User-Cache it will not be detected.
Currently Discord does not offer a way to retrieve a user by their discord tag.

Parameters:

tag - The Discord Tag in the format Username#Discriminator

Returns:

The User for the discord tag or null if no user has the provided tag

Throws:

IllegalArgumentException - If the provided tag is null or not in the described format

getUserByTag

@Nullable
default User getUserByTag(@Nonnull
                          String username,
                          @Nonnull
                          String discriminator)

Searches for a user that has the matching Discord Tag.
Format has to be in the form Username#Discriminator where the username must be between 2 and 32 characters (inclusive) matching the exact casing and the discriminator must be exactly 4 digits.

This only checks users that are known to the currently logged in account (shard). If a user exists with the tag that is not available in the User-Cache it will not be detected.
Currently Discord does not offer a way to retrieve a user by their discord tag.

Parameters:

username - The name of the user

discriminator - The discriminator of the user

Returns:

The User for the discord tag or null if no user has the provided tag

Throws:

IllegalArgumentException - If the provided arguments are null or not in the described format

getUsersByName

@Nonnull
default List<User> getUsersByName(@Nonnull
                                  String name,
                                  boolean ignoreCase)

This immutable returns all Users that have the same username as the one provided.
If there are no Users with the provided name, then this returns an empty list.

Note: This does **not** consider nicknames, it only considers User.getName()

Parameters:

name - The name of the requested Users.

ignoreCase - Whether to ignore case or not when comparing the provided name to each User.getName().

Returns:

Possibly-empty immutable list of Users that all have the same name as the provided name.

getMutualGuilds

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

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

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(net.dv8tion.jda.api.entities.User)

getMutualGuilds

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

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

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
@CheckReturnValue
RestAction<User> retrieveUserById(@Nonnull
                                  String id)

Attempts to retrieve a User object based on the provided id.
This first calls getUserById(long), and if the return is null then a request is made to the Discord servers.

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).

Parameters:

id - The id of the requested User.

Returns:

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

Throws:

AccountTypeException - This endpoint is AccountType.BOT only.

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

IllegalArgumentException -

• If the provided id String is null.
• If the provided id String is empty.

retrieveUserById

@Nonnull
@CheckReturnValue
RestAction<User> retrieveUserById(long id)

Attempts to retrieve a User object based on the provided id.
This first calls getUserById(long), and if the return is null then a request is made to the Discord servers.

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).

Parameters:

id - The id of the requested User.

Returns:

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

Throws:

AccountTypeException - This endpoint is AccountType.BOT only.

getGuildCache

@Nonnull
SnowflakeCacheView<Guild> getGuildCache()

SnowflakeCacheView of all cached Guilds visible to this JDA session.

Returns:

SnowflakeCacheView

getGuilds

@Nonnull
default List<Guild> getGuilds()

An immutable List of all Guilds that the logged account is connected to.
If this account is not connected to any Guilds, this will return an empty list.

If the developer is sharding (JDABuilder.useSharding(int, int), then this list will only contain the Guilds that the shard is actually connected to. Discord determines which guilds a shard is connect to using the following format:
Guild connected if shardId == (guildId >> 22) % totalShards;
Source for formula: Discord Documentation

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getGuildCache() and use its more efficient versions of handling these values.

Returns:

Possibly-empty immutable list of all the Guilds that this account is connected to.

getGuildById

@Nullable
default Guild getGuildById(@Nonnull
                           String id)

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

Parameters:

id - The id of the Guild.

Returns:

Possibly-null Guild with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getGuildById

@Nullable
default Guild getGuildById(long id)

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

Parameters:

id - The id of the Guild.

Returns:

Possibly-null Guild with matching id.

getGuildsByName

@Nonnull
default List<Guild> getGuildsByName(@Nonnull
                                    String name,
                                    boolean ignoreCase)

An immutable list of all Guilds that have the same name as the one provided.
If there are no Guilds with the provided name, then this returns an empty list.

Parameters:

name - The name of the requested Guilds.

ignoreCase - Whether to ignore case or not when comparing the provided name to each Guild.getName().

Returns:

Possibly-empty immutable list of all the Guilds that all have the same name as the provided name.

getRoleCache

@Nonnull
SnowflakeCacheView<Role> getRoleCache()

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

Returns:

Unified SnowflakeCacheView

See Also:

CacheView.allSnowflakes(...)

getRoles

@Nonnull
default List<Role> getRoles()

All Roles this JDA instance can see.
This will iterate over each Guild retrieved from getGuilds() and collect its Guild.getRoles().

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getRoleCache() and use its more efficient versions of handling these values.

Returns:

Immutable List of all visible Roles

getRoleById

@Nullable
default Role getRoleById(@Nonnull
                         String id)

Retrieves the Role associated to the provided id.
This iterates over all Guilds and check whether a Role from that Guild is assigned to the specified ID and will return the first that can be found.

Parameters:

id - The id of the searched Role

Returns:

Possibly-null Role for the specified ID

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getRoleById

@Nullable
default Role getRoleById(long id)

Retrieves the Role associated to the provided id.
This iterates over all Guilds and check whether a Role from that Guild is assigned to the specified ID and will return the first that can be found.

Parameters:

id - The id of the searched Role

Returns:

Possibly-null Role for the specified ID

getRolesByName

@Nonnull
default List<Role> getRolesByName(@Nonnull
                                  String name,
                                  boolean ignoreCase)

Retrieves all Roles visible to this JDA instance.
This simply filters the Roles returned by getRoles() with the provided name, either using String.equals(Object) or String.equalsIgnoreCase(String) on Role.getName().

Parameters:

name - The name for the Roles

ignoreCase - Whether to use String.equalsIgnoreCase(String)

Returns:

Immutable List of all Roles matching the parameters provided.

getGuildChannelById

@Nullable
default GuildChannel getGuildChannelById(@Nonnull
                                         String id)

Get GuildChannel for the provided ID.
This checks if any of the channel types in this guild have the provided ID and returns the first match.
To get more specific channel types you can use one of the following:

• getTextChannelById(String)
• getVoiceChannelById(String)
• getStoreChannelById(String)
• getCategoryById(String)

Parameters:

id - The ID of the channel

Returns:

The GuildChannel or null

Throws:

IllegalArgumentException - If the provided ID is null

NumberFormatException - If the provided ID is not a snowflake

getGuildChannelById

@Nullable
default GuildChannel getGuildChannelById(long id)

Get GuildChannel for the provided ID.
This checks if any of the channel types in this guild have the provided ID and returns the first match.
To get more specific channel types you can use one of the following:

• getTextChannelById(long)
• getVoiceChannelById(long)
• getStoreChannelById(long)
• getCategoryById(long)

Parameters:

id - The ID of the channel

Returns:

The GuildChannel or null

getGuildChannelById

@Nullable
default GuildChannel getGuildChannelById(@Nonnull
                                         ChannelType type,
                                         @Nonnull
                                         String id)

Get GuildChannel for the provided ID.
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:

• getTextChannelById(String)
• getVoiceChannelById(String)
• getStoreChannelById(String)
• getCategoryById(String)

Parameters:

type - The ChannelType

id - The ID of the channel

Returns:

The GuildChannel or null

Throws:

IllegalArgumentException - If the provided ID is null

NumberFormatException - If the provided ID is not a snowflake

getGuildChannelById

@Nullable
default GuildChannel getGuildChannelById(@Nonnull
                                         ChannelType type,
                                         long id)

Get GuildChannel for the provided ID.
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:

• getTextChannelById(long)
• getVoiceChannelById(long)
• getStoreChannelById(long)
• getCategoryById(long)

Parameters:

type - The ChannelType

id - The ID of the channel

Returns:

The GuildChannel or null

getCategoryCache

@Nonnull
SnowflakeCacheView<Category> getCategoryCache()

SnowflakeCacheView of all cached Categories visible to this JDA session.

Returns:

SnowflakeCacheView

getCategoryById

@Nullable
default Category getCategoryById(@Nonnull
                                 String id)

Gets the Category that matches the provided id.
If there is no matching Category this returns null.

Parameters:

id - The snowflake ID of the wanted Category

Returns:

Possibly-null Category for the provided ID.

Throws:

IllegalArgumentException - If the provided ID is not a valid long

getCategoryById

@Nullable
default Category getCategoryById(long id)

Gets the Category that matches the provided id.
If there is no matching Category this returns null.

Parameters:

id - The snowflake ID of the wanted Category

Returns:

Possibly-null Category for the provided ID.

getCategories

@Nonnull
default List<Category> getCategories()

Gets all Categories visible to the currently logged in account.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getCategoryCache() and use its more efficient versions of handling these values.

Returns:

An immutable list of all visible Categories.

getCategoriesByName

@Nonnull
default List<Category> getCategoriesByName(@Nonnull
                                           String name,
                                           boolean ignoreCase)

Gets a list of all Categories that have the same name as the one provided.
If there are no matching categories this will return an empty list.

Parameters:

name - The name to check

ignoreCase - Whether to ignore case on name checking

Returns:

Immutable list of all categories matching the provided name

Throws:

IllegalArgumentException - If the provided name is null

getStoreChannelCache

@Nonnull
SnowflakeCacheView<StoreChannel> getStoreChannelCache()

SnowflakeCacheView of all cached StoreChannels visible to this JDA session.
TextChannels are sorted according to their position.

Returns:

SnowflakeCacheView

getStoreChannelById

@Nullable
default StoreChannel getStoreChannelById(@Nonnull
                                         String id)

Gets a StoreChannel that has the same id as the one provided.
If there is no StoreChannel with an id that matches the provided one, then this returns null.

Parameters:

id - The id of the StoreChannel.

Returns:

Possibly-null StoreChannel with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getStoreChannelById

@Nullable
default StoreChannel getStoreChannelById(long id)

Gets a StoreChannel that has the same id as the one provided.
If there is no StoreChannel with an id that matches the provided one, then this returns null.

Parameters:

id - The id of the StoreChannel.

Returns:

Possibly-null StoreChannel with matching id.

getStoreChannels

@Nonnull
default List<StoreChannel> getStoreChannels()

Gets all StoreChannels of all connected Guilds.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getStoreChannelCache() and use its more efficient versions of handling these values.

Returns:

Possibly-empty immutable List of all known StoreChannel.

getStoreChannelsByName

@Nonnull
default List<StoreChannel> getStoreChannelsByName(@Nonnull
                                                  String name,
                                                  boolean ignoreCase)

An unmodifiable list of all StoreChannels that have the same name as the one provided.
If there are no StoreChannels with the provided name, then this returns an empty list.

Parameters:

name - The name used to filter the returned StoreChannels.

ignoreCase - Determines if the comparison ignores case when comparing. True - case insensitive.

Returns:

Possibly-empty immutable list of all StoreChannels with names that match the provided name.

getTextChannelCache

@Nonnull
SnowflakeCacheView<TextChannel> getTextChannelCache()

SnowflakeCacheView of all cached TextChannels visible to this JDA session.

Returns:

SnowflakeCacheView

getTextChannels

@Nonnull
default List<TextChannel> getTextChannels()

An unmodifiable List of all TextChannels of all connected Guilds.

Note: just because a TextChannel is present in this list does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is possible that you will see fewer channels than this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getTextChannelCache() and use its more efficient versions of handling these values.

Returns:

Possibly-empty list of all known TextChannels.

getTextChannelById

@Nullable
default TextChannel getTextChannelById(@Nonnull
                                       String id)

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

Note: just because a TextChannel is present does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is you will not see the channel that this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.

Parameters:

id - The id of the TextChannel.

Returns:

Possibly-null TextChannel with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getTextChannelById

@Nullable
default TextChannel getTextChannelById(long id)

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

Note: just because a TextChannel is present does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is you will not see the channel that this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.

Parameters:

id - The id of the TextChannel.

Returns:

Possibly-null TextChannel with matching id.

getTextChannelsByName

@Nonnull
default List<TextChannel> getTextChannelsByName(@Nonnull
                                                String name,
                                                boolean ignoreCase)

An unmodifiable list of all TextChannels that have the same name as the one provided.
If there are no TextChannels with the provided name, then this returns an empty list.

Note: just because a TextChannel is present in this list does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is possible that you will see fewer channels than this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.

Parameters:

name - The name of the requested TextChannels.

ignoreCase - Whether to ignore case or not when comparing the provided name to each GuildChannel.getName().

Returns:

Possibly-empty list of all the TextChannels that all have the same name as the provided name.

getVoiceChannelCache

@Nonnull
SnowflakeCacheView<VoiceChannel> getVoiceChannelCache()

SnowflakeCacheView of all cached VoiceChannels visible to this JDA session.

Returns:

SnowflakeCacheView

getVoiceChannels

@Nonnull
default List<VoiceChannel> getVoiceChannels()

An unmodifiable list of all VoiceChannels of all connected Guilds.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getVoiceChannelCache() and use its more efficient versions of handling these values.

Returns:

Possible-empty list of all known VoiceChannels.

getVoiceChannelById

@Nullable
default VoiceChannel getVoiceChannelById(@Nonnull
                                         String id)

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

Parameters:

id - The id of the VoiceChannel.

Returns:

Possibly-null VoiceChannel with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getVoiceChannelById

@Nullable
default VoiceChannel getVoiceChannelById(long id)

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

Parameters:

id - The id of the VoiceChannel.

Returns:

Possibly-null VoiceChannel with matching id.

getVoiceChannelByName

@Nonnull
@Deprecated
@ForRemoval
@DeprecatedSince("4.0.0")
@ReplaceWith("jda.getVoiceChannelsByName(name, ignoreCase)")
default List<VoiceChannel> getVoiceChannelByName(@Nonnull
                                                 String name,
                                                 boolean ignoreCase)

Deprecated.

Replace with getVoiceChannelsByName(String, boolean)

An unmodifiable list of all VoiceChannels that have the same name as the one provided.
If there are no VoiceChannels with the provided name, then this returns an empty list.

Parameters:

name - The name of the requested VoiceChannels.

ignoreCase - Whether to ignore case or not when comparing the provided name to each GuildChannel.getName().

Returns:

Possibly-empty list of all the VoiceChannels that all have the same name as the provided name.

getVoiceChannelsByName

@Nonnull
default List<VoiceChannel> getVoiceChannelsByName(@Nonnull
                                                  String name,
                                                  boolean ignoreCase)

An unmodifiable list of all VoiceChannels that have the same name as the one provided.
If there are no VoiceChannels with the provided name, then this returns an empty list.

Parameters:

name - The name of the requested VoiceChannels.

ignoreCase - Whether to ignore case or not when comparing the provided name to each GuildChannel.getName().

Returns:

Possibly-empty list of all the VoiceChannels that all have the same name as the provided name.

getPrivateChannelCache

@Nonnull
SnowflakeCacheView<PrivateChannel> getPrivateChannelCache()

SnowflakeCacheView of all cached PrivateChannels visible to this JDA session.

Returns:

SnowflakeCacheView

getPrivateChannels

@Nonnull
default List<PrivateChannel> getPrivateChannels()

An unmodifiable list of all known PrivateChannels.

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getPrivateChannelCache() and use its more efficient versions of handling these values.

Returns:

Possibly-empty list of all PrivateChannels.

getPrivateChannelById

@Nullable
default PrivateChannel getPrivateChannelById(@Nonnull
                                             String id)

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.

Parameters:

id - The id of the PrivateChannel.

Returns:

Possibly-null PrivateChannel with matching id.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getPrivateChannelById

@Nullable
default PrivateChannel getPrivateChannelById(long id)

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.

Parameters:

id - The id of the PrivateChannel.

Returns:

Possibly-null PrivateChannel with matching id.

getEmoteCache

@Nonnull
SnowflakeCacheView<Emote> getEmoteCache()

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

Returns:

Unified SnowflakeCacheView

See Also:

CacheView.allSnowflakes(...)

getEmotes

@Nonnull
default List<Emote> getEmotes()

A collection of all to us known emotes (managed/restricted included).
This will be empty if CacheFlag.EMOTE is disabled.

Hint: To check whether you can use an Emote in a specific context you can use Emote.canInteract(net.dv8tion.jda.api.entities.Member) or Emote.canInteract(net.dv8tion.jda.api.entities.User, net.dv8tion.jda.api.entities.MessageChannel)

Unicode emojis are not included as Emote!

This copies the backing store into a list. This means every call creates a new list with O(n) complexity. It is recommended to store this into a local variable or use getEmoteCache() and use its more efficient versions of handling these values.

Returns:

An immutable list of Emotes (which may or may not be available to usage).

getEmoteById

@Nullable
default Emote getEmoteById(@Nonnull
                           String id)

Retrieves an emote matching the specified id if one is available in our cache.
This will be null if CacheFlag.EMOTE is disabled.

Unicode emojis are not included as Emote!

Parameters:

id - The id of the requested Emote.

Returns:

An Emote represented by this id or null if none is found in our cache.

Throws:

NumberFormatException - If the provided id cannot be parsed by Long.parseLong(String)

getEmoteById

@Nullable
default Emote getEmoteById(long id)

Retrieves an emote matching the specified id if one is available in our cache.
This will be null if CacheFlag.EMOTE is disabled.

Unicode emojis are not included as Emote!

Parameters:

id - The id of the requested Emote.

Returns:

An Emote represented by this id or null if none is found in our cache.

getEmotesByName

@Nonnull
default List<Emote> getEmotesByName(@Nonnull
                                    String name,
                                    boolean ignoreCase)

An unmodifiable list of all Emotes that have the same name as the one provided.
If there are no Emotes with the provided name, then this returns an empty list.
This will be empty if CacheFlag.EMOTE is disabled.

Unicode emojis are not included as Emote!

Parameters:

name - The name of the requested Emotes. Without colons.

ignoreCase - Whether to ignore case or not when comparing the provided name to each Emote.getName().

Returns:

Possibly-empty list of all the Emotes that all have the same name as the provided name.

getEventManager

@Nonnull
IEventManager getEventManager()

The EventManager used by this JDA instance.

Returns:

The IEventManager

getSelfUser

@Nonnull
SelfUser getSelfUser()

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().

Returns:

The currently logged in account.

getPresence

@Nonnull
Presence getPresence()

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

Returns:

The never-null Presence for this session.

getShardInfo

@Nonnull
JDA.ShardInfo getShardInfo()

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

Returns:

The shard information for this shard

getToken

@Nonnull
String getToken()

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

Returns:

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

getResponseTotal

long getResponseTotal()

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).

Returns:

Never-negative long containing total response amount.

getMaxReconnectDelay

int getMaxReconnectDelay()

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

Returns:

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

setAutoReconnect

void setAutoReconnect(boolean reconnect)

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.

Parameters:

reconnect - If true - enables autoReconnect

setRequestTimeoutRetry

void setRequestTimeoutRetry(boolean retryOnTimeout)

Whether the Requester should retry when a SocketTimeoutException occurs.

Parameters:

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

isAutoReconnect

boolean isAutoReconnect()

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

Returns:

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

isBulkDeleteSplittingEnabled

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.

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

Returns:

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

shutdown

void shutdown()

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()

See Also:

shutdownNow()

shutdownNow

void shutdownNow()

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()

See Also:

shutdown()

getAccountType

@Nonnull
AccountType getAccountType()

The AccountType of the currently logged in account.
Used when determining functions that are restricted based on the type of account.

Returns:

The current AccountType.

retrieveApplicationInfo

@Nonnull
@CheckReturnValue
RestAction<ApplicationInfo> retrieveApplicationInfo()

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!

Returns:

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

Throws:

AccountTypeException - If the currently logged in account is not from AccountType.BOT

getInviteUrl

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

Creates an authorization invite url for the currently logged in Bot-Account.
Example Format: https://discordapp.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

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

Throws:

AccountTypeException - If the currently logged in account is not from AccountType.BOT

getInviteUrl

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

Creates an authorization invite url for the currently logged in Bot-Account.
Example Format: https://discordapp.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

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

Throws:

AccountTypeException - If the currently logged in account is not from AccountType.BOT

getShardManager

@Nullable
ShardManager getShardManager()

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

Returns:

The corresponding ShardManager or null if there is no such manager

retrieveWebhookById

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

Retrieves a Webhook by its id.

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

Parameters:

webhookId - The webhook id

Returns:

RestAction - Type: Webhook
The webhook object.

Throws:

IllegalArgumentException - If the webhookId is null or empty

See Also:

Guild.retrieveWebhooks(), TextChannel.retrieveWebhooks()

retrieveWebhookById

@Nonnull
default RestAction<Webhook> retrieveWebhookById(long webhookId)

Retrieves a Webhook by its id.

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

Parameters:

webhookId - The webhook id

Returns:

RestAction - Type: Webhook
The webhook object.

See Also:

Guild.retrieveWebhooks(), TextChannel.retrieveWebhooks()