All Classes Interface Summary Class Summary Enum Summary Annotation Types Summary
Class |
Description |
ActionComponent |
|
ActionRow |
|
ActionType |
Represents the various type of audit log action.
|
Activity |
|
Activity.Flag |
|
Activity.Type |
The type of "action" for an activity.
|
ApplicationCommand |
A Discord application command.
|
ApplicationCommand.Type |
|
ApplicationCommandCreateEvent |
Dispatched when an application command relevant to the current user is created.
|
ApplicationCommandDeleteEvent |
Dispatched when an application command relevant to the current user is deleted.
|
ApplicationCommandEvent |
|
ApplicationCommandInteraction |
A Discord application command interaction.
|
ApplicationCommandInteractionEvent |
Dispatched when a user uses an Application Command.
|
ApplicationCommandInteractionOption |
A Discord application command interaction.
|
ApplicationCommandInteractionOptionValue |
|
ApplicationCommandInteractionResolved |
An object containing resolved objects from a Discord application command interaction.
|
ApplicationCommandOption |
A Discord application command option.
|
ApplicationCommandOption.Type |
|
ApplicationCommandOptionChoice |
A Discord application command option choice.
|
ApplicationCommandUpdateEvent |
Dispatched when an application command relevant to the current user is updated.
|
ApplicationInfo |
Represents the Current (typically) Application Information.
|
ApplicationTeam |
|
ApplicationTeamMember |
A Discord application team member.
|
ApplicationTeamMember.MembershipState |
Represents the various types of membership state.
|
ArrayUtil |
|
Attachment |
A Discord attachment.
|
AuditLogChange<T> |
|
AuditLogEntry |
|
AuditLogPart |
A part of a guild's audit logs.
|
AuditLogRole |
A partial role with only an ID and a name.
|
AuditLogUtil |
|
AuditSpec<T> |
A spec which can optionally have a reason in the audit logs when built.
|
AutoCompleteInteractionEvent |
This event is a placeholder for future functionality from discord.
|
Ban |
A Discord ban.
|
BanEvent |
Dispatched when a user is banned from a guild.
|
Button |
A message button.
|
Button.Style |
A button's style is what determines its color and whether it has a custom id or a url.
|
ButtonInteractionEvent |
Dispatched when a user interacts with a Button the bot has sent.
|
CategorizableChannel |
A Discord channel which can be categorized into a Category .
|
Category |
A Discord category.
|
CategoryCreateEvent |
Dispatched when a Category is created in a guild.
|
CategoryDeleteEvent |
Dispatched when a Category is deleted in a guild.
|
CategoryUpdateEvent |
Dispatched when a Category is updated in a guild.
|
ChangeKey<T> |
Represents the various audit log change key.
|
Channel |
A Discord channel.
|
Channel.Type |
Represents the various types of channels.
|
ChannelEvent |
Represents an event related to a Channel .
|
ChatInputAutoCompleteEvent |
Dispatched when a user is typing an application command option that has auto-complete enabled.
|
ChatInputInteractionEvent |
Dispatched when a user uses a chat input command (formerly "slash command").
|
ClientActivity |
Activity data that can be sent to Discord.
|
ClientPresence |
Presence data that can be sent to Discord.
|
ComponentInteractionEvent |
|
ConnectEvent |
Indicates that a gateway connection is successful.
|
CoreResources |
A set of resources required to build DiscordClient instances and are used for core Discord4J operations
like entity manipulation and API communication.
|
DefaultEventDispatcher |
Distributes events to subscribers using a Reactor FluxProcessor as backend.
|
DefaultEventDispatcher.Builder |
|
DefaultShardingStrategy |
|
DefaultShardingStrategy.Builder |
|
DeferrableInteractionEvent |
Dispatched when a user in a guild interacts with an application command or component.
|
DisconnectEvent |
Indicates that a gateway connection is disconnected.
|
DiscordClient |
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.
|
DiscordClientBuilder<C,O extends RouterOptions> |
|
DiscordObject |
An object characterized by the Discord platform.
|
DispatchContext<D,S> |
|
DispatchEventMapper |
A transformation between Gateway inbound Dispatch class of payloads to Discord4J core Event instances.
|
DispatchHandler<D,S,E extends Event> |
Handler for the gateway Dispatch events.
|
DispatchHandlers |
Registry for Dispatch to Event mapping operations.
|
Embed |
A Discord embed.
|
Embed.Type |
Represents the various types of embeds.
|
EmbedCreateFields |
|
EmbedCreateFields.Author |
|
EmbedCreateFields.Field |
|
EmbedCreateFields.Footer |
|
EmojisUpdateEvent |
Dispatched when an emoji is added/deleted/or edited in a guild.
|
Entity |
An uniquely identifiable object by Snowflake .
|
EntityRetrievalStrategy |
|
EntityRetriever |
Abstraction for entity retrieval.
|
EntityUtil |
An utility class for entity processing.
|
Event |
Represents a Discord real-time event used to track a client's state.
|
EventDispatcher |
Distributes events to subscribers.
|
EventDispatcher.Builder |
|
ExtendedInvite |
Metadata for a Discord invite.
|
ExtendedPermissionOverwrite |
A Discord permission overwrite.
|
FallbackEntityRetriever |
|
FollowedChannel |
A news channel that has been followed.
|
GatewayBootstrap<O extends GatewayOptions> |
|
GatewayDiscordClient |
An aggregation of all dependencies Discord4J requires to operate with the Discord Gateway, REST API and Voice
Gateway.
|
GatewayLifecycleEvent |
Represents a lifecycle status change for a gateway connection.
|
GatewayResources |
A set of dependencies required to build and coordinate multiple GatewayClient instances.
|
Guild |
A Discord guild.
|
Guild.ContentFilterLevel |
Automatically scan and delete messages sent in the server that contain explicit content.
|
Guild.MfaLevel |
Prevent potentially dangerous administrative actions for users without two-factor authentication enabled.
|
Guild.NotificationLevel |
Determines whether Members who have not explicitly set their notification settings receive a
notification for every message sent in the server or not.
|
Guild.NsfwLevel |
|
Guild.PremiumTier |
Represent the server Premium Tier (aka boost level) of the Guild .
|
Guild.SystemChannelFlag |
Describes system channel flags.
|
Guild.VerificationLevel |
Members of the server must meet the following criteria before they can send messages in text
channels or initiate a direct message conversation.
|
GuildChannel |
A Discord channel associated to a Guild .
|
GuildCreateEvent |
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.
|
GuildCreateFields |
|
GuildCreateFields.PartialChannel |
|
GuildDeleteEvent |
Dispatched in two different scenarios:
The bot is kicked from or leaves a guild.
A guild becomes unavailable during an outage.
|
GuildEmoji |
A Discord guild emoji.
|
GuildEvent |
Represents an event related to a Guild .
|
GuildMessageChannel |
A Discord channel in a guild that can have messages sent to it.
|
GuildTemplate |
A Discord Guild Template.
|
GuildUpdateEvent |
Dispatched when a guild is updated.
|
ImageUtil |
An utility class for image processing.
|
InlineFieldStyle |
|
Integration |
A Discord integration.
|
Integration.ExpireBehavior |
Represents the various integration expire behaviors.
|
IntegrationAccount |
A Discord Integration Account.
|
IntegrationApplication |
A Discord Integration Application.
|
IntegrationCreateEvent |
Dispatched when an integration is created.
|
IntegrationDeleteEvent |
Dispatched when an integration is deleted.
|
IntegrationsUpdateEvent |
Dispatched when guild integrations are updated.
|
IntegrationUpdateEvent |
Dispatched when an integration is updated.
|
Interaction |
A Discord interaction.
|
Interaction.Type |
Represents the various types of interaction.
|
InteractionCreateEvent |
Dispatched when a user in a guild interacts with an application command, component, or other interaction based UI
element.
|
Invite |
A Discord invite.
|
Invite.Type |
Represents the various types of target user for an invite.
|
InviteCreateEvent |
Dispatched when a new invite to a channel is created.
|
InviteDeleteEvent |
Dispatched when an invite to a channel is deleted.
|
LayoutComponent |
A message component that determines how components are laid out in a message and has ActionComponent
children.
|
LegacyAuditLogQuerySpec |
A spec used to query audit log entries that match the specified filter.
|
LegacyAuditSpec<T> |
A spec which can optionally have a reason in the audit logs when built.
|
LegacyBanQuerySpec |
A spec used to configure a user ban.
|
LegacyCategoryCreateSpec |
A spec used to configure and create a Category .
|
LegacyCategoryEditSpec |
A spec used to edit an existing Category .
|
LegacyEmbedCreateSpec |
A spec used to configure and send an embed.
|
LegacyGuildCreateFromTemplateSpec |
LegacySpec used to create a guild from a template.
|
LegacyGuildCreateSpec |
A spec used to configure and create a Guild .
|
LegacyGuildEditSpec |
A spec used to selectively modify properties from a Guild .
|
LegacyGuildEmojiCreateSpec |
|
LegacyGuildEmojiEditSpec |
|
LegacyGuildMemberEditSpec |
LegacySpec used to modify guild members.
|
LegacyGuildPruneCountSpec |
LegacySpec used to retrieve the number of members that would be removed in a prune operation.
|
LegacyGuildPruneSpec |
LegacySpec used to begin a prune operation.
|
LegacyGuildTemplateCreateSpec |
LegacySpec to create a guild template.
|
LegacyGuildTemplateEditSpec |
LegacySpec to edit a guild template.
|
LegacyInteractionApplicationCommandCallbackSpec |
|
LegacyInviteCreateSpec |
LegacySpec used to create guild channel Invite objects.
|
LegacyMessageCreateSpec |
|
LegacyMessageEditSpec |
LegacySpec used to edit Message entities this client has sent before.
|
LegacyMessageReferenceSpec |
LegacySpec used to create a message reference.
|
LegacyNewsChannelCreateSpec |
|
LegacyNewsChannelEditSpec |
LegacySpec used to modify a guild NewsChannel settings.
|
LegacyRoleCreateSpec |
LegacySpec used to create a new guild Role entity.
|
LegacyRoleEditSpec |
LegacySpec used to modify a guild Role .
|
LegacySpec<T> |
A contract specifying how an object should be built.
|
LegacyStoreChannelEditSpec |
|
LegacyTextChannelCreateSpec |
|
LegacyTextChannelEditSpec |
LegacySpec used to modify a guild TextChannel settings.
|
LegacyUserEditSpec |
LegacySpec used to modify the current user.
|
LegacyVoiceChannelCreateSpec |
|
LegacyVoiceChannelEditSpec |
|
LegacyVoiceChannelJoinSpec |
|
LegacyWebhookCreateSpec |
LegacySpec used to create a Webhook entity.
|
LegacyWebhookEditSpec |
LegacySpec to modify a Webhook entity.
|
LegacyWebhookEditWithTokenSpec |
|
LegacyWebhookExecuteSpec |
|
ListUtil |
|
LocalShardCoordinator |
A centralized local ShardCoordinator that can operate on a single JVM instance to coordinate Gateway
connection and identifying attempts across multiple shards.
|
Member |
A Discord guild member.
|
MemberChunkEvent |
Dispatched as members are streamed to the client from Discord.
|
MemberJoinEvent |
Dispatched when a user joins a guild.
|
MemberLeaveEvent |
Dispatched when a user leaves a guild OR is kicked from it.
|
MemberRequestFilter |
A filter to customize the guild member request strategy.
|
MemberUpdateEvent |
Dispatched when a user's nickname or roles change in a guild.
|
Message |
A Discord message.
|
Message.Flag |
Describes extra features of a message.
|
Message.Type |
Represents the various types of messages.
|
MessageBulkDeleteEvent |
Dispatched when multiple messages are deleted at once.
|
MessageChannel |
A Discord channel that can utilize messages.
|
MessageComponent |
A Discord message component.
|
MessageComponent.Type |
|
MessageCreateEvent |
Dispatched when a message is sent in a message channel.
|
MessageCreateFields |
|
MessageCreateFields.File |
|
MessageCreateFields.FileSpoiler |
|
MessageDeleteEvent |
Dispatched when a message is deleted.
|
MessageEvent |
Represents an event related to a Message .
|
MessageInteraction |
A Discord Message Interaction.
|
MessageInteractionEvent |
Dispatched when a user uses a message command (message context menu)
|
MessageReference |
A Message Reference used by the Server Following feature.
|
MessageUpdateEvent |
Dispatched when a message is updated.
|
NewsChannel |
A Discord news channel.
|
NewsChannelCreateEvent |
|
NewsChannelDeleteEvent |
|
NewsChannelUpdateEvent |
|
OptionKey<T> |
|
OrderUtil |
|
ParameterData |
|
PartialMember |
A partial Discord guild member.
|
PermissionOverwrite |
|
PermissionOverwrite.Type |
|
PermissionUtil |
|
PinsUpdateEvent |
Dispatched when a message is pinned or unpinned in a message channel.
|
Presence |
Presence is the current state of a user on a guild, received from Discord.
|
PresenceUpdateEvent |
Dispatched when a user's presence changes.
|
PrivateChannel |
A Discord private channel (also known as a DM channel).
|
PrivateChannelDeleteEvent |
TODO what does this mean?
|
Reaction |
A Discord message reaction.
|
ReactionAddEvent |
Dispatched when a reaction is added to a message.
|
ReactionEmoji |
|
ReactionEmoji.Custom |
|
ReactionEmoji.Unicode |
|
ReactionRemoveAllEvent |
Dispatched when all of the reactions on a message are removed.
|
ReactionRemoveEmojiEvent |
Dispatched when a reactions of one emoji are removed on a message.
|
ReactionRemoveEvent |
Dispatched when a reaction is removed on a message.
|
ReactiveEventAdapter |
An adapter class to attach reactive listeners to each event type.
|
ReadyEvent |
Dispatched when an initial connection to the Discord gateway has been established.
|
ReadyEvent.Guild |
An incomplete Guild provided by Discord upon the ready event.
|
ReconnectEvent |
Indicates that a gateway connection has correctly reconnected.
|
ReconnectFailEvent |
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 .
|
ReconnectStartEvent |
Indicates that a gateway connection is starting a reconnect attempt.
|
Region |
A Discord voice region.
|
Region.Id |
Represents the different non-deprecated voice region ids.
|
ReplayingEventDispatcher |
Distributes events to active subscribers, while using a fallback storage if no subscribers are present that can be
replayed to future late subscribers.
|
ReplayingEventDispatcher.Builder |
|
ResolvedChannel |
A Discord channel that was resolved in a command.
|
ResolvedMember |
A Discord member that was resolved in a command.
|
RestEntityRetriever |
|
ResumeEvent |
Dispatched when the gateway connection is successfully resumed.
|
Role |
A Discord role.
|
RoleCreateEvent |
Dispatched when a role is created in a guild.
|
RoleDeleteEvent |
Dispatched when a role is deleted in a guild.
|
RoleEvent |
Represents an event related to a Role .
|
RoleTags |
|
RoleUpdateEvent |
Dispatched when a role is updated in a guild.
|
SelectMenu |
A message select menu.
|
SelectMenu.Option |
An option displayed in a select menu.
|
SelectMenuInteractionEvent |
Dispatched when a user interacts with a SelectMenu the bot has sent.
|
SessionInvalidatedEvent |
Indicates that the session of a gateway connection has been invalidated.
|
ShardCoordinator |
A ShardCoordinator defines key operations to leverage shard coordination across boundaries.
|
ShardingStrategy |
|
SinksEventDispatcher |
Distributes Event instances to subscribers, using Reactor Sinks as backend.
|
SinksEventDispatcher.Builder |
|
Spec<T> |
A contract specifying how an object should be built.
|
SpecStyle |
|
Status |
Represents the various type of status.
|
Status.Platform |
|
Sticker |
|
Sticker.Format |
The format of a sticker.
|
StoreChannel |
A Discord store channel.
|
StoreChannelCreateEvent |
|
StoreChannelDeleteEvent |
|
StoreChannelUpdateEvent |
|
StoreEntityRetriever |
|
TextChannel |
A Discord text channel.
|
TextChannelCreateEvent |
|
TextChannelDeleteEvent |
|
TextChannelUpdateEvent |
|
TopLevelGuildChannel |
A Discord channel in a guild that isn't a thread.
|
TopLevelGuildMessageChannel |
A Discord message channel in a guild that isn't a thread.
|
TypingStartEvent |
Dispatched when a user starts typing in a message channel.
|
UnbanEvent |
Dispatched when a user is unbanned from a guild.
|
User |
A Discord user.
|
User.Flag |
Describes the flags of a user.
|
UserInteractionEvent |
Dispatched when a user uses a user command (user context menu)
|
UserUpdateEvent |
Dispatched when the bot's user is updated.
|
ValidationUtil |
|
VoiceChannel |
A Discord voice channel.
|
VoiceChannel.Mode |
Represents the various video quality modes.
|
VoiceChannelCreateEvent |
|
VoiceChannelDeleteEvent |
|
VoiceChannelUpdateEvent |
|
VoiceServerUpdateEvent |
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).
|
VoiceState |
A Discord voice state.
|
VoiceStateUpdateEvent |
Dispatched when a user's voice state changes.
|
Webhook |
A Discord webhook.
|
Webhook.Type |
Represents the various types of webhooks.
|
WebhookMessageEditSpecGenerator |
|
WebhooksUpdateEvent |
Dispatched when a webhook is updated in a guild.
|