JDA 5.6.1 API

Welcome to the documentation of the Java Discord API (JDA) library!

If you are new to JDA, you can check some of our official guides to get started:

• Setup
• Getting Started
• Frequently Asked Questions
• Troubleshooting
• Using RestActions
• Interactions

There are also a few examples available to get inspired:

• Message Logging
• Slash Commands
• Receiving and Sending Audio

Other useful resources:

• README
• Releases and Changelogs
• Reporting Issues

Packages

Package	Description
net.dv8tion.jda.annotations	Annotations used for documentation.
net.dv8tion.jda.api	The API features of JDA.
net.dv8tion.jda.api.audio	The audio API for Discord.
net.dv8tion.jda.api.audio.factory	Audio send factories that can be implemented to generate custom audio send packages to be provided to Discord.
net.dv8tion.jda.api.audio.hooks	Listeners that can be used to monitor the ConnectionStatus or ping of an existing audio connection.
net.dv8tion.jda.api.audit	Implementation for AuditLogEntry and all utilities needed for its structure.
net.dv8tion.jda.api.entities	Entities representing Discord API objects like Users and Channels
net.dv8tion.jda.api.entities.automod	Types and enums related to AutoMod.
net.dv8tion.jda.api.entities.automod.build	Configurations for AutoMod rules and triggers.
net.dv8tion.jda.api.entities.channel	Top-level abstractions related to Discord channel types.
net.dv8tion.jda.api.entities.channel.attribute	Marker interfaces for specific channel features.
net.dv8tion.jda.api.entities.channel.concrete	Concrete channel types in Discord.
net.dv8tion.jda.api.entities.channel.forums	Types relevant for forum channels and forum posts.
net.dv8tion.jda.api.entities.channel.middleman	Abstractions for higher-level features in channels, such as sending messages or audio.
net.dv8tion.jda.api.entities.channel.unions	Union types used for simple casting to more concrete types.
net.dv8tion.jda.api.entities.detached
net.dv8tion.jda.api.entities.emoji	Types relating to unicode and custom emoji as used in the API.
net.dv8tion.jda.api.entities.guild
net.dv8tion.jda.api.entities.messages
net.dv8tion.jda.api.entities.sticker	Types relevant for custom guild stickers and nitro stickers.
net.dv8tion.jda.api.entities.templates	Types relevant for guild templates.
net.dv8tion.jda.api.events	The core events that are fired by this library, informing the end-user about the state of the current JDA instance.
net.dv8tion.jda.api.events.automod	Events related to the configuration of AutoMod rules or AutoMod rules being triggered.
net.dv8tion.jda.api.events.channel	Events indicating that a new channel (MessageChannel / GuildChannel) was either modified, created or deleted.
net.dv8tion.jda.api.events.channel.forum	Events related to forum tags.
net.dv8tion.jda.api.events.channel.forum.update	Events related to forum tags being modified.
net.dv8tion.jda.api.events.channel.update	Events indicating that a specific channel property was updated.
net.dv8tion.jda.api.events.emoji	Events that track added emojis and removed emojis.
net.dv8tion.jda.api.events.emoji.update	Events that track updates for existing Custom Emojis
net.dv8tion.jda.api.events.entitlement	Events that indicate that a Entitlement is either created, updated, or deleted.
net.dv8tion.jda.api.events.guild	Events for the state of Guilds such as whether the current logged in account joins/leaves a Guild.
net.dv8tion.jda.api.events.guild.invite	Events relating to invites being created or deleted in a guild.
net.dv8tion.jda.api.events.guild.member	Events that indicate changes for the Members of a Guild such as join/leave or updates of the specific Member such as new Roles or a new nickname.
net.dv8tion.jda.api.events.guild.member.update	Events for Member updates.
net.dv8tion.jda.api.events.guild.override	Events for PermissionOverride updates.
net.dv8tion.jda.api.events.guild.scheduledevent	Gateway events for ScheduledEvents.
net.dv8tion.jda.api.events.guild.scheduledevent.update	Events for ScheduleEvent updates.
net.dv8tion.jda.api.events.guild.update	Events indicating that a setting for a Guild has been updated.
net.dv8tion.jda.api.events.guild.voice	Events indicating the GuildVoiceState updates for one of the Guild's Members.
net.dv8tion.jda.api.events.http	Events fired in the context of HTTP requests being processed.
net.dv8tion.jda.api.events.interaction	Abstractions for interaction events.
net.dv8tion.jda.api.events.interaction.command	Interaction events related to application commands.
net.dv8tion.jda.api.events.interaction.component	Interaction events related to message components.
net.dv8tion.jda.api.events.message	Events that are fired for Messages in a MessageChannel.
net.dv8tion.jda.api.events.message.poll
net.dv8tion.jda.api.events.message.react	Events indicating the MessageReactions of a Message changed.
net.dv8tion.jda.api.events.role	Events that indicate that a Role is either created or deleted.
net.dv8tion.jda.api.events.role.update	Events that indicate that a Role has been updated with a new setting.
net.dv8tion.jda.api.events.self	Events indicating that one of the currently logged in account's settings has been modified.
net.dv8tion.jda.api.events.session	Events about the current gateway connection state.
net.dv8tion.jda.api.events.stage	Events indicating when a stage instance is created or deleted.
net.dv8tion.jda.api.events.stage.update	Events for stage instance updates.
net.dv8tion.jda.api.events.sticker	Events that track added stickers and removed stickers.
net.dv8tion.jda.api.events.sticker.update	Events that track updates for existing GuildStickers.
net.dv8tion.jda.api.events.thread	Events related to thread visibility.
net.dv8tion.jda.api.events.thread.member	Events related to updates of the thread member list.
net.dv8tion.jda.api.events.user	Events that indicate that a User presence has been updated, such as its avatar or game.
net.dv8tion.jda.api.events.user.update	Events related to user updates, such as the name or avatar.
net.dv8tion.jda.api.exceptions	All custom exceptions of the JDA library
net.dv8tion.jda.api.hooks	EventManager and EventListener implementations and interfaces.
net.dv8tion.jda.api.interactions	Abstractions for interaction types.
net.dv8tion.jda.api.interactions.callbacks	Types of interaction responses, like message replies or message edits.
net.dv8tion.jda.api.interactions.commands	Abstractions for application commands and related interactions.
net.dv8tion.jda.api.interactions.commands.build	Types and utilities for building application commands.
net.dv8tion.jda.api.interactions.commands.context	Interactions related to context menus.
net.dv8tion.jda.api.interactions.commands.localization	Utilities for localization of application commands.
net.dv8tion.jda.api.interactions.commands.privileges	Types related to application command privileges, often referred to as command permissions.
net.dv8tion.jda.api.interactions.components	Abstraction types for message and modal components.
net.dv8tion.jda.api.interactions.components.buttons	Button components.
net.dv8tion.jda.api.interactions.components.selections	Select menu components, also known as dropdowns.
net.dv8tion.jda.api.interactions.components.text	Text input components.
net.dv8tion.jda.api.interactions.modals	Modals used for interactions.
net.dv8tion.jda.api.interactions.response
net.dv8tion.jda.api.managers	Managers that allow to modify (PATCH) existing entities with either an update task or atomic setters.
net.dv8tion.jda.api.managers.channel	Top-level channel manager.
net.dv8tion.jda.api.managers.channel.attribute	Channel managers for specific attributes or channel features.
net.dv8tion.jda.api.managers.channel.concrete	Concrete channel manager types for actual channel types.
net.dv8tion.jda.api.managers.channel.middleman	Channel managers for higher level channel features, such as audio related settings.
net.dv8tion.jda.api.requests	Discord API communication features.
net.dv8tion.jda.api.requests.restaction	Extensions of RestAction that can be used to operate on a specific case before executing the request.
net.dv8tion.jda.api.requests.restaction.interactions	RestAction types related to interaction responses.
net.dv8tion.jda.api.requests.restaction.order	RestAction extensions specifically designed to change the order of discord entities.
net.dv8tion.jda.api.requests.restaction.pagination	Extensions of RestAction that allow to access paginated discord endpoints like the message history of a MessageChannel.
net.dv8tion.jda.api.sharding	Implementations for ShardManager which enable auto-sharding.
net.dv8tion.jda.api.utils	Package which contains all utilities for the JDA library.
net.dv8tion.jda.api.utils.cache	Interfaces for read-only access to internal JDA cache.
net.dv8tion.jda.api.utils.concurrent	Implementations for threading related functionality such as Thread-Factories.
net.dv8tion.jda.api.utils.data	Serialization features used for communication with Discord.
net.dv8tion.jda.api.utils.data.etf	Utility classes to decode and encode Erlang External Term Format (ETF)
net.dv8tion.jda.api.utils.messages	Utilities for message building and formatting.