All Classes and Interfaces
Class
Description
A message component that is placed in a
LayoutComponent.A row of
action components.Represents the various type of audit log action.
The type of "action" for an activity.
A Discord application command.
Dispatched when an application command relevant to the current user is created.
Dispatched when an application command relevant to the current user is deleted.
Represents an event related to a
ApplicationCommand.Represents a guild application command permissions.
A Discord application command interaction.
Dispatched when a user uses an Application Command.
A Discord application command interaction.
An object containing resolved objects from a Discord application command interaction.
A Discord application command option.
A Discord application command option choice.
Represents an individual application command permission, allowing you to enable or disable commands for specific
users, roles, or channels within a guild.
Represents the various types of application command permissions.
Dispatched when an application command permission relevant to the current user is updated.
Dispatched when an application command relevant to the current user is updated.
Represents the Current (typically) Application Information.
Describes the flags of an application.
A Discord application team member.
Represents the various types of membership state.
A Discord attachment.
A set of flags for an
attachment.A Discord audio channel.
A single administrative action or event, that can be recorded by an
AuditLogPart if it didn't originate from
a gateway event.Dispatched when an Entry of an Audit Log is created in a guild.
A part of a guild's audit logs.
A partial role with only an ID and a name.
A spec which can optionally have a reason in the audit logs when built.
This event is a placeholder for future functionality from discord.
Dispatched when an automod action is executed.
An Auto Moderation Rule
Represents an Event Type of AutoMod Rule.
Represents a Trigger Type of AutoMod Rule.
An Auto Moderation Rule Action
An Auto Moderation Rule Action MetaData
Represents an Action Type of AutoMod Action.
Dispatched when an automod rule is created.
Dispatched when an automod rule is deleted.
Generic class related to AutoModRule events
An Auto Moderation Trigger MetaData
Represents a preset in the AutoModMetaData.
Dispatched when an automod rule is updated.
A Discord ban.
Dispatched when a user is banned from a guild.
A message button.
A button's style is what determines its color and whether it has a custom id or a url.
Dispatched when a user interacts with a
Button the bot has sent.A Discord channel which can be categorized into a
Category.A Discord category.
Dispatched when a
Category is created in a guild.Dispatched when a
Category is deleted in a guild.Dispatched when a
Category is updated in a guild.Represents the various audit log change key.
A Discord channel.
Represent channel flags : https://discord.com/developers/docs/resources/channel#channel-object-channel-flags
Represents the various types of channels.
Represents an event related to a
Channel.Dispatched when a user is typing an application command option that has auto-complete enabled.
Dispatched when a user uses a chat input command (formerly "slash command").
Activity data that can be sent to Discord.
Presence data that can be sent to Discord.
Dispatched when a user interacts with a
MessageComponent the bot has sent.Indicates that a gateway connection is successful.
A set of resources required to build
DiscordClient instances and are used for core Discord4J operations
like entity manipulation and API communication.Distributes events to subscribers using a Reactor
FluxProcessor as backend.A builder to create
EventDispatcher instances.DefaultReaction is used by
ForumChannel as an emoji shown as a quick reaction button on the thread in a forum channel.A
ShardingStrategy builder.Dispatched when a user in a guild interacts with an application command or component.
Indicates that a gateway connection is disconnected.
A high-level abstraction of common Discord4J operations such as entity retrieval through Discord API or the creation
of real-time bot clients through Discord Gateway.
Builder suited for creating a
DiscordClient.An object characterized by the Discord platform.
Represents gateway dispatch data enriched with context for processing through a
DispatchHandler defined under DispatchHandlers.A transformation between Gateway inbound Dispatch class of payloads to Discord4J core
Event instances.Handler for the gateway Dispatch events.
Registry for
Dispatch to Event mapping operations.A Discord embed.
Represents the various types of embeds.
Dispatched when an emoji is added/deleted/or edited in a guild.
An uniquely identifiable object by
Snowflake.Defines the entity retrieval strategy to use for a given
GatewayDiscordClient.Abstraction for entity retrieval.
A utility class for entity processing.
Represents a Discord real-time event used to track a client's state.
Distributes events to subscribers.
Metadata for a Discord invite.
A Discord permission overwrite.
A news channel that has been followed.
A Discord guild channel that contains organized threads with labels.
Layout types are used by Forum channels to organize their threads channel into a user view
Sort orders are proposed by Discord to choose the order or threads in a Forum channel
Please see Discord documentation for further details
Please see Discord documentation for further details
Dispatched when a
ForumChannel is created in a guild.Dispatched when a
ForumChannel is deleted in a guild.Dispatched when a
ForumChannel is updated in a guild.Builder to create a shard group connecting to Discord Gateway to produce a
GatewayDiscordClient.An aggregation of all dependencies Discord4J requires to operate with the Discord Gateway, REST API and Voice
Gateway.
Represents a lifecycle status change for a gateway connection.
A set of dependencies required to build and coordinate multiple
GatewayClient instances.A Discord guild.
Automatically scan and delete messages sent in the server that contain explicit content.
Prevent potentially dangerous administrative actions for users without two-factor authentication enabled.
Determines whether
Members who have not explicitly set their notification settings receive a
notification for every message sent in the server or not.Represent the server Premium Tier (aka boost level) of the
Guild.Describes system channel flags.
Members of the server must meet the following criteria before they can send messages in text
channels or initiate a direct message conversation.A Discord channel associated to a
Guild.Dispatched in three different scenarios:
After the bot connects to Discord (after
ReadyEvent
is dispatched), this event will be dispatched for all guilds the bot is in on this shard.
After an outage (in which many guild deletes will
be dispatched), this event will be dispatched as guilds become available again.
When the bot is added to a guild.
Dispatched in two different scenarios:
The bot is kicked from or leaves a guild.
A guild becomes unavailable during an outage.
A Discord guild emoji.
Represents an event related to a
Guild.A Discord channel in a guild that can have messages sent to it.
A Discord Guild Template.
Dispatched when a guild is updated.
An utility class for image processing.
A Discord integration.
Represents the various integration expire behaviors.
A Discord Integration Account.
A Discord Integration Application.
Dispatched when an integration is created.
Dispatched when an integration is deleted.
Dispatched when guild integrations are updated.
Dispatched when an integration is updated.
A Discord interaction.
Represents the various types of interaction.
Dispatched when a user in a guild interacts with an application command, component, or other interaction based UI
element.
A Discord invite.
Represents the various types of target user for an invite.
Dispatched when a new invite to a channel is created.
Dispatched when an invite to a channel is deleted.
A message component that determines how components are laid out in a message and has
ActionComponent
children.A spec used to query audit log entries that match the specified filter.
A spec which can optionally have a reason in the audit logs when built.
A spec used to configure a user ban.
A spec used to configure and create a
Category.A spec used to edit an existing
Category.A spec used to configure and send an embed.
LegacySpec used to create a guild from a template.
A spec used to configure and create a
Guild.A spec used to selectively modify properties from a
Guild.LegacySpec used to create
GuildEmoji objects.LegacySpec used to modify an existing
GuildEmoji.LegacySpec used to modify guild members.
LegacySpec used to retrieve the number of members that would be removed in a prune operation.
LegacySpec used to begin a prune operation.
LegacySpec to create a guild template.
LegacySpec to edit a guild template.
LegacySpec used to create guild channel
Invite objects.LegacySpec used to create
Messages to MessageChannels.LegacySpec used to edit
Message entities this client has sent before.LegacySpec used to create a message reference.
LegacySpec used to create guild
NewsChannel entities.LegacySpec used to modify a guild
NewsChannel settings.LegacySpec used to create a new guild
Role entity.LegacySpec used to modify a guild
Role.A contract specifying how an object should be built.
LegacySpec used to modify a guild
StoreChannel settings.LegacySpec used to create guild
TextChannel entities.LegacySpec used to modify a guild
TextChannel settings.LegacySpec used to modify the current user.
A spec used to configure and create a
VoiceChannel.LegacySpec used to modify a
VoiceChannel entity.LegacySpec used to request a connection to a
AudioChannel and handle the initialization of the resulting
VoiceConnection.LegacySpec used to create a
Webhook entity.LegacySpec to modify a
Webhook entity.A centralized local
ShardCoordinator that can operate on a single JVM instance to coordinate Gateway
connection and identifying attempts across multiple shards.A Discord guild member.
Dispatched as members are streamed to the client from Discord.
Dispatched when a user joins a guild.
Dispatched when a user leaves a guild OR is kicked from it.
A filter to customize the guild member request strategy.
Dispatched when a user's nickname or roles change in a guild.
A Discord message.
Describes extra features of a message.
Represents the various types of messages.
Dispatched when multiple messages are deleted at once.
A Discord channel that can utilize messages.
A Discord message component.
Dispatched when a message is sent in a message channel.
Dispatched when a message is deleted.
Represents an event related to a
Message.A Discord Message Interaction.
Dispatched when a user uses a message command (message context menu)
A Message Reference used by the Server Following feature.
Dispatched when a message is updated.
Dispatched when a user has pressed submit on a modal presented to them earlier
A Discord news channel.
Dispatched when a
NewsChannel is created in a guild.Dispatched when a
NewsChannel is deleted in a guild.Dispatched when a
NewsChannel is updated in a guild.A key to be used in
AuditLogEntry.getOption(OptionKey).A utility class for the sorting of
roles and guild channels.A partial Discord guild member.
Describes the flags of a member in a guild.
The type of entity a
PermissionOverwrite is for.Dispatched when a message is pinned or unpinned in a message channel.
Presence is the current state of a user on a guild, received from Discord.
Dispatched when a user's presence changes.
A Discord private channel (also known as a DM channel).
TODO what does this mean?
A Discord message reaction.
Dispatched when a reaction is added to a message.
An emoji used for
message reactions, provides factory methods such as ReactionEmoji.unicode(String)
and others to generate reactions.Dispatched when all of the reactions on a message are removed.
Dispatched when a reactions of one emoji are removed on a message.
Dispatched when a reaction is removed on a message.
An adapter class to attach reactive listeners to each event type.
Dispatched when an initial connection to the Discord gateway has been established.
An incomplete Guild provided by Discord upon the ready event.
Indicates that a gateway connection has correctly reconnected.
Indicates that a reconnection attempt has failed and a new attempt should be scheduled, in that case, this event
will be followed by a
ReconnectStartEvent.Indicates that a gateway connection is starting a reconnect attempt.
A Discord voice region.
Represents the different non-deprecated voice region ids.
Distributes events to active subscribers, while using a fallback storage if no subscribers are present that can be
replayed to future late subscribers.
A builder to create
EventDispatcher instances.A Discord channel that was resolved in a command.
A Discord member that was resolved in a command.
Dispatched when the gateway connection is successfully resumed.
A Discord role.
Describes the flags of a Role.
Dispatched when a role is created in a guild.
Dispatched when a role is deleted in a guild.
Represents an event related to a
Role.Dispatched when a role is updated in a guild.
A Discord Guild Scheduled Event
Represents a scheduled event's entity type
Represents a scheduled event's privacy level.
Represents a scheduled event's status
Dispatched when a guild scheduled event is created.
Dispatched when a guild scheduled event is deleted.
Dispatched when a user has subscribed to a guild scheduled event.
Dispatched when a user has unsubscribed from a guild scheduled event.
A message select menu.
An option displayed in a select menu.
Dispatched when a user interacts with a
SelectMenu the bot has sent.Indicates that the session of a gateway connection has been invalidated.
A
ShardCoordinator defines key operations to leverage shard coordination across boundaries.Strategy to build sharding
GatewayClient instances.A builder to create
EventDispatcher instances.A contract specifying how an object should be built.
A Discord stage channel.
A Discord stage instance.
Dispatched when a
StageInstance is created.Dispatched when a
StageInstance is deleted.Dispatched when a
StageInstance is updated.Dispatched when a user connected to a stage channel makes a request to speak.
A spec to create threads in a forum channel
name: 1-100 character channel name
autoArchiveDuration: duration in minutes to automatically archive the thread after recent
activity, can be set to: 60, 1440, 4320, 10080
rateLimitPerUser: amount of seconds a user has to wait before sending another message
(0-21600)
message: a forum thread message object to start the thread with
applied_tags: array of tag snowflakes to apply on this thread
A spec to create threads from a message.
A spec to create threads that are not connected to a message.
Represents the various type of status.
The format of a sticker.
The type of sticker.
Dispatched when an sticker is added/deleted/or edited in a guild.
A Discord store channel.
Dispatched when a
StoreChannel is created in a guild.Dispatched when a
StoreChannel is deleted in a guild.Dispatched when a
StoreChannel is updated in a guild.A Discord text channel.
Dispatched when a
TextChannel is created in a guild.Dispatched when a
TextChannel is deleted in a guild.Dispatched when a
TextChannel is updated in a guild.A modal-only text input field
A text input's style is what determines its size and behavior
Duration in minutes to automatically archive the thread after recent activity.
Sent when a thread is created, relevant to the current user, or when the current user is added to a thread.
Sent when a thread relevant to the current user is deleted.
Sent when a thread is updated.
Represents an event related to a thread.
A part of thread channels list which contains channels and thread members.
Sent when the current user gains access to a channel.
A thread member is used to indicate whether a user has joined a thread or not.
Sent when anyone is added to or removed from a thread.
Sent when the thread member object for the current user is updated.
A Discord channel in a guild that isn't a thread.
A Discord message channel in a guild that isn't a thread.
Dispatched when a user starts typing in a message channel.
Dispatched when a user is unbanned from a guild.
A
Channel implementation representing an unsupported or not implemented channel type.Dispatched when an
UnknownChannel is created in a guild.Dispatched when an
UnknownChannel is deleted in a guild.Dispatched when an
UnknownChannel is updated in a guild.A Discord user.
Describes the flags of a user.
Dispatched when a user uses a user command (user context menu)
Dispatched when the bot's user is updated.
A Discord voice channel.
Represents the various video quality modes.
Dispatched when a
VoiceChannel is created in a guild.Dispatched when a
VoiceChannel is deleted in a guild.Dispatched when a
VoiceChannel is updated in a guild.Dispatched when the current user is initially connecting to a voice channel, and when the current voice instance
fails over to a new server (guild's voice server is updated).
A Discord voice state.
Dispatched when a user's voice state changes.
A Discord webhook.
Represents the various types of webhooks.
Dispatched when a webhook is updated in a guild.