A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ACCEPTED - discord4j.core.object.ApplicationTeamMember.MembershipState
- acknowledge() - Method in class discord4j.core.event.domain.interaction.ComponentInteractionEvent
- acknowledge() - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Acknowledges the interaction indicating a response will be edited later.
- acknowledgeEphemeral() - Method in class discord4j.core.event.domain.interaction.ComponentInteractionEvent
- acknowledgeEphemeral() - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Acknowledges the interaction indicating a response will be edited later.
- ACTION_ROW - discord4j.core.object.component.MessageComponent.Type
- ActionComponent - Class in discord4j.core.object.component
-
A message component that is placed in a
LayoutComponent
. - ActionComponent(ComponentData) - Constructor for class discord4j.core.object.component.ActionComponent
- ActionRow - Class in discord4j.core.object.component
-
A row of
action components
. - ActionType - Enum in discord4j.core.object.audit
-
Represents the various type of audit log action.
- Activity - Class in discord4j.core.object.presence
- Activity.Flag - Enum in discord4j.core.object.presence
- Activity.Type - Enum in discord4j.core.object.presence
-
The type of "action" for an activity.
- adaptStoreService(StoreService) - Method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Obtain a transformed
StoreService
that is capable of supporting this invalidation strategy. - add(int, K) - Method in class discord4j.core.shard.JdkKeyStore
- add(int, K) - Method in interface discord4j.core.shard.KeyStore
-
Add the given key under a shard index.
- add(long[], long) - Static method in class discord4j.core.util.ArrayUtil
- add(List<T>, T) - Static method in class discord4j.core.util.ListUtil
- add(T[], T) - Static method in class discord4j.core.util.ArrayUtil
- addAll(long[], long[]) - Static method in class discord4j.core.util.ArrayUtil
- addAllDistinct(List<T>, List<T>) - Static method in class discord4j.core.util.ListUtil
- addChannel(String, Channel.Type) - Method in class discord4j.core.spec.GuildCreateSpec
-
Adds the channel to the list of channels for the created
Guild
. - addEmbed(Consumer<? super EmbedCreateSpec>) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- addEmbed(Consumer<? super EmbedCreateSpec>) - Method in class discord4j.core.spec.MessageCreateSpec
-
Adds an embed to the message.
- addEmbed(Consumer<? super EmbedCreateSpec>) - Method in class discord4j.core.spec.MessageEditSpec
-
Adds an embed to the edit request.
- addEveryoneRole(Consumer<? super RoleCreateSpec>) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the default @everyone role for the created
Guild
. - addField(String, String, boolean) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Adds a field to the embed.
- addFile(String, InputStream) - Method in class discord4j.core.spec.MessageCreateSpec
-
Adds a file as attachment to the created
Message
. - addFileSpoiler(String, InputStream) - Method in class discord4j.core.spec.MessageCreateSpec
-
Adds a spoiler file as attachment to the created
Message
. - addMemberOverwrite(Snowflake, PermissionOverwrite) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to add a permission overwrite for the given member.
- addMemberOverwrite(Snowflake, PermissionOverwrite, String) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to add a permission overwrite for the given member while optionally specifying a reason.
- addReaction(ReactionEmoji) - Method in class discord4j.core.object.entity.Message
-
Requests to add a reaction on this message.
- addRole(Snowflake) - Method in class discord4j.core.object.entity.Member
-
Requests to add a role to this member.
- addRole(Snowflake) - Method in class discord4j.core.spec.GuildEmojiCreateSpec
-
Adds a role for which the created
GuildEmoji
will be whitelisted. - addRole(Snowflake) - Method in class discord4j.core.spec.GuildPruneCountSpec
-
Include a role in the prune count request.
- addRole(Snowflake) - Method in class discord4j.core.spec.GuildPruneSpec
-
Include a role in the prune request.
- addRole(Snowflake, String) - Method in class discord4j.core.object.entity.Member
-
Requests to add a role to this member while optionally specifying the reason.
- addRole(Consumer<? super RoleCreateSpec>) - Method in class discord4j.core.spec.GuildCreateSpec
-
Adds the role spec to the list of roles for the created
Guild
. - addRoleOverwrite(Snowflake, PermissionOverwrite) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to add a permission overwrite for the given role.
- addRoleOverwrite(Snowflake, PermissionOverwrite, String) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to add a permission overwrite for the given role while optionally specifying a reason.
- addRoles(Collection<Snowflake>) - Method in class discord4j.core.spec.GuildPruneCountSpec
-
Include multiple roles in the prune count request.
- addRoles(Collection<Snowflake>) - Method in class discord4j.core.spec.GuildPruneSpec
-
Include multiple roles in the prune request.
- AFK_CHANNEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Afk channel changed
- AFK_TIMEOUT - Static variable in class discord4j.core.object.audit.ChangeKey
-
Afk timeout duration changed
- AGE_RESTRICTED - discord4j.core.object.entity.Guild.NsfwLevel
- all() - Static method in interface discord4j.core.shard.MemberRequestFilter
-
Request members from all guilds.
- ALL_MEMBERS - discord4j.core.object.entity.Guild.ContentFilterLevel
-
Scan messages sent by all members.
- ALL_MESSAGES - discord4j.core.object.entity.Guild.NotificationLevel
-
Receive a notification for all messages.
- ALLOW - Static variable in class discord4j.core.object.audit.ChangeKey
-
A permission on a text or voice channel was allowed for a role
- APNG - discord4j.core.object.entity.Sticker.Format
-
Represents the Animated Portable Network Graphics format.
- APPLICATION_COMMAND - discord4j.core.object.command.Interaction.Type
- APPLICATION_COMMAND - discord4j.core.object.entity.Message.Type
- APPLICATION_ID - Static variable in class discord4j.core.object.audit.ChangeKey
-
Application id of the added or removed webhook or bot
- ApplicationCommand - Class in discord4j.core.object.command
-
A Discord application command.
- ApplicationCommand(GatewayDiscordClient, ApplicationCommandData) - Constructor for class discord4j.core.object.command.ApplicationCommand
-
Constructs an
ApplicationCommand
with an associatedGatewayDiscordClient
and Discord data. - ApplicationCommand.Type - Enum in discord4j.core.object.command
- ApplicationCommandCreateEvent - Class in discord4j.core.event.domain.command
-
Dispatched when an application command relevant to the current user is created.
- ApplicationCommandCreateEvent(GatewayDiscordClient, ShardInfo, ApplicationCommand, Long) - Constructor for class discord4j.core.event.domain.command.ApplicationCommandCreateEvent
- ApplicationCommandDeleteEvent - Class in discord4j.core.event.domain.command
-
Dispatched when an application command relevant to the current user is deleted.
- ApplicationCommandDeleteEvent(GatewayDiscordClient, ShardInfo, ApplicationCommand, Long) - Constructor for class discord4j.core.event.domain.command.ApplicationCommandDeleteEvent
- ApplicationCommandEvent - Class in discord4j.core.event.domain.command
-
Represents an event related to a
ApplicationCommand
. - ApplicationCommandEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.command.ApplicationCommandEvent
- ApplicationCommandInteraction - Class in discord4j.core.object.command
-
A Discord application command interaction.
- ApplicationCommandInteraction(GatewayDiscordClient, ApplicationCommandInteractionData, Long) - Constructor for class discord4j.core.object.command.ApplicationCommandInteraction
-
Constructs an
ApplicationCommandInteraction
with an associatedGatewayDiscordClient
and Discord data. - ApplicationCommandInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user uses an Application Command.
- ApplicationCommandInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent
- ApplicationCommandInteractionOption - Class in discord4j.core.object.command
-
A Discord application command interaction.
- ApplicationCommandInteractionOption(GatewayDiscordClient, ApplicationCommandInteractionOptionData, Long) - Constructor for class discord4j.core.object.command.ApplicationCommandInteractionOption
-
Constructs an
ApplicationCommandInteractionOption
with an associatedGatewayDiscordClient
and Discord data. - ApplicationCommandInteractionOptionValue - Class in discord4j.core.object.command
- ApplicationCommandInteractionOptionValue(GatewayDiscordClient, Long, int, String) - Constructor for class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- ApplicationCommandOption - Class in discord4j.core.object.command
-
A Discord application command option.
- ApplicationCommandOption(GatewayDiscordClient, ApplicationCommandOptionData) - Constructor for class discord4j.core.object.command.ApplicationCommandOption
-
Constructs an
ApplicationCommandOption
with an associatedGatewayDiscordClient
and Discord data. - ApplicationCommandOption.Type - Enum in discord4j.core.object.command
- ApplicationCommandOptionChoice - Class in discord4j.core.object.command
-
A Discord application command option choice.
- ApplicationCommandOptionChoice(GatewayDiscordClient, ApplicationCommandOptionChoiceData) - Constructor for class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Constructs an
ApplicationCommandOptionChoice
with an associatedGatewayDiscordClient
and Discord data. - ApplicationCommandUpdateEvent - Class in discord4j.core.event.domain.command
-
Dispatched when an application command relevant to the current user is updated.
- ApplicationCommandUpdateEvent(GatewayDiscordClient, ShardInfo, ApplicationCommand, Long) - Constructor for class discord4j.core.event.domain.command.ApplicationCommandUpdateEvent
- ApplicationInfo - Class in discord4j.core.object.entity
-
Represents the Current (typically) Application Information.
- ApplicationInfo(GatewayDiscordClient, ApplicationInfoData) - Constructor for class discord4j.core.object.entity.ApplicationInfo
-
Constructs a
ApplicationInfo
with an associatedGatewayDiscordClient
and Discord data. - ApplicationTeam - Class in discord4j.core.object.entity
- ApplicationTeam(GatewayDiscordClient, ApplicationTeamData) - Constructor for class discord4j.core.object.entity.ApplicationTeam
-
Constructs a
ApplicationTeam
with an associatedGatewayDiscordClient
and Discord data. - ApplicationTeamMember - Class in discord4j.core.object
-
A Discord application team member.
- ApplicationTeamMember(GatewayDiscordClient, ApplicationTeamMemberData) - Constructor for class discord4j.core.object.ApplicationTeamMember
-
Constructs an
ApplicationTeamMember
with an associatedGatewayDiscordClient
and Discord data. - ApplicationTeamMember.MembershipState - Enum in discord4j.core.object
-
Represents the various types of membership state.
- apply(GuildCreateData) - Method in interface discord4j.core.shard.MemberRequestFilter
- ArrayUtil - Class in discord4j.core.util
- ArrayUtil() - Constructor for class discord4j.core.util.ArrayUtil
- as(Function<Mono<Boolean>, Mono<Boolean>>) - Method in interface discord4j.core.shard.MemberRequestFilter
-
Transform this current
MemberRequestFilter
by applying the givenFunction
to derive a newMono
ofboolean
. - asBoolean() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asChannel() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asCustomEmoji() - Method in class discord4j.core.object.reaction.ReactionEmoji
-
Gets this emoji as downcasted to
a custom reaction emoji
. - asDouble() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asDouble() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Gets the value of this choice as a double.
- asEmojiData() - Method in class discord4j.core.object.reaction.ReactionEmoji
-
Converts this
ReactionEmoji
to aEmojiData
. - asEmojiData() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
- asEmojiData() - Method in class discord4j.core.object.reaction.ReactionEmoji.Unicode
- asFormat() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the formatted version of this emoji (i.e., to display in the client).
- asFormat() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
-
Gets the formatted version of this emoji (i.e., to display in the client).
- asLong() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asLong() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Gets the value of this choice as a long.
- asMember(Snowflake) - Method in class discord4j.core.object.entity.Member
- asMember(Snowflake) - Method in class discord4j.core.object.entity.User
-
Requests to retrieve this user as a
Member
. - asMember(Snowflake, EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.User
-
Requests to retrieve this user as a
Member
, using the given retrieval strategy. - asRequest() - Method in class discord4j.core.spec.AuditLogQuerySpec
- asRequest() - Method in class discord4j.core.spec.BanQuerySpec
- asRequest() - Method in class discord4j.core.spec.CategoryCreateSpec
- asRequest() - Method in class discord4j.core.spec.CategoryEditSpec
- asRequest() - Method in class discord4j.core.spec.EmbedCreateSpec
- asRequest() - Method in class discord4j.core.spec.GuildCreateFromTemplateSpec
- asRequest() - Method in class discord4j.core.spec.GuildCreateSpec
- asRequest() - Method in class discord4j.core.spec.GuildEditSpec
- asRequest() - Method in class discord4j.core.spec.GuildEmojiCreateSpec
- asRequest() - Method in class discord4j.core.spec.GuildEmojiEditSpec
- asRequest() - Method in class discord4j.core.spec.GuildMemberEditSpec
- asRequest() - Method in class discord4j.core.spec.GuildPruneCountSpec
- asRequest() - Method in class discord4j.core.spec.GuildPruneSpec
- asRequest() - Method in class discord4j.core.spec.GuildTemplateCreateSpec
- asRequest() - Method in class discord4j.core.spec.GuildTemplateEditSpec
- asRequest() - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- asRequest() - Method in class discord4j.core.spec.InviteCreateSpec
- asRequest() - Method in class discord4j.core.spec.MessageCreateSpec
- asRequest() - Method in class discord4j.core.spec.MessageEditSpec
- asRequest() - Method in class discord4j.core.spec.MessageReferenceSpec
- asRequest() - Method in class discord4j.core.spec.NewsChannelCreateSpec
- asRequest() - Method in class discord4j.core.spec.NewsChannelEditSpec
- asRequest() - Method in class discord4j.core.spec.RoleCreateSpec
- asRequest() - Method in class discord4j.core.spec.RoleEditSpec
- asRequest() - Method in interface discord4j.core.spec.Spec
- asRequest() - Method in class discord4j.core.spec.StoreChannelEditSpec
- asRequest() - Method in class discord4j.core.spec.TextChannelCreateSpec
- asRequest() - Method in class discord4j.core.spec.TextChannelEditSpec
- asRequest() - Method in class discord4j.core.spec.UserEditSpec
- asRequest() - Method in class discord4j.core.spec.VoiceChannelCreateSpec
- asRequest() - Method in class discord4j.core.spec.VoiceChannelEditSpec
- asRequest() - Method in class discord4j.core.spec.VoiceChannelJoinSpec
- asRequest() - Method in class discord4j.core.spec.WebhookCreateSpec
- asRequest() - Method in class discord4j.core.spec.WebhookEditSpec
- asRole() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asSnowflake() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asStatusUpdate() - Method in class discord4j.core.object.presence.Presence
-
Convert a received
Presence
into aStatusUpdate
that can be used for sending an update. - asString() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- asString() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Gets the value of this choice as a string.
- asUnicodeEmoji() - Method in class discord4j.core.object.reaction.ReactionEmoji
-
Gets this emoji downcasted to
a unicode reaction emoji
. - asUser() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- Attachment - Class in discord4j.core.object.entity
-
A Discord attachment.
- Attachment(GatewayDiscordClient, AttachmentData) - Constructor for class discord4j.core.object.entity.Attachment
-
Constructs an
Attachment
with an associatedGatewayDiscordClient
and Discord data. - AuditLogChange<T> - Class in discord4j.core.object.audit
- AuditLogChange(T, T) - Constructor for class discord4j.core.object.audit.AuditLogChange
- AuditLogEntry - Class in discord4j.core.object.audit
- AuditLogEntry(GatewayDiscordClient, AuditLogEntryData) - Constructor for class discord4j.core.object.audit.AuditLogEntry
- AuditLogQuerySpec - Class in discord4j.core.spec
-
A spec used to query audit log entries that match the specified filter.
- AuditLogQuerySpec() - Constructor for class discord4j.core.spec.AuditLogQuerySpec
- AuditLogUtil - Class in discord4j.core.util
- AuditLogUtil() - Constructor for class discord4j.core.util.AuditLogUtil
- AuditSpec<T> - Interface in discord4j.core.spec
-
A spec which can optionally have a reason in the audit logs when built.
- AUTO - discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Discord chooses the quality for optimal performance.
- AUTOMATIC - discord4j.core.object.Region.Id
B
- ban(Snowflake, Consumer<? super BanQuerySpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to ban the specified user.
- ban(Consumer<? super BanQuerySpec>) - Method in class discord4j.core.object.entity.Member
-
Requests to ban this user.
- Ban - Class in discord4j.core.object
-
A Discord ban.
- Ban(GatewayDiscordClient, BanData) - Constructor for class discord4j.core.object.Ban
-
Constructs a
Ban
with an associatedGatewayDiscordClient
and Discord data. - BanEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a user is banned from a guild.
- BanEvent(GatewayDiscordClient, ShardInfo, User, long) - Constructor for class discord4j.core.event.domain.guild.BanEvent
- BANNER - Static variable in class discord4j.core.object.audit.ChangeKey
-
Banner changed
- BanQuerySpec - Class in discord4j.core.spec
-
A spec used to configure a user ban.
- BanQuerySpec() - Constructor for class discord4j.core.spec.BanQuerySpec
- BITRATE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Voice channel bitrate changed
- BOOLEAN - discord4j.core.object.command.ApplicationCommandOption.Type
- BOT_ADD - discord4j.core.object.audit.ActionType
- BRAZIL - discord4j.core.object.Region.Id
- BUCKETED_CHANNEL_ORDER - Static variable in class discord4j.core.util.OrderUtil
-
The ordering of
guild channels
which considers channel type. - buffering() - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that will buffer incoming events to retain all startup events as each shard connects at the cost of increased memory usage and potentialOutOfMemoryError
if events are not consumed. - BUG_HUNTER_LEVEL_1 - discord4j.core.object.entity.User.Flag
- BUG_HUNTER_LEVEL_2 - discord4j.core.object.entity.User.Flag
- build() - Method in class discord4j.core.DiscordClientBuilder
-
Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a
DefaultRouter
that is capable of working in monolithic environments. - build() - Method in class discord4j.core.event.DefaultEventDispatcher.Builder
- build() - Method in interface discord4j.core.event.EventDispatcher.Builder
-
Create the
EventDispatcher
- build() - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
- build() - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Create the
ShardingStrategy
. - build(Function<O, Router>) - Method in class discord4j.core.DiscordClientBuilder
-
Create a client capable of connecting to Discord REST API and to establish Gateway and Voice Gateway connections, using a custom
Router
factory. - builder() - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
builder. - builder() - Static method in class discord4j.core.event.ReplayingEventDispatcher
-
Return a new builder for
ReplayingEventDispatcher
. - builder() - Static method in interface discord4j.core.shard.ShardingStrategy
-
Return a builder to customize the
ShardingStrategy
using commonly used parameters. - builder(String) - Static method in class discord4j.core.DiscordClient
-
Obtain a
DiscordClientBuilder
able to createDiscordClient
instances, using the given token for authentication. - Builder() - Constructor for class discord4j.core.event.DefaultEventDispatcher.Builder
- Builder() - Constructor for class discord4j.core.event.ReplayingEventDispatcher.Builder
- Builder() - Constructor for class discord4j.core.shard.DefaultShardingStrategy.Builder
- bulkDelete(Publisher<Snowflake>) - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Requests to bulk delete the supplied message IDs.
- bulkDeleteMessages(Publisher<Message>) - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Requests to bulk delete the supplied messages.
- Button - Class in discord4j.core.object.component
-
A message button.
- BUTTON - discord4j.core.object.component.MessageComponent.Type
- Button.Style - Enum in discord4j.core.object.component
-
A button's style is what determines its color and whether it has a custom id or a url.
- ButtonInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user interacts with a
Button
the bot has sent. - ButtonInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.ButtonInteractionEvent
C
- CALL - discord4j.core.object.entity.Message.Type
-
A message created when a call was started.
- CategorizableChannel - Interface in discord4j.core.object.entity.channel
-
A Discord channel which can be categorized into a
Category
. - Category - Class in discord4j.core.object.entity.channel
-
A Discord category.
- Category(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.Category
-
Constructs an
Category
with an associatedGatewayDiscordClient
and Discord data. - CategoryCreateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
Category
is created in a guild. - CategoryCreateEvent(GatewayDiscordClient, ShardInfo, Category) - Constructor for class discord4j.core.event.domain.channel.CategoryCreateEvent
- CategoryCreateSpec - Class in discord4j.core.spec
-
A spec used to configure and create a
Category
. - CategoryCreateSpec() - Constructor for class discord4j.core.spec.CategoryCreateSpec
- CategoryDeleteEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
Category
is deleted in a guild. - CategoryDeleteEvent(GatewayDiscordClient, ShardInfo, Category) - Constructor for class discord4j.core.event.domain.channel.CategoryDeleteEvent
- CategoryEditSpec - Class in discord4j.core.spec
-
A spec used to edit an existing
Category
. - CategoryEditSpec() - Constructor for class discord4j.core.spec.CategoryEditSpec
- CategoryUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
Category
is updated in a guild. - CategoryUpdateEvent(GatewayDiscordClient, ShardInfo, Category, Category) - Constructor for class discord4j.core.event.domain.channel.CategoryUpdateEvent
- changeCollector() - Static method in class discord4j.core.util.AuditLogUtil
- ChangeKey<T> - Class in discord4j.core.object.audit
-
Represents the various audit log change key.
- changePosition(int) - Method in class discord4j.core.object.entity.Role
-
Requests to change this role's position.
- changeSelfNickname(String) - Method in class discord4j.core.object.entity.Guild
-
Requests to change the bot user's nickname in this guild.
- Channel - Interface in discord4j.core.object.entity.channel
-
A Discord channel.
- CHANNEL - discord4j.core.object.command.ApplicationCommandOption.Type
- CHANNEL_CREATE - discord4j.core.object.audit.ActionType
- CHANNEL_DELETE - discord4j.core.object.audit.ActionType
- CHANNEL_FOLLOW_ADD - discord4j.core.object.entity.Message.Type
-
A message created when a user follows a channel from another guild into specific channel ( Server Following).
- CHANNEL_FOLLOWER - discord4j.core.object.entity.Webhook.Type
-
Channel Follower Webhooks are internal webhooks used with Channel Following to post new messages into channels.
- CHANNEL_ICON_CHANGE - discord4j.core.object.entity.Message.Type
-
A message created when a channel's icon changed.
- CHANNEL_ID - Static variable in class discord4j.core.object.audit.OptionKey
-
Channel in which the entities were targeted.
- CHANNEL_NAME_CHANGE - discord4j.core.object.entity.Message.Type
-
A message created when a channel's name changed.
- CHANNEL_ORDER - Static variable in class discord4j.core.util.OrderUtil
-
The base ordering of Discord
guild channels
. - CHANNEL_OVERWRITE_CREATE - discord4j.core.object.audit.ActionType
- CHANNEL_OVERWRITE_DELETE - discord4j.core.object.audit.ActionType
- CHANNEL_OVERWRITE_UPDATE - discord4j.core.object.audit.ActionType
- CHANNEL_PINNED_MESSAGE - discord4j.core.object.entity.Message.Type
-
A message created when a message was pinned.
- CHANNEL_TYPE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Type of entity created
- CHANNEL_UPDATE - discord4j.core.object.audit.ActionType
- Channel.Type - Enum in discord4j.core.object.entity.channel
-
Represents the various types of channels.
- ChannelEvent - Class in discord4j.core.event.domain.channel
-
Represents an event related to a
Channel
. - ChannelEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.channel.ChannelEvent
- CHAT_INPUT - discord4j.core.object.command.ApplicationCommand.Type
- ChatInputInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user uses a chat input command (formerly "slash command").
- ChatInputInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.ChatInputInteractionEvent
- clear(int) - Method in class discord4j.core.shard.JdkKeyStore
- clear(int) - Method in interface discord4j.core.shard.KeyStore
-
Removes all keys stored under a given shard index.
- codepoints(String...) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
for a unicode emoji. - COLOR - Static variable in class discord4j.core.object.audit.ChangeKey
-
Role color changed
- competing(String) - Static method in class discord4j.core.object.presence.Activity
- COMPETING - discord4j.core.object.presence.Activity.Type
-
"Competing in {name}"
- ComponentInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user interacts with a
MessageComponent
the bot has sent. - ComponentInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.ComponentInteractionEvent
- computeBasePermissions(PermissionSet, List<PermissionSet>) - Static method in class discord4j.core.util.PermissionUtil
-
Computes the permissions granted by a member's roles.
- computePermissions(PermissionSet, PermissionOverwrite, List<PermissionOverwrite>, PermissionOverwrite) - Static method in class discord4j.core.util.PermissionUtil
-
Computes the permissions of a member taking into account permission overwrites.
- ConnectEvent - Class in discord4j.core.event.domain.lifecycle
-
Indicates that a gateway connection is successful.
- ConnectEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.lifecycle.ConnectEvent
- contains(long[], long) - Static method in class discord4j.core.util.ArrayUtil
- containsStore(Class<?>) - Method in class discord4j.core.shard.JdkKeyStoreRegistry
- containsStore(Class<?>) - Method in interface discord4j.core.shard.KeyStoreRegistry
-
Return if this registry contains a
Store
instance for the given value class. - CONTENT_FILTER_LEVEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Change in whose messages are scanned and deleted for explicit content in the server
- CoreResources - Class in discord4j.core
-
A set of resources required to build
DiscordClient
instances and are used for core Discord4J operations like entity manipulation and API communication. - CoreResources(String, ReactorResources, JacksonResources, Router, AllowedMentions) - Constructor for class discord4j.core.CoreResources
-
Create a
CoreResources
instance with the given resources. - count() - Method in class discord4j.core.shard.ShardAwareStore
- count(int) - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Set the shard count parameter.
- COUNT - Static variable in class discord4j.core.object.audit.OptionKey
-
Number of entities that were targeted.
- create() - Static method in class discord4j.core.event.ReplayingEventDispatcher
-
Return a new default
ReplayingEventDispatcher
. - create() - Static method in class discord4j.core.shard.LocalShardCoordinator
-
Create a new
LocalShardCoordinator
that is able to locally coordinate multiple shards under a single JVM instance. - create(DiscordClient) - Static method in class discord4j.core.shard.GatewayBootstrap
-
Create a default
GatewayBootstrap
based off the givenDiscordClient
that provides an instance ofCoreResources
used to provide defaults while building aGatewayDiscordClient
. - create(String) - Static method in class discord4j.core.DiscordClient
-
Create a
DiscordClient
with default options, using the given token for authentication. - create(String) - Static method in class discord4j.core.DiscordClientBuilder
-
Initialize a new builder with the given token.
- create(Supplier<PayloadTransformer>) - Static method in class discord4j.core.shard.LocalShardCoordinator
-
Create a new
LocalShardCoordinator
that is able to locally coordinate multiple shards under a single JVM instance. - createCategory(Consumer<? super CategoryCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a category.
- createEmbed(Consumer<? super EmbedCreateSpec>) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to create a message with only an
MessageCreateSpec.setEmbed(Consumer)
. - createEmoji(Consumer<? super GuildEmojiCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create an emoji.
- createGuild(Consumer<? super GuildCreateFromTemplateSpec>) - Method in class discord4j.core.object.GuildTemplate
-
Requests to create a new guild from this template.
- createGuild(Consumer<? super GuildCreateSpec>) - Method in class discord4j.core.GatewayDiscordClient
-
Requests to create a guild.
- createInteractionResponse(InteractionResponseType, InteractionApplicationCommandCallbackData) - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
- createInvite(Consumer<? super InviteCreateSpec>) - Method in interface discord4j.core.object.entity.channel.CategorizableChannel
-
Requests to create an invite.
- createMessage(String) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to create a message with only
content
. - createMessage(Consumer<? super MessageCreateSpec>) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to create a message.
- createNewsChannel(Consumer<? super NewsChannelCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a news channel.
- createOptionMap(AuditEntryInfoData) - Static method in class discord4j.core.util.AuditLogUtil
- createRole(Consumer<? super RoleCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a role.
- createTemplate(Consumer<? super GuildTemplateCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a template based on this guild.
- createTextChannel(Consumer<? super TextChannelCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a text channel.
- createVoiceChannel(Consumer<? super VoiceChannelCreateSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to create a voice channel.
- createWebhook(Consumer<? super WebhookCreateSpec>) - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Requests to create a webhook.
- CROSSPOSTED - discord4j.core.object.entity.Message.Flag
-
This message has been published to subscribed channels (via Channel Following).
- custom(Snowflake, String, boolean) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
for a custom emoji using the given information. - custom(GuildEmoji) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
using information from aknown guild emoji
. - CUSTOM - discord4j.core.object.presence.Activity.Type
-
{emoji} {name}
D
- danger(String, ReactionEmoji) - Static method in class discord4j.core.object.component.Button
-
Creates a
danger
button. - danger(String, ReactionEmoji, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
danger
button. - danger(String, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
danger
button. - DANGER - discord4j.core.object.component.Button.Style
- DEFAULT - discord4j.core.object.entity.Guild.NsfwLevel
- DEFAULT - discord4j.core.object.entity.Message.Type
-
A message created by a user.
- DEFAULT - Static variable in interface discord4j.core.shard.MemberRequestFilter
-
Request members from all large guilds.
- DEFAULT_COLOR - Static variable in class discord4j.core.object.entity.Role
-
The default
Color
of aRole
. - DEFAULT_EVENT_SCHEDULER - Static variable in interface discord4j.core.event.EventDispatcher
- DEFAULT_IDENTIFY_LIMITER_FACTORY - Static variable in class discord4j.core.shard.LocalShardCoordinator
- DefaultEventDispatcher - Class in discord4j.core.event
-
Distributes events to subscribers using a Reactor
FluxProcessor
as backend. - DefaultEventDispatcher(FluxProcessor<Event, Event>, FluxSink.OverflowStrategy, Scheduler) - Constructor for class discord4j.core.event.DefaultEventDispatcher
-
Creates a new event dispatcher using the given
FluxProcessor
, backpressure-handling strategy and threading model. - DefaultEventDispatcher.Builder - Class in discord4j.core.event
-
A builder to create
EventDispatcher
instances. - DefaultShardingStrategy - Class in discord4j.core.shard
- DefaultShardingStrategy(DefaultShardingStrategy.Builder) - Constructor for class discord4j.core.shard.DefaultShardingStrategy
- DefaultShardingStrategy.Builder - Class in discord4j.core.shard
-
A
ShardingStrategy
builder. - defaultVoiceConnectionFactory() - Static method in class discord4j.core.shard.GatewayBootstrap
-
Create a
VoiceConnectionFactory
with reconnecting capabilities. - delete() - Method in interface discord4j.core.object.entity.channel.Channel
-
Requests to delete this channel.
- delete() - Method in class discord4j.core.object.entity.Guild
-
Requests to delete this guild.
- delete() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to delete this emoji.
- delete() - Method in class discord4j.core.object.entity.Message
-
Requests to delete this message.
- delete() - Method in class discord4j.core.object.entity.Role
-
Requests to delete this role.
- delete() - Method in class discord4j.core.object.entity.Webhook
-
Requests to delete this webhook.
- delete() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to delete this permission overwrite.
- delete() - Method in class discord4j.core.object.GuildTemplate
-
Requests to delete this template.
- delete() - Method in class discord4j.core.object.Invite
-
Requests to delete this invite.
- delete(String) - Method in interface discord4j.core.object.entity.channel.Channel
-
Requests to delete this channel while optionally specifying a reason.
- delete(String) - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to delete this emoji while optionally specifying a reason.
- delete(String) - Method in class discord4j.core.object.entity.Message
-
Requests to delete this message while optionally specifying a reason.
- delete(String) - Method in class discord4j.core.object.entity.Role
-
Requests to delete this role while optionally specifying the reason.
- delete(String) - Method in class discord4j.core.object.entity.Webhook
-
Requests to delete this webhook while optionally specifying a reason.
- delete(String) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to delete this permission overwrite while optionally specifying a reason.
- delete(String) - Method in class discord4j.core.object.Invite
-
Requests to delete this invite while optionally specifying a reason.
- delete(K) - Method in class discord4j.core.shard.ShardAwareStore
- delete(Publisher<K>) - Method in class discord4j.core.shard.ShardAwareStore
- DELETE_MEMBER_DAYS - Static variable in class discord4j.core.object.audit.OptionKey
-
Number of days after which inactive members were kicked.
- deleteAll() - Method in class discord4j.core.shard.ShardAwareStore
- deleteInRange(K, K) - Method in class discord4j.core.shard.ShardAwareStore
- DENY - Static variable in class discord4j.core.object.audit.ChangeKey
-
A permission on a text or voice channel was denied for a role
- DESCRIPTION - Static variable in class discord4j.core.object.audit.ChangeKey
-
Description changed
- DESKTOP - discord4j.core.object.presence.Status.Platform
- disable() - Static method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Create an
InvalidationStrategy
that disables any action on shard invalidation. - disabled() - Method in class discord4j.core.object.component.Button
-
Creates a new button with the same data as this one, but disabled.
- disabled() - Method in class discord4j.core.object.component.SelectMenu
-
Creates a new select menu with the same data as this one, but disabled.
- disabled(boolean) - Method in class discord4j.core.object.component.Button
-
Creates a new button with the same data as this one, but depending on the value param it may be disabled or not.
- disabled(boolean) - Method in class discord4j.core.object.component.SelectMenu
-
Creates a new select menu with the same data as this one, but depending on the value param it may be disabled or not.
- DISABLED - discord4j.core.object.entity.Guild.ContentFilterLevel
-
Don't scan any messages.
- discardEvents() - Static method in interface discord4j.core.event.dispatch.DispatchEventMapper
-
Create a
DispatchEventMapper
that processes updates and records them into the rightStore
, while not producing anyEvent
downstream. - DisconnectEvent - Class in discord4j.core.event.domain.lifecycle
-
Indicates that a gateway connection is disconnected.
- DisconnectEvent(GatewayDiscordClient, ShardInfo, CloseStatus, Throwable) - Constructor for class discord4j.core.event.domain.lifecycle.DisconnectEvent
- DISCORD_CERTIFIED_MODERATOR - discord4j.core.object.entity.User.Flag
- DISCORD_EMPLOYEE - discord4j.core.object.entity.User.Flag
- DISCORD_EPOCH - Static variable in class discord4j.core.util.EntityUtil
-
Deprecated.
- DISCORD_PARTNER - discord4j.core.object.entity.User.Flag
- discord4j.core - package discord4j.core
-
Components used to build and interact with Discord4J clients.
- discord4j.core.event - package discord4j.core.event
-
Discord event domain model.
- discord4j.core.event.dispatch - package discord4j.core.event.dispatch
-
Mappers between
Dispatch
andEvent
. - discord4j.core.event.domain - package discord4j.core.event.domain
-
Domain model for general events.
- discord4j.core.event.domain.channel - package discord4j.core.event.domain.channel
-
Domain model for channel events.
- discord4j.core.event.domain.command - package discord4j.core.event.domain.command
-
Domain model for application command events.
- discord4j.core.event.domain.guild - package discord4j.core.event.domain.guild
-
Domain model for guild events.
- discord4j.core.event.domain.integration - package discord4j.core.event.domain.integration
-
Domain model for integration events.
- discord4j.core.event.domain.interaction - package discord4j.core.event.domain.interaction
- discord4j.core.event.domain.lifecycle - package discord4j.core.event.domain.lifecycle
-
Domain model for gateway lifecycle events.
- discord4j.core.event.domain.message - package discord4j.core.event.domain.message
-
Domain model for message events.
- discord4j.core.event.domain.role - package discord4j.core.event.domain.role
-
Domain model for role events.
- discord4j.core.object - package discord4j.core.object
-
Discord entity and object domain model.
- discord4j.core.object.audit - package discord4j.core.object.audit
-
Classes representing the audit log domain model.
- discord4j.core.object.command - package discord4j.core.object.command
-
Classes representing the audit log domain model.
- discord4j.core.object.component - package discord4j.core.object.component
- discord4j.core.object.entity - package discord4j.core.object.entity
-
Discord entity domain model.
- discord4j.core.object.entity.channel - package discord4j.core.object.entity.channel
- discord4j.core.object.presence - package discord4j.core.object.presence
-
Classes supporting presence functionality.
- discord4j.core.object.reaction - package discord4j.core.object.reaction
-
Classes supporting reaction functionality like
ReactionEmoji
- discord4j.core.retriever - package discord4j.core.retriever
- discord4j.core.shard - package discord4j.core.shard
-
Core components for building grouped shard clients.
- discord4j.core.spec - package discord4j.core.spec
-
Spec
contract and implementations to build requests to Discord. - discord4j.core.state - package discord4j.core.state
-
Components to hold and safely expose entity caches.
- discord4j.core.util - package discord4j.core.util
-
Core utilities to manipulate objects.
- DiscordClient - Class in discord4j.core
-
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> - Class in discord4j.core
-
Builder suited for creating a
DiscordClient
. - DiscordObject - Interface in discord4j.core.object
-
An object characterized by the Discord platform.
- DISCOVERY_SPLASH - Static variable in class discord4j.core.object.audit.ChangeKey
-
Discovery splash changed
- DispatchContext<D> - Class in discord4j.core.event.dispatch
-
Represents gateway dispatch data enriched with context for processing through a
DispatchHandler
defined underDispatchHandlers
. - DispatchEventMapper - Interface in discord4j.core.event.dispatch
-
A transformation between Gateway inbound Dispatch class of payloads to Discord4J core
Event
instances. - DispatchHandler<D,E extends Event> - Interface in discord4j.core.event.dispatch
-
Handler for the gateway Dispatch events.
- DispatchHandlers - Class in discord4j.core.event.dispatch
-
Registry for
Dispatch
toEvent
mapping operations. - DispatchHandlers() - Constructor for class discord4j.core.event.dispatch.DispatchHandlers
- dispose() - Method in class discord4j.core.shard.ShardAwareStoreService
- DM - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
PrivateChannel
. - DO_NOT_DISTURB - discord4j.core.object.presence.Status
- doNotDisturb() - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display a do-not-disturb status.
- doNotDisturb(ActivityUpdateRequest) - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display a do-not-disturb status along with a custom activity.
E
- EARLY_SUPPORTER - discord4j.core.object.entity.User.Flag
- edit(Consumer<? super CategoryEditSpec>) - Method in class discord4j.core.object.entity.channel.Category
-
Requests to edit this category.
- edit(Consumer<? super GuildEditSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to edit this guild.
- edit(Consumer<? super GuildEmojiEditSpec>) - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to edit this guild emoji.
- edit(Consumer<? super GuildMemberEditSpec>) - Method in class discord4j.core.object.entity.Member
-
Requests to edit this member.
- edit(Consumer<? super GuildTemplateEditSpec>) - Method in class discord4j.core.object.GuildTemplate
-
Requests to edit this guild template.
- edit(Consumer<? super InteractionApplicationCommandCallbackSpec>) - Method in class discord4j.core.event.domain.interaction.ComponentInteractionEvent
-
Requests to respond to the interaction by immediately editing the message the button is on.
- edit(Consumer<? super MessageEditSpec>) - Method in class discord4j.core.object.entity.Message
-
Requests to edit this message.
- edit(Consumer<? super NewsChannelEditSpec>) - Method in class discord4j.core.object.entity.channel.NewsChannel
-
Requests to edit this news channel.
- edit(Consumer<? super RoleEditSpec>) - Method in class discord4j.core.object.entity.Role
-
Requests to edit this role.
- edit(Consumer<? super StoreChannelEditSpec>) - Method in class discord4j.core.object.entity.channel.StoreChannel
-
Requests to edit this store channel.
- edit(Consumer<? super TextChannelEditSpec>) - Method in class discord4j.core.object.entity.channel.TextChannel
-
Requests to edit this text channel.
- edit(Consumer<? super UserEditSpec>) - Method in class discord4j.core.GatewayDiscordClient
-
Requests to edit this client (i.e., modify the current bot user).
- edit(Consumer<? super VoiceChannelEditSpec>) - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Requests to edit a voice channel.
- edit(Consumer<? super WebhookEditSpec>) - Method in class discord4j.core.object.entity.Webhook
-
Requests to edit this webhook.
- ELEVATED - discord4j.core.object.entity.Guild.MfaLevel
-
Enabled 2FA requirement.
- Embed - Class in discord4j.core.object
-
A Discord embed.
- Embed(GatewayDiscordClient, EmbedData) - Constructor for class discord4j.core.object.Embed
-
Constructs an
Embed
with an associatedGatewayDiscordClient
and Discord data. - Embed.Author - Class in discord4j.core.object
-
An image for a Discord
embed
. - Embed.Field - Class in discord4j.core.object
-
A field for a Discord
embed
. - Embed.Footer - Class in discord4j.core.object
-
A footer for a Discord
embed
. - Embed.Image - Class in discord4j.core.object
-
An image for a Discord
embed
. - Embed.Provider - Class in discord4j.core.object
-
A provider for a Discord
embed
. - Embed.Thumbnail - Class in discord4j.core.object
-
A thumbnail for a Discord
embed
. - Embed.Type - Enum in discord4j.core.object
-
Represents the various types of embeds.
- Embed.Video - Class in discord4j.core.object
-
A video for a Discord
embed
. - EmbedCreateSpec - Class in discord4j.core.spec
-
A spec used to configure and send an embed.
- EmbedCreateSpec() - Constructor for class discord4j.core.spec.EmbedCreateSpec
- EMBEDDED_APPLICATION - discord4j.core.object.Invite.Type
-
Embedded application.
- emitEvents() - Static method in interface discord4j.core.event.dispatch.DispatchEventMapper
-
Create a
DispatchEventMapper
that processes updates and records them into the rightStore
, then derives the properEvent
. - EMOJI_CREATE - discord4j.core.object.audit.ActionType
- EMOJI_DELETE - discord4j.core.object.audit.ActionType
- EMOJI_UPDATE - discord4j.core.object.audit.ActionType
- EmojisUpdateEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when an emoji is added/deleted/or edited in a guild.
- EmojisUpdateEvent(GatewayDiscordClient, ShardInfo, long, Set<GuildEmoji>, Set<GuildEmoji>) - Constructor for class discord4j.core.event.domain.guild.EmojisUpdateEvent
- ENABLE_EMOTICONS - Static variable in class discord4j.core.object.audit.ChangeKey
-
Integration emoticons enabled/disabled
- Entity - Interface in discord4j.core.object.entity
-
An uniquely identifiable object by
Snowflake
. - EntityRetrievalStrategy - Interface in discord4j.core.retriever
-
Defines the entity retrieval strategy to use for a given
GatewayDiscordClient
. - EntityRetriever - Interface in discord4j.core.retriever
-
Abstraction for entity retrieval.
- EntityUtil - Class in discord4j.core.util
-
An utility class for entity processing.
- EPHEMERAL - discord4j.core.object.entity.Message.Flag
-
This message is an ephemeral interaction response.
- equals(Entity, Object) - Static method in class discord4j.core.util.EntityUtil
-
An utility that checks for equality between an entity and a generic object.
- equals(Object) - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
- equals(Object) - Method in class discord4j.core.object.entity.ApplicationInfo
- equals(Object) - Method in class discord4j.core.object.entity.Attachment
- equals(Object) - Method in class discord4j.core.object.entity.Guild
- equals(Object) - Method in class discord4j.core.object.entity.GuildEmoji
- equals(Object) - Method in class discord4j.core.object.entity.Integration
- equals(Object) - Method in class discord4j.core.object.entity.Message
- equals(Object) - Method in class discord4j.core.object.entity.Role
- equals(Object) - Method in class discord4j.core.object.entity.User
- equals(Object) - Method in class discord4j.core.object.entity.Webhook
- equals(Object) - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
- equals(Object) - Method in class discord4j.core.object.reaction.ReactionEmoji.Unicode
- EUROPE - discord4j.core.object.Region.Id
- Event - Class in discord4j.core.event.domain
-
Represents a Discord real-time event used to track a client's state.
- Event(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.Event
- EventDispatcher - Interface in discord4j.core.event
-
Distributes events to subscribers.
- EventDispatcher.Builder - Interface in discord4j.core.event
- eventProcessor - Variable in class discord4j.core.event.DefaultEventDispatcher.Builder
- eventProcessor(FluxProcessor<Event, Event>) - Method in class discord4j.core.event.DefaultEventDispatcher.Builder
- eventProcessor(FluxProcessor<Event, Event>) - Method in interface discord4j.core.event.EventDispatcher.Builder
-
Set the underlying
FluxProcessor
the dispatcher will use to queue and distribute events. - eventProcessor(FluxProcessor<Event, Event>) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
- eventScheduler - Variable in class discord4j.core.event.DefaultEventDispatcher.Builder
- eventScheduler(Scheduler) - Method in class discord4j.core.event.DefaultEventDispatcher.Builder
- eventScheduler(Scheduler) - Method in interface discord4j.core.event.EventDispatcher.Builder
-
Set the
Scheduler
this dispatcher should use to publish events to its subscribers. - eventScheduler(Scheduler) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
- EXPIRE_BEHAVIOR - Static variable in class discord4j.core.object.audit.ChangeKey
-
Integration expiring subscriber behavior changed
- EXPIRE_GRACE_PERIOD - Static variable in class discord4j.core.object.audit.ChangeKey
-
Integration expire grace period changed
- EXPLICIT - discord4j.core.object.entity.Guild.NsfwLevel
- ExtendedInvite - Class in discord4j.core.object
-
Metadata for a Discord invite.
- ExtendedInvite(GatewayDiscordClient, InviteData) - Constructor for class discord4j.core.object.ExtendedInvite
-
Constructs a
ExtendedInvite
with an associatedGatewayDiscordClient
and Discord data. - ExtendedPermissionOverwrite - Class in discord4j.core.object
-
A Discord permission overwrite.
- ExtendedPermissionOverwrite(GatewayDiscordClient, OverwriteData, long, long) - Constructor for class discord4j.core.object.ExtendedPermissionOverwrite
-
Constructs a
ExtendedPermissionOverwrite
with an associatedGatewayDiscordClient
and Discord data.
F
- FallbackEntityRetriever - Class in discord4j.core.retriever
- FallbackEntityRetriever(EntityRetriever, EntityRetriever) - Constructor for class discord4j.core.retriever.FallbackEntityRetriever
- filter(Predicate<ShardInfo>) - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Set a filter to determine which shards should be accepted for identifying to Discord Gateway.
- find(K) - Method in class discord4j.core.shard.ShardAwareStore
- findInRange(K, K) - Method in class discord4j.core.shard.ShardAwareStore
- fixed(int) - Static method in interface discord4j.core.shard.ShardingStrategy
-
Sharding strategy that creates a fixed number of
GatewayClient
instances, using the givencount
. - follow(Snowflake) - Method in class discord4j.core.object.entity.channel.NewsChannel
-
Requests to follow this news channel.
- FollowedChannel - Class in discord4j.core.object
-
A news channel that has been followed.
- FollowedChannel(GatewayDiscordClient, FollowedChannelData) - Constructor for class discord4j.core.object.FollowedChannel
- forMember(Snowflake, PermissionSet, PermissionSet) - Static method in class discord4j.core.object.PermissionOverwrite
-
Constructs a
PermissionOverwrite
targeting aMember
. - forRole(Snowflake, PermissionSet, PermissionSet) - Static method in class discord4j.core.object.PermissionOverwrite
-
Constructs a
PermissionOverwrite
targeting aRole
. - from(ReactiveEventAdapter...) - Static method in class discord4j.core.event.ReactiveEventAdapter
-
Create a composite
ReactiveEventAdapter
from multiple adapters. - fromData(ComponentData) - Static method in class discord4j.core.object.component.MessageComponent
-
Constructs a
MessageComponent
from raw data. - FULL - discord4j.core.object.entity.channel.VoiceChannel.Mode
-
720p
G
- gateway() - Method in class discord4j.core.DiscordClient
-
Start bootstrapping a connection to the real-time Discord Gateway.
- GatewayBootstrap<O extends GatewayOptions> - Class in discord4j.core.shard
-
Builder to create a shard group connecting to Discord Gateway to produce a
GatewayDiscordClient
. - GatewayDiscordClient - Class in discord4j.core
-
An aggregation of all dependencies Discord4J requires to operate with the Discord Gateway, REST API and Voice Gateway.
- GatewayDiscordClient(DiscordClient, GatewayResources, MonoProcessor<Void>, GatewayClientGroup, VoiceConnectionFactory, EntityRetrievalStrategy) - Constructor for class discord4j.core.GatewayDiscordClient
- GatewayLifecycleEvent - Class in discord4j.core.event.domain.lifecycle
-
Represents a lifecycle status change for a gateway connection.
- GatewayLifecycleEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.lifecycle.GatewayLifecycleEvent
- GatewayResources - Class in discord4j.core
-
A set of dependencies required to build and coordinate multiple
GatewayClient
instances. - GatewayResources(StateView, EventDispatcher, ShardCoordinator, MemberRequestFilter, GatewayReactorResources, VoiceReactorResources, ReconnectOptions, Possible<IntentSet>, Duration) - Constructor for class discord4j.core.GatewayResources
-
Create a new
GatewayResources
with the given parameters. - getAccount() - Method in class discord4j.core.object.entity.Integration
-
Gets the integration account information.
- getActionType() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets type of action that occurred.
- getActivities() - Method in class discord4j.core.object.presence.Presence
-
Get the user's current activities.
- getActivity() - Method in class discord4j.core.object.presence.Presence
-
Get a user's current activity, if present.
- getAfkChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the AFK channel, if present.
- getAfkChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the AFK channel, if present, using the given retrieval strategy.
- getAfkChannelId() - Method in class discord4j.core.object.entity.Guild
-
Gets the ID of the AFK channel, if present.
- getAfkTimeout() - Method in class discord4j.core.object.entity.Guild
-
Gets the AFK timeout in seconds.
- getAllowed() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the permissions explicitly allowed by this overwrite.
- getApplication() - Method in class discord4j.core.object.entity.Integration
-
Gets the bot/OAuth2 application for discord integrations, if present.
- getApplicationCommandType() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the type of the invoked command.
- getApplicationId() - Method in class discord4j.core.event.domain.integration.IntegrationDeleteEvent
-
Gets the id of the bot/OAuth2 application for this discord integration, if present.
- getApplicationId() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets the unique id of the parent application.
- getApplicationId() - Method in class discord4j.core.object.command.Interaction
-
Gets the id of the application this interaction is for.
- getApplicationId() - Method in class discord4j.core.object.entity.Guild
-
Gets the application ID of the guild creator if it is bot-created.
- getApplicationId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the bot/OAuth2 application ID that created this webhook.
- getApplicationId() - Method in class discord4j.core.object.presence.Activity
-
Gets the application ID for the game, if present.
- getApplicationInfo() - Method in class discord4j.core.GatewayDiscordClient
-
Requests to retrieve the application info.
- getApproximateMemberCount() - Method in class discord4j.core.object.Invite
-
Gets an approximate count of total members, returned from the
Routes.INVITE_GET
endpoint whenwith_counts
is true. - getApproximatePresenceCount() - Method in class discord4j.core.object.Invite
-
Gets an approximate count of online members, returned from the
Routes.INVITE_GET
endpoint whenwith_counts
is true. - getAttachments() - Method in class discord4j.core.object.entity.Message
-
Gets any attached files, with the same order as in the message.
- getAuditLog() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the audit log for this guild.
- getAuditLog(Consumer<? super AuditLogQuerySpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the audit log for this guild.
- getAuthor() - Method in class discord4j.core.object.Embed
-
Gets the author information, if present.
- getAuthor() - Method in class discord4j.core.object.entity.Message
-
Gets the author of this message, if present.
- getAuthorAsMember() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the author of this message as a
member
of the guild in which it was sent. - getAvatar() - Method in class discord4j.core.object.entity.User
-
Gets the user's effective avatar.
- getAvatar() - Method in class discord4j.core.object.entity.Webhook
-
Gets the avatar of this webhook, if present.
- getAvatar(Image.Format) - Method in class discord4j.core.object.entity.User
-
Gets the user's avatar.
- getAvatarUrl() - Method in class discord4j.core.object.entity.User
-
Gets the user's effective avatar URL.
- getAvatarUrl(Image.Format) - Method in class discord4j.core.object.entity.User
-
Gets the user's avatar URL, if present.
- getBan(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the ban for the specified user for this guild.
- getBanner(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the banner of the guild.
- getBannerUrl(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the banner URL of the guild, if present.
- getBans() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve all the bans for this guild.
- getBasePermissions() - Method in class discord4j.core.object.entity.Member
-
Requests to calculate the permissions granted to this member by his roles in the guild.
- getBitrate() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Gets the bitrate (in bits) for this voice channel.
- getBot() - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the bot associated with this application, if present.
- getBotId() - Method in class discord4j.core.object.RoleTags
-
Gets the id of the bot this role belongs to, if present.
- getCategory() - Method in class discord4j.core.event.domain.channel.CategoryCreateEvent
-
Gets the
Category
that was created in this event. - getCategory() - Method in class discord4j.core.event.domain.channel.CategoryDeleteEvent
-
Gets the
Category
that was deleted in this event. - getCategory() - Method in interface discord4j.core.object.entity.channel.CategorizableChannel
-
Requests to retrieve the category for this channel, if present.
- getCategory(EntityRetrievalStrategy) - Method in interface discord4j.core.object.entity.channel.CategorizableChannel
-
Requests to retrieve the category for this channel, if present, using the given retrieval strategy.
- getCategoryId() - Method in interface discord4j.core.object.entity.channel.CategorizableChannel
-
Gets the ID of the category for this channel, if present.
- getCause() - Method in class discord4j.core.event.domain.lifecycle.DisconnectEvent
- getChange(ChangeKey<T>) - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the changes made to the target id, if present.
- getChannel() - Method in class discord4j.core.event.domain.channel.NewsChannelCreateEvent
-
Gets the
NewsChannel
that was created in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.NewsChannelDeleteEvent
-
Gets the
NewsChannel
that was deleted in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
-
Requests to retrieve the
MessageChannel
the pinned/unpinnedMessage
is in. - getChannel() - Method in class discord4j.core.event.domain.channel.PrivateChannelCreateEvent
-
Deprecated.Gets the
PrivateChannel
that was created in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.PrivateChannelDeleteEvent
-
Gets the
PrivateChannel
that was deleted in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.StoreChannelCreateEvent
-
Gets the
StoreChannel
that was created in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.StoreChannelDeleteEvent
-
Gets the
StoreChannel
that was deleted in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.TextChannelCreateEvent
-
Gets the
TextChannel
that was created in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.TextChannelDeleteEvent
-
Gets the
TextChannel
that was deleted in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Requests to retrieve the
MessageChannel
the user has started typing in. - getChannel() - Method in class discord4j.core.event.domain.channel.VoiceChannelCreateEvent
-
Gets the
VoiceChannel
that was created in this event. - getChannel() - Method in class discord4j.core.event.domain.channel.VoiceChannelDeleteEvent
-
Gets the
VoiceChannel
that has been deleted in this event. - getChannel() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Requests to retrieve the
TextChannel
representation of theChannel
the messages were deleted in. - getChannel() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
-
Requests to retrieve the
MessageChannel
theMessage
was deleted from. - getChannel() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Requests to retrieve the
MessageChannel
containing the updatedMessage
in this event. - getChannel() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Requests to retrieve the
MessageChannel
theMessage
and reaction are in. - getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
-
Requests to retrieve the
MessageChannel
containing theMessage
and the removed reactions. - getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
Requests to retrieve the
MessageChannel
containing theMessage
the reaction was removed from. - getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
Requests to retrieve the
MessageChannel
containing theMessage
the reaction was removed from. - getChannel() - Method in class discord4j.core.event.domain.WebhooksUpdateEvent
-
Requests to retrieve the
TextChannel
the webhook belongs to. - getChannel() - Method in class discord4j.core.object.command.Interaction
-
Gets the channel it was sent from.
- getChannel() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the channel the message was sent in.
- getChannel() - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the channel this webhook is associated to.
- getChannel() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the channel associated to this overwrite.
- getChannel() - Method in class discord4j.core.object.Invite
-
Requests to retrieve the channel this invite is associated to.
- getChannel() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the channel this user is connected to, if present.
- getChannel(GatewayDiscordClient, ChannelData) - Static method in class discord4j.core.util.EntityUtil
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the channel the message was sent in, using the given retrieval strategy.
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the channel this webhook is associated to, using the given retrieval strategy.
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the channel associated to this overwrite, using the given retrieval strategy.
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Requests to retrieve the channel this invite is associated to, using the given retrieval strategy.
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the channel this user is connected to, if present, using the given retrieval strategy.
- getChannelById(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getChannelById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel as represented by the supplied ID.
- getChannelById(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the channel represented by the supplied ID.
- getChannelById(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getChannelById(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getChannelById(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getChannelById(Snowflake, EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel as represented by the supplied ID, using the given retrieval strategy.
- getChannelId() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
- getChannelId() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Gets the
Snowflake
ID of theMessageChannel
the user has started typing in. - getChannelId() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the
Snowflake
ID of the channel the invite is for. - getChannelId() - Method in class discord4j.core.event.domain.InviteDeleteEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Gets the
Snowflake
ID of theTextChannel
the messages were deleted in. - getChannelId() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- getChannelId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- getChannelId() - Method in class discord4j.core.event.domain.WebhooksUpdateEvent
-
Gets the
Snowflake
ID of the channel the webhook belongs to. - getChannelId() - Method in class discord4j.core.object.command.Interaction
-
Gets the channel id it was sent from.
- getChannelId() - Method in class discord4j.core.object.entity.Message
-
Gets the ID of the channel the message was sent in.
- getChannelId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the ID of the channel this webhook is associated to.
- getChannelId() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Gets the ID of the channel associated to this overwrite.
- getChannelId() - Method in class discord4j.core.object.Invite
-
Gets the ID of the channel this invite is associated to.
- getChannelId() - Method in class discord4j.core.object.MessageReference
- getChannelId() - Method in class discord4j.core.object.VoiceState
-
Gets the channel ID this user is connected to, if present.
- getChannels() - Method in class discord4j.core.object.entity.channel.Category
-
Requests to retrieve the channels residing in this category.
- getChannels() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's channels.
- getChannels(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.channel.Category
-
Requests to retrieve the channels residing in this category, using the given retrieval strategy.
- getChannels(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's channels, using the given retrieval strategy.
- getChannelStore() - Method in class discord4j.core.state.StateHolder
- getChannelStore() - Method in class discord4j.core.state.StateView
- getChildren() - Method in class discord4j.core.object.component.LayoutComponent
- getChoice(String) - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the choice corresponding to the provided name, if present.
- getChoices() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the choices for
string
andint
types for the user to pick from. - getChunkCount() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Gets the total number of expected chunks for this response.
- getChunkIndex() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Gets the chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count).
- getClient() - Method in class discord4j.core.event.domain.Event
-
Get the
GatewayDiscordClient
that emitted thisEvent
. - getClient() - Method in class discord4j.core.object.ApplicationTeamMember
- getClient() - Method in class discord4j.core.object.audit.AuditLogEntry
- getClient() - Method in class discord4j.core.object.Ban
- getClient() - Method in class discord4j.core.object.command.ApplicationCommand
- getClient() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
- getClient() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
- getClient() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- getClient() - Method in class discord4j.core.object.command.ApplicationCommandOption
- getClient() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
- getClient() - Method in class discord4j.core.object.command.Interaction
- getClient() - Method in interface discord4j.core.object.DiscordObject
-
Returns the
GatewayDiscordClient
that created this object. - getClient() - Method in class discord4j.core.object.Embed
- getClient() - Method in class discord4j.core.object.entity.ApplicationInfo
- getClient() - Method in class discord4j.core.object.entity.ApplicationTeam
- getClient() - Method in class discord4j.core.object.entity.Attachment
- getClient() - Method in class discord4j.core.object.entity.Guild
- getClient() - Method in class discord4j.core.object.entity.GuildEmoji
- getClient() - Method in class discord4j.core.object.entity.Integration
- getClient() - Method in class discord4j.core.object.entity.IntegrationApplication
- getClient() - Method in class discord4j.core.object.entity.Message
- getClient() - Method in class discord4j.core.object.entity.Role
- getClient() - Method in class discord4j.core.object.entity.Sticker
- getClient() - Method in class discord4j.core.object.entity.User
- getClient() - Method in class discord4j.core.object.entity.Webhook
- getClient() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
- getClient() - Method in class discord4j.core.object.FollowedChannel
- getClient() - Method in class discord4j.core.object.GuildTemplate
- getClient() - Method in class discord4j.core.object.IntegrationAccount
- getClient() - Method in class discord4j.core.object.Invite
- getClient() - Method in class discord4j.core.object.MessageInteraction
- getClient() - Method in class discord4j.core.object.MessageReference
- getClient() - Method in class discord4j.core.object.reaction.Reaction
- getClient() - Method in class discord4j.core.object.Region
- getClient() - Method in class discord4j.core.object.RoleTags
- getClient() - Method in class discord4j.core.object.VoiceState
- getCode() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the invite code (unique ID).
- getCode() - Method in class discord4j.core.event.domain.InviteDeleteEvent
-
Gets the invite code (unique ID).
- getCode() - Method in class discord4j.core.object.GuildTemplate
-
Gets the template code (unique ID).
- getCode() - Method in class discord4j.core.object.Invite
-
Gets the invite code (unique ID).
- getColor() - Method in class discord4j.core.object.Embed
-
Gets the color of the embed, if present.
- getColor() - Method in class discord4j.core.object.entity.Member
-
Requests to determine the
Color
this member would be visually represented in the Discord client. - getColor() - Method in class discord4j.core.object.entity.Role
-
Gets the color assigned to this role.
- getCommand() - Method in class discord4j.core.event.domain.command.ApplicationCommandCreateEvent
-
Gets the command created in this event.
- getCommand() - Method in class discord4j.core.event.domain.command.ApplicationCommandDeleteEvent
-
Gets the command deleted in this event.
- getCommand() - Method in class discord4j.core.event.domain.command.ApplicationCommandUpdateEvent
-
Gets the command updated in this event.
- getCommandId() - Method in class discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent
-
Gets the ID of the invoked command.
- getCommandInteraction() - Method in class discord4j.core.object.command.Interaction
-
Gets the command data payload.
- getCommandName() - Method in class discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent
-
Gets the name of the invoked command.
- getCommandType() - Method in class discord4j.core.event.domain.interaction.ApplicationCommandInteractionEvent
-
Gets the type of the invoked command.
- getComponents() - Method in class discord4j.core.object.entity.Message
- getComponentType() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the type of the component.
- getConnectedCount() - Method in class discord4j.core.shard.LocalShardCoordinator
- getConnectedCount() - Method in interface discord4j.core.shard.ShardCoordinator
-
Return the number of currently connected shards.
- getContent() - Method in class discord4j.core.object.entity.Message
-
Gets the contents of the message, if present.
- getContentFilterLevel() - Method in class discord4j.core.object.entity.Guild
-
Gets the default explicit content filter level.
- getContentType() - Method in class discord4j.core.object.entity.Attachment
-
Gets the attachment's media type, if present.
- getCoreResources() - Method in class discord4j.core.DiscordClient
-
Obtain the
CoreResources
associated with thisDiscordClient
. - getCoreResources() - Method in class discord4j.core.GatewayDiscordClient
-
Returns the set of resources essential to operate on a
DiscordClient
for entity manipulation, scheduling and API communication, like theRestClient
,JacksonResources
andReactorResources
. - getCount() - Method in class discord4j.core.object.reaction.Reaction
-
Gets the number of people who reacted with this reaction's emoji.
- getCreatedAt() - Method in class discord4j.core.object.GuildTemplate
-
Gets when the template was created.
- getCreatedAt() - Method in class discord4j.core.object.presence.Activity
-
Gets unix timestamp of when the activity was added to the user's session.
- getCreation() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets when this invite was created.
- getCreation() - Method in class discord4j.core.object.ExtendedInvite
-
Gets when this invite was created.
- getCreator() - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the user this webhook was created by, if present.
- getCreator() - Method in class discord4j.core.object.GuildTemplate
-
Gets the user who created the template.
- getCreator(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the user this webhook was created by, if present, using the given retrieval strategy.
- getCreatorId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the ID of the user this webhook was created by.
- getCreatorId() - Method in class discord4j.core.object.GuildTemplate
-
Gets the ID of the user who created the template.
- getCurrent() - Method in class discord4j.core.event.domain.channel.CategoryUpdateEvent
-
Get the current, new, version of the
Category
that has been updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
-
Gets the current, new version of the
NewsChannel
that was updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.channel.StoreChannelUpdateEvent
-
Gets the current, new version of the
StoreChannel
that was updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.channel.TextChannelUpdateEvent
-
Gets the current, new version of the
TextChannel
that was updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.channel.VoiceChannelUpdateEvent
-
Gets the current, new version of the
VoiceChannel
that was updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.guild.GuildUpdateEvent
-
Gets the current version of the
Guild
involved in this event. - getCurrent() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the current, new version of the
Presence
. - getCurrent() - Method in class discord4j.core.event.domain.role.RoleUpdateEvent
-
Gets the current, new version of the
Role
that was updated in the event. - getCurrent() - Method in class discord4j.core.event.domain.UserUpdateEvent
-
Gets the current, new version of the
User
that has been updated in this event. - getCurrent() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
-
Gets the current, new,
VoiceState
that has been updated in this event. - getCurrentAttempt() - Method in class discord4j.core.event.domain.lifecycle.ReconnectEvent
-
Gets the current reconnect attempt.
- getCurrentAttempt() - Method in class discord4j.core.event.domain.lifecycle.ReconnectFailEvent
-
Gets the current reconnect attempt.
- getCurrentContent() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Gets the current, new, version of the
Message
's content in this event, if present. - getCurrentEmbeds() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- getCurrentNickname() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Gets the current nickname of the
Member
involved in this event, if present. - getCurrentPartySize() - Method in class discord4j.core.object.presence.Activity
-
Gets the party's current size, if present.
- getCurrentPremiumSince() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Gets when the user started boosting the guild, if present.
- getCurrentRoles() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
- getCurrentValue() - Method in class discord4j.core.object.audit.AuditLogChange
- getCustomId() - Method in class discord4j.core.event.domain.interaction.ComponentInteractionEvent
-
Gets the developer-defined custom id associated with the component.
- getCustomId() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the developer-defined custom id of the component.
- getCustomId() - Method in class discord4j.core.object.component.Button
-
Gets the button's custom id.
- getCustomId() - Method in class discord4j.core.object.component.SelectMenu
-
Gets the select menu's custom id.
- getData() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
- getData() - Method in class discord4j.core.object.ApplicationTeamMember
-
Gets the data of the application team member.
- getData() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the data of the audit log entry.
- getData() - Method in class discord4j.core.object.Ban
-
Gets the data of the ban.
- getData() - Method in class discord4j.core.object.command.Interaction
- getData() - Method in class discord4j.core.object.component.MessageComponent
-
Gets the data of the component.
- getData() - Method in class discord4j.core.object.Embed.Author
-
Gets the data of the author.
- getData() - Method in class discord4j.core.object.Embed.Field
-
Gets the data of the field.
- getData() - Method in class discord4j.core.object.Embed.Footer
-
Gets the data of the footer.
- getData() - Method in class discord4j.core.object.Embed
-
Gets the data of the embed.
- getData() - Method in class discord4j.core.object.Embed.Image
-
Gets the data of the image.
- getData() - Method in class discord4j.core.object.Embed.Provider
-
Gets the data of the provider.
- getData() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets the data of the thumbnail.
- getData() - Method in class discord4j.core.object.Embed.Video
-
Gets the data of the video.
- getData() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the data of the app.
- getData() - Method in class discord4j.core.object.entity.Attachment
-
Gets the data of the attachment.
- getData() - Method in class discord4j.core.object.entity.Guild
-
Gets the data of the guild.
- getData() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the data of the emoji.
- getData() - Method in class discord4j.core.object.entity.Integration
-
Gets the data of the integration.
- getData() - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the data of the account.
- getData() - Method in class discord4j.core.object.entity.Message
-
Gets the data of the message.
- getData() - Method in class discord4j.core.object.entity.Role
-
Gets the data of the role.
- getData() - Method in class discord4j.core.object.entity.Sticker
-
Gets the data of the sticker.
- getData() - Method in class discord4j.core.object.entity.Webhook
-
Gets the data of the webhook.
- getData() - Method in class discord4j.core.object.FollowedChannel
-
Gets the data of the channel that has been followed.
- getData() - Method in class discord4j.core.object.GuildTemplate
-
Gets the data of the template.
- getData() - Method in class discord4j.core.object.IntegrationAccount
-
Gets the data of the account.
- getData() - Method in class discord4j.core.object.MessageReference
-
Gets the data of the message reference.
- getData() - Method in class discord4j.core.object.presence.Activity
-
Gets the data of the activity.
- getData() - Method in class discord4j.core.object.reaction.Reaction
-
Gets the data of the reaction.
- getData() - Method in class discord4j.core.object.Region
-
Gets the data of the region.
- getData() - Method in class discord4j.core.object.RoleTags
-
Gets the data of the role tags.
- getData() - Method in class discord4j.core.object.VoiceState
-
Gets the data of the voice state.
- getDefaultAvatarUrl() - Method in class discord4j.core.object.entity.User
-
Gets the default avatar URL for this user.
- getDenied() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the permissions explicitly denied by this overwrite.
- getDescription() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets description of the command.
- getDescription() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the description of the option.
- getDescription() - Method in class discord4j.core.object.component.SelectMenu.Option
-
Gets the option's description.
- getDescription() - Method in class discord4j.core.object.Embed
-
Gets the description of the embed, if present.
- getDescription() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the description of the app.
- getDescription() - Method in class discord4j.core.object.entity.Guild
-
Gets the description of the guild, if present.
- getDescription() - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the description of the app.
- getDescription() - Method in class discord4j.core.object.entity.Sticker
-
Gets the description of the sticker.
- getDescription() - Method in class discord4j.core.object.GuildTemplate
-
Gets the description of the template, if present.
- getDetails() - Method in class discord4j.core.object.presence.Activity
-
Gets what the player is currently doing, if present.
- getDiscoverySplash(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the discovery splash of the guild.
- getDiscoverySplashUrl(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the discovery splash URL of the guild, if present.
- getDiscriminator() - Method in class discord4j.core.object.entity.User
-
Gets the user's 4-digit discriminator The discriminator is unique number to distinct one among all users with the same username.
- getDispatch() - Method in class discord4j.core.event.dispatch.DispatchContext
- getDisplayName() - Method in class discord4j.core.object.entity.Member
-
Gets the name that is displayed in client.
- getEditedTimestamp() - Method in class discord4j.core.object.entity.Message
-
Gets when this message was edited, if present.
- getEffectivePermissions(Snowflake) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the permissions for the given member, taking into account permission overwrites in this channel.
- getEmbed() - Method in class discord4j.core.object.Embed.Author
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Field
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Footer
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Image
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Provider
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets the
Embed
associated to this object. - getEmbed() - Method in class discord4j.core.object.Embed.Video
-
Gets the
Embed
associated to this object. - getEmbedChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the embedded channel, if present.
- getEmbedChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the embedded channel, if present, using the given retrieval strategy.
- getEmbedChannelId() - Method in class discord4j.core.object.entity.Guild
-
Deprecated.Use
Guild#getWidgetChannelId
instead. For removal in v3.2 - getEmbeds() - Method in class discord4j.core.object.entity.Message
-
Gets any embedded content.
- getEmoji() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Gets the
ReactionEmoji
that was added to theMessage
in this event. - getEmoji() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
The
ReactionEmoji
that was removed from a message. - getEmoji() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
The
ReactionEmoji
that was removed from a message. - getEmoji() - Method in class discord4j.core.object.component.Button
-
Gets the button's emoji.
- getEmoji() - Method in class discord4j.core.object.component.SelectMenu.Option
-
Gets the option's emoji.
- getEmoji() - Method in class discord4j.core.object.presence.Activity
-
Gets the emoji used for a custom status, if present.
- getEmoji() - Method in class discord4j.core.object.reaction.Reaction
-
Gets this reaction's emoji.
- getEmojiIds() - Method in class discord4j.core.object.entity.Guild
-
Gets the guild's emoji's IDs.
- getEmojis() - Method in class discord4j.core.event.domain.guild.EmojisUpdateEvent
-
Gets a list of ALL emojis of the
Guild
. - getEmojis() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's emojis.
- getEmojis(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's emojis, using the given retrieval strategy.
- getEmojiString(ReactionEmoji) - Static method in class discord4j.core.util.EntityUtil
- getEnd() - Method in class discord4j.core.object.presence.Activity
-
Gets the UNIX time (in milliseconds) of when the activity ends, if present.
- getEndpoint() - Method in class discord4j.core.event.domain.VoiceServerUpdateEvent
-
Gets the voice server host's endpoint URL.
- getEventDispatcher() - Method in class discord4j.core.GatewayDiscordClient
-
Distributes events to subscribers.
- getEventDispatcher() - Method in class discord4j.core.GatewayResources
-
Distributes events to subscribers.
- getEveryoneRole() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's @everyone
Role
. - getEveryoneRole(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's @everyone
Role
, using the given retrieval strategy. - getExpiration() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the instant this invite expires, if possible.
- getExpiration() - Method in class discord4j.core.object.ExtendedInvite
-
Gets the instant this invite expires, if possible.
- getExpireBehavior() - Method in class discord4j.core.object.entity.Integration
-
Gets the behavior of expiring subscribers, if present.
- getExpireGracePeriod() - Method in class discord4j.core.object.entity.Integration
-
Gets the grace period (in days) before expiring subscribers, if present.
- getFeatures() - Method in class discord4j.core.object.entity.Guild
-
Gets the enabled guild features.
- getField() - Method in class discord4j.core.object.audit.OptionKey
- getFields() - Method in class discord4j.core.object.Embed
-
Gets the field information.
- getFilename() - Method in class discord4j.core.object.entity.Attachment
-
Gets the name of the file attached.
- getFlag() - Method in enum discord4j.core.object.entity.Guild.SystemChannelFlag
-
Gets the flag value as represented by Discord.
- getFlag() - Method in enum discord4j.core.object.entity.Message.Flag
-
Gets the flag value as represented by Discord.
- getFlag() - Method in enum discord4j.core.object.entity.User.Flag
-
Gets the flag value as represented by Discord.
- getFlags() - Method in class discord4j.core.object.entity.Message
-
Returns the flags of this
Message
, describing its features. - getFlags() - Method in class discord4j.core.object.presence.Activity
- getFooter() - Method in class discord4j.core.object.Embed
-
Gets the footer information, if present.
- getFormatType() - Method in class discord4j.core.object.entity.Sticker
-
Gets the type of sticker format.
- getGateway() - Method in class discord4j.core.event.dispatch.DispatchContext
- getGatewayClient(int) - Method in class discord4j.core.GatewayDiscordClient
-
Returns a
GatewayClient
instance created by thisGatewayDiscordClient
, which is associated to a given shard index. - getGatewayClientGroup() - Method in class discord4j.core.GatewayDiscordClient
-
Returns the
GatewayClientGroup
capable of performing operations across allGatewayClient
instances created or managed by thisGatewayDiscordClient
. - getGatewayReactorResources() - Method in class discord4j.core.GatewayResources
-
Return the
GatewayReactorResources
used to perform Gateway-related operations. - getGatewayResources() - Method in class discord4j.core.GatewayDiscordClient
-
Returns the set of resources essential to build
GatewayClient
instances and manage multiple Discord Gateway connections. - getGatewayVersion() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
Gets the gateway protocol version being used.
- getGroupManager(int) - Method in class discord4j.core.shard.DefaultShardingStrategy
- getGroupManager(int) - Method in interface discord4j.core.shard.ShardingStrategy
-
Return the
GatewayClientGroupManager
to maintain each gateway client in the created group. - getGuild() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
- getGuild() - Method in class discord4j.core.event.domain.command.ApplicationCommandCreateEvent
-
Requests to retrieve the
Guild
that had an application command created in this event. - getGuild() - Method in class discord4j.core.event.domain.command.ApplicationCommandDeleteEvent
-
Requests to retrieve the
Guild
that had an application command deleted in this event. - getGuild() - Method in class discord4j.core.event.domain.command.ApplicationCommandUpdateEvent
-
Requests to retrieve the
Guild
that had an application command updated in this event. - getGuild() - Method in class discord4j.core.event.domain.guild.BanEvent
- getGuild() - Method in class discord4j.core.event.domain.guild.EmojisUpdateEvent
-
Requests to retrieve the
Guild
whose emojis have been updated. - getGuild() - Method in class discord4j.core.event.domain.guild.GuildCreateEvent
-
Gets the
Guild
that has become available in this event. - getGuild() - Method in class discord4j.core.event.domain.guild.GuildDeleteEvent
-
Gets the
Guild
involved in this event, if present. - getGuild() - Method in class discord4j.core.event.domain.guild.IntegrationsUpdateEvent
-
Requests to retrieve the
Guild
whose integrations have been updated. - getGuild() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Requests to retrieve the
Guild
involved in the event. - getGuild() - Method in class discord4j.core.event.domain.guild.MemberJoinEvent
- getGuild() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
- getGuild() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Requests to retrieve the
Guild
involved in the event. - getGuild() - Method in class discord4j.core.event.domain.guild.UnbanEvent
-
Requests to retrieve the Guild the Member was unbanned from.
- getGuild() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Requests to retrieve the
Guild
that had an invite created in this event. - getGuild() - Method in class discord4j.core.event.domain.InviteDeleteEvent
-
Requests to retrieve the
Guild
that had an invite deleted in this event. - getGuild() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Requests to retrieve the
Guild
the messages were deleted in. - getGuild() - Method in class discord4j.core.event.domain.message.MessageCreateEvent
- getGuild() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
- getGuild() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- getGuild() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
- getGuild() - Method in class discord4j.core.event.domain.role.RoleCreateEvent
- getGuild() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
- getGuild() - Method in class discord4j.core.event.domain.VoiceServerUpdateEvent
-
Requests to retrieve the
Guild
whose voice server has been updated in this event. - getGuild() - Method in class discord4j.core.event.domain.WebhooksUpdateEvent
-
Requests to retrieve the
Guild
that had a webhook updated in this event. - getGuild() - Method in class discord4j.core.object.command.Interaction
-
Gets the guild it was sent from, if invoked in a guild.
- getGuild() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to retrieve the guild this channel is associated to.
- getGuild() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the guild this emoji is associated to.
- getGuild() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the guild this user is associated to.
- getGuild() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the guild this message is associated to, if present.
- getGuild() - Method in class discord4j.core.object.entity.Role
-
Requests to retrieve the guild this role is associated to.
- getGuild() - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the guild this webhook is associated to.
- getGuild() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the guild associated to this overwrite.
- getGuild() - Method in class discord4j.core.object.Invite
-
Requests to retrieve the guild this invite is associated to, if present.
- getGuild() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the guild this voice state is for.
- getGuild(EntityRetrievalStrategy) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to retrieve the guild this channel is associated to, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the guild this emoji is associated to, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the guild this user is associated to, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the guild this message is associated to, if present, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Role
-
Requests to retrieve the guild this role is associated to, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the guild this webhook is associated to, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the guild associated to this overwrite, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Requests to retrieve the guild this invite is associated to, if present, using the given retrieval strategy.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the guild this voice state is for, using the given retrieval strategy.
- getGuildById(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildById(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild represented by the supplied ID.
- getGuildById(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildById(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildById(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildChannels(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildChannels(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild's channels.
- getGuildChannels(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildChannels(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildChannels(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildEmojiById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild emoji as represented by the supplied ID.
- getGuildEmojiById(Snowflake, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildEmojiById(Snowflake, Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild emoji represented by the supplied IDs.
- getGuildEmojiById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildEmojiById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildEmojiById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildEmojiById(Snowflake, EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild emoji as represented by the supplied ID, using the given retrieval strategy.
- getGuildEmojis(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildEmojis(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild's emojis.
- getGuildEmojis(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildEmojis(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildEmojis(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildEmojiStore() - Method in class discord4j.core.state.StateHolder
- getGuildEmojiStore() - Method in class discord4j.core.state.StateView
- getGuildId() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
- getGuildId() - Method in class discord4j.core.event.domain.command.ApplicationCommandCreateEvent
- getGuildId() - Method in class discord4j.core.event.domain.command.ApplicationCommandDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.command.ApplicationCommandUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.BanEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.EmojisUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.GuildDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.IntegrationsUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.MemberJoinEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.guild.UnbanEvent
- getGuildId() - Method in class discord4j.core.event.domain.integration.IntegrationCreateEvent
-
Gets the id of the guild.
- getGuildId() - Method in class discord4j.core.event.domain.integration.IntegrationDeleteEvent
-
Gets the id of the guild.
- getGuildId() - Method in class discord4j.core.event.domain.integration.IntegrationUpdateEvent
-
Gets the id of the guild.
- getGuildId() - Method in class discord4j.core.event.domain.InviteCreateEvent
- getGuildId() - Method in class discord4j.core.event.domain.InviteDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.MessageCreateEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- getGuildId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- getGuildId() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
- getGuildId() - Method in class discord4j.core.event.domain.role.RoleCreateEvent
- getGuildId() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
- getGuildId() - Method in class discord4j.core.event.domain.VoiceServerUpdateEvent
-
Gets the
Snowflake
ID of the guild whose voice server has been updated in this event. - getGuildId() - Method in class discord4j.core.event.domain.WebhooksUpdateEvent
-
Gets the
Snowflake
ID of the guild that had a webhook updated in this event. - getGuildId() - Method in class discord4j.core.object.command.Interaction
-
Gets the guild id it was sent from, if invoked in a guild.
- getGuildId() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the ID of the guild this channel is associated to.
- getGuildId() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the ID of the guild this emoji is associated to.
- getGuildId() - Method in class discord4j.core.object.entity.Integration
-
Gets the ID of the guild this integration is associated to.
- getGuildId() - Method in class discord4j.core.object.entity.Member
-
Gets the ID of the guild this user is associated to.
- getGuildId() - Method in class discord4j.core.object.entity.Message
-
Gets the ID of the guild this message is associated to, if this
Message
was built from Gateway data, like an incoming event. - getGuildId() - Method in class discord4j.core.object.entity.Role
-
Gets the ID of the guild this role is associated to.
- getGuildId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the ID of the guild this webhook is associated to.
- getGuildId() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Gets the ID of the guild associated to this overwrite.
- getGuildId() - Method in class discord4j.core.object.GuildTemplate
-
Gets the ID of the guild this template is associated with.
- getGuildId() - Method in class discord4j.core.object.Invite
-
Gets the ID of the guild this invite is associated to.
- getGuildId() - Method in class discord4j.core.object.MessageReference
- getGuildId() - Method in class discord4j.core.object.VoiceState
-
Gets the guild ID this voice state is for.
- getGuildMembers(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildMembers(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild's members.
- getGuildMembers(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildMembers(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildMembers(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildRoles(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getGuildRoles(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guild's roles.
- getGuildRoles(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuildRoles(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuildRoles(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuilds() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
Gets a set of Unavailable
ReadyEvent.Guild
. - getGuilds() - Method in class discord4j.core.GatewayDiscordClient
- getGuilds() - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the guilds the current client is in.
- getGuilds() - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getGuilds() - Method in class discord4j.core.retriever.RestEntityRetriever
- getGuilds() - Method in class discord4j.core.retriever.StoreEntityRetriever
- getGuildStore() - Method in class discord4j.core.state.StateHolder
- getGuildStore() - Method in class discord4j.core.state.StateView
- getHeight() - Method in class discord4j.core.object.Embed.Image
-
Gets the height of the image.
- getHeight() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets the height of the thumbnail.
- getHeight() - Method in class discord4j.core.object.Embed.Video
-
Gets the height of the video.
- getHeight() - Method in class discord4j.core.object.entity.Attachment
-
Gets the height of the file, if present.
- getHighestRole() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the user's highest guild role.
- getHighestRole(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the user's highest guild role, using the given retrieval strategy.
- getIcon(Image.Format) - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the icon of the application.
- getIcon(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the icon of the guild.
- getIconUrl() - Method in class discord4j.core.object.Embed.Author
-
Gets the URL of the author icon (only supports http(s) and attachments).
- getIconUrl() - Method in class discord4j.core.object.Embed.Footer
-
The URL of the footer icon (only supports http(s) and attachments).
- getIconUrl(Image.Format) - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the icon URL of the application, if present.
- getIconUrl(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the icon URL of the guild, if present.
- getIconUrl(Image.Format) - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the icon URL of the application, if present.
- getId() - Method in class discord4j.core.event.domain.integration.IntegrationDeleteEvent
-
Gets the id of the integration.
- getId() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
-
Gets the
Snowflake
ID of the guild. - getId() - Method in class discord4j.core.object.audit.AuditLogEntry
- getId() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets unique id of the command.
- getId() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the id of the invoked command.
- getId() - Method in class discord4j.core.object.command.Interaction
-
Gets the id of the interaction.
- getId() - Method in class discord4j.core.object.entity.ApplicationInfo
- getId() - Method in class discord4j.core.object.entity.ApplicationTeam
- getId() - Method in class discord4j.core.object.entity.Attachment
- getId() - Method in interface discord4j.core.object.entity.Entity
-
Gets the Snowflake that uniquely identifies this entity.
- getId() - Method in class discord4j.core.object.entity.Guild
- getId() - Method in class discord4j.core.object.entity.GuildEmoji
- getId() - Method in class discord4j.core.object.entity.Integration
- getId() - Method in class discord4j.core.object.entity.IntegrationApplication
- getId() - Method in class discord4j.core.object.entity.Message
- getId() - Method in class discord4j.core.object.entity.Role
- getId() - Method in class discord4j.core.object.entity.Sticker
- getId() - Method in class discord4j.core.object.entity.User
- getId() - Method in class discord4j.core.object.entity.Webhook
- getId() - Method in class discord4j.core.object.IntegrationAccount
-
Gets the id of the account.
- getId() - Method in class discord4j.core.object.MessageInteraction
-
Gets the id of the interaction.
- getId() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
-
Gets the id of the emoji.
- getId() - Method in class discord4j.core.object.Region
-
Gets the unique ID for the region.
- getIdentifyLimiter(ShardInfo, int) - Method in class discord4j.core.shard.LocalShardCoordinator
- getIdentifyLimiter(ShardInfo, int) - Method in interface discord4j.core.shard.ShardCoordinator
-
Returns a transformation function for a sequence of payloads that can be held or delayed in order to successfully identify multiple shards in a coordinated manner.
- getImage() - Method in class discord4j.core.object.Embed
-
Gets the image information, if present.
- getImage() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the image for this guild emoji.
- getImageUrl() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the URL for this guild emoji.
- getIntegration() - Method in class discord4j.core.event.domain.integration.IntegrationCreateEvent
-
Gets the integration created.
- getIntegration() - Method in class discord4j.core.event.domain.integration.IntegrationUpdateEvent
-
Gets the updated integration.
- getIntegrationId() - Method in class discord4j.core.object.RoleTags
-
Gets the id of the integration this role belongs to, if present.
- getIntents() - Method in class discord4j.core.GatewayResources
- getInteraction() - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Gets the
Interaction
associated with the event. - getInteraction() - Method in class discord4j.core.object.entity.Message
-
Gets the interaction data, if the message is a response to an
Interactions
. - getInteractionResponse() - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Gets a handler for common operations related to an interaction followup response associated with this event.
- getInvite() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Requests to retrieve the invite Created.
- getInvite(String) - Method in class discord4j.core.GatewayDiscordClient
-
Requests to retrieve an invite.
- getInviter() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the user that created the invite, if present.
- getInviter() - Method in class discord4j.core.object.Invite
-
Deprecated.this method will return
Optional
in v3.2.0, as the inviter User can be accessed directly. see this pull request for details - getInviter(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Deprecated.this method will be removed in v3.2.0, as the inviter User can be accessed directly. see this pull request for details
- getInviterId() - Method in class discord4j.core.object.Invite
-
Gets the ID of the user who created the invite, if present.
- getInvites() - Method in interface discord4j.core.object.entity.channel.CategorizableChannel
-
Requests to retrieve this channel's invites.
- getInvites() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the invites of the guild.
- getJoinSecret() - Method in class discord4j.core.object.presence.Activity
-
Gets the secret for joining a party, if present.
- getJoinTime() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Gets the current join time of the
Member
involved in this event. - getJoinTime() - Method in class discord4j.core.object.entity.Guild
-
Gets when this guild was joined at.
- getJoinTime() - Method in class discord4j.core.object.entity.Member
-
Gets when the user joined the guild, if present.
- getKeyStore(Class<V>) - Method in class discord4j.core.shard.JdkKeyStoreRegistry
- getKeyStore(Class<V>) - Method in interface discord4j.core.shard.KeyStoreRegistry
-
Return the saved
KeyStore
for the given value type. - getLabel() - Method in class discord4j.core.object.component.Button
-
Gets button's label.
- getLabel() - Method in class discord4j.core.object.component.SelectMenu.Option
-
Gets the option's label.
- getLargeImageId() - Method in class discord4j.core.object.presence.Activity
-
Gets the ID for a large asset of the activity, usually a
Snowflake
, if present. - getLargeText() - Method in class discord4j.core.object.presence.Activity
-
Gets the text displayed when hovering over the large image of the activity, if present.
- getLastMessage() - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve the last message sent in this channel, if present.
- getLastMessage(EntityRetrievalStrategy) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve the last message sent in this channel, if present, using the given retrieval strategy.
- getLastMessageId() - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Gets the ID of the last message sent in this channel, if present.
- getLastPinTimestamp() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
-
Gets the ISO8601 timestamp of when the last pinned
Message
w as pinned, if present. - getLastPinTimestamp() - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Gets when the last pinned message was pinned, if present.
- getMatchSecret() - Method in class discord4j.core.object.presence.Activity
-
Gets the secret for a specific instanced match, if present.
- getMaxAge() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets how long the invite is valid for (in seconds).
- getMaxConcurrency() - Method in class discord4j.core.shard.DefaultShardingStrategy
- getMaxConcurrency() - Method in interface discord4j.core.shard.ShardingStrategy
-
Return the number of shards that can be identified concurrently.
- getMaxMembers() - Method in class discord4j.core.object.entity.Guild
-
Gets the maximum amount of members of the guild, if present.
- getMaxPartySize() - Method in class discord4j.core.object.presence.Activity
-
Gets the party's max size, if present.
- getMaxPresences() - Method in class discord4j.core.object.entity.Guild
-
Gets the maximum amount of presences of the guild.
- getMaxUses() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the max number of times this invite can be used.
- getMaxUses() - Method in class discord4j.core.object.ExtendedInvite
-
Gets the max number of times this invite can be used.
- getMaxValues() - Method in class discord4j.core.object.component.SelectMenu
-
Gets the maximum number of options that must be chosen.
- getMaxVideoChannelUsers() - Method in class discord4j.core.object.entity.Guild
-
Gets the maximum amount of users in a video channel, if present.
- getMember() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Gets the
Member
who started typing, if this happened in a guild. - getMember() - Method in class discord4j.core.event.domain.guild.MemberJoinEvent
- getMember() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
- getMember() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Requests to retrieve the
Member
involved in the event. - getMember() - Method in class discord4j.core.event.domain.message.MessageCreateEvent
- getMember() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Gets the member who reacted, if present.
- getMember() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
- getMember() - Method in class discord4j.core.object.command.Interaction
-
Gets the invoking member, if invoked in a guild.
- getMember() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the member this voice state is for.
- getMember(EntityRetrievalStrategy) - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the member this voice state is for, using the given retrieval strategy.
- getMemberById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the member as represented by the supplied ID.
- getMemberById(Snowflake, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getMemberById(Snowflake, Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the member represented by the supplied IDs.
- getMemberById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getMemberById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getMemberById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getMemberById(Snowflake, EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the member as represented by the supplied ID, using the given retrieval strategy.
- getMemberCount() - Method in class discord4j.core.object.entity.Guild
-
Gets the total number of members in the guild.
- getMemberData() - Method in class discord4j.core.object.entity.Member
-
Gets the data of the member.
- getMemberId() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
- getMemberId() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the ID of the member this overwrite targets.
- getMemberRequestFilter() - Method in class discord4j.core.GatewayResources
-
Return a
MemberRequestFilter
indicating whether this shard group should be requesting guild members. - getMemberRequestTimeout() - Method in class discord4j.core.GatewayResources
-
Deprecated.to be removed in v3.2, as Gateway Intents are mandatory and client-side validations can be reliably performed
- getMembers() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Gets a list of
Members
that have been streamed to the client in this event. - getMembers() - Method in class discord4j.core.object.entity.ApplicationTeam
-
Gets the members of the team.
- getMembers() - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Returns all members in the guild which have access to view this channel.
- getMembers() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the members of the guild.
- getMembers(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the members of the guild, using the given retrieval strategy.
- getMembershipState() - Method in class discord4j.core.object.ApplicationTeamMember
-
Gets the user's membership state on the team.
- getMemberStore() - Method in class discord4j.core.state.StateHolder
- getMemberStore() - Method in class discord4j.core.state.StateView
- getMention() - Method in interface discord4j.core.object.entity.channel.Channel
-
Gets the raw mention.
- getMention() - Method in class discord4j.core.object.entity.Role
-
Gets the raw mention.
- getMention() - Method in class discord4j.core.object.entity.User
-
Gets the raw mention.
- getMessage() - Method in class discord4j.core.event.domain.interaction.ComponentInteractionEvent
-
Gets the message the component is on.
- getMessage() - Method in class discord4j.core.event.domain.message.MessageCreateEvent
-
Gets the
Message
that was created in this event. - getMessage() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
-
Gets the
Message
that was deleted in this event, if present. - getMessage() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Requests to retrieve the
Message
that has been updated in this event. - getMessage() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Request to retrieve the
Message
the reaction was added to in this event. - getMessage() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
-
Requests to retrieve the
Message
the reactions were removed from in this event. - getMessage() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
Requests to retrieve the
Message
the reaction was removed from. - getMessage() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
Requests to retrieve the
Message
the reaction was removed from. - getMessage() - Method in class discord4j.core.object.command.Interaction
-
Gets the message associated with the interaction.
- getMessageById(Snowflake) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve the message as represented by the supplied ID.
- getMessageById(Snowflake, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getMessageById(Snowflake, Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the message represented by the supplied IDs.
- getMessageById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getMessageById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getMessageById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getMessageById(Snowflake, EntityRetrievalStrategy) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve the message as represented by the supplied ID, using the given retrieval strategy.
- getMessageId() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
- getMessageId() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- getMessageId() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- getMessageId() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- getMessageId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- getMessageId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- getMessageId() - Method in class discord4j.core.object.MessageReference
- getMessageIds() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Gets a list of
Snowflake
IDs of the messages that were deleted. - getMessageReference() - Method in class discord4j.core.object.entity.Message
-
Returns the
MessageReference
sent with crossposted messages and replies, if present. - getMessages() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Gets a list of
Message
objects there were deleted in this event. - getMessagesAfter(Snowflake) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve all messages after the specified ID.
- getMessagesBefore(Snowflake) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve all messages before the specified ID.
- getMessageStore() - Method in class discord4j.core.state.StateHolder
- getMessageStore() - Method in class discord4j.core.state.StateView
- getMfaLevel() - Method in class discord4j.core.object.entity.Guild
-
Gets the required MFA level for the guild.
- getMinValues() - Method in class discord4j.core.object.component.SelectMenu
-
Gets the minimum number of options that must be chosen.
- getName() - Method in class discord4j.core.object.audit.ChangeKey
-
Gets the name of audit log change key.
- getName() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets the name of the command.
- getName() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the name of the invoked command.
- getName() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
-
Gets the name of the option.
- getName() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the name of the option.
- getName() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Gets the name of this choice.
- getName() - Method in class discord4j.core.object.Embed.Author
-
Gets the name of the author.
- getName() - Method in class discord4j.core.object.Embed.Field
-
Gets the name of the field.
- getName() - Method in class discord4j.core.object.Embed.Provider
-
Gets the name of the provider.
- getName() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the name of the app.
- getName() - Method in class discord4j.core.object.entity.ApplicationTeam
-
Gets the name of the team.
- getName() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the name of the channel.
- getName() - Method in class discord4j.core.object.entity.Guild
-
Gets the guild name.
- getName() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the emoji name.
- getName() - Method in class discord4j.core.object.entity.Integration
-
Gets the integration name.
- getName() - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the name of the app.
- getName() - Method in class discord4j.core.object.entity.Role
-
Gets the role name.
- getName() - Method in class discord4j.core.object.entity.Sticker
-
Gets the name of the sticker.
- getName() - Method in class discord4j.core.object.entity.Webhook
-
Gets the default name of the webhook.
- getName() - Method in class discord4j.core.object.GuildTemplate
-
Gets the name of the template.
- getName() - Method in class discord4j.core.object.IntegrationAccount
-
Gets the name of the account.
- getName() - Method in class discord4j.core.object.MessageInteraction
-
Gets the name of the
ApplicationCommand
. - getName() - Method in class discord4j.core.object.presence.Activity
-
Gets the activity's name.
- getName() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
-
Gets the name of the emoji.
- getName() - Method in class discord4j.core.object.Region
-
Gets the name of the region.
- getNewAvatar() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the
User
's new avatar, if present. - getNewDiscriminator() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the
User
's new discriminator, if present. - getNewsChannel() - Method in class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
-
Gets the current, new version of the
NewsChannel
that was updated in this event as an optional value of aNewsChannel
. - getNewsChannel() - Method in class discord4j.core.event.domain.channel.TextChannelUpdateEvent
-
Gets the current, new version of the
TextChannel
that was updated in this event as an optional value of aNewsChannel
. - getNewsChannel() - Method in class discord4j.core.object.FollowedChannel
-
Requests to retrieve the news channel that has been followed.
- getNewsChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.FollowedChannel
-
Requests to retrieve the news channel that has been followed, using the given retrieval strategy.
- getNewsChannelId() - Method in class discord4j.core.object.FollowedChannel
-
Returns the ID of the news channel that has been followed.
- getNewUsername() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the
User
's new username, if present. - getNickname() - Method in class discord4j.core.object.entity.Member
-
Gets the user's guild nickname (if one is set).
- getNicknameMention() - Method in class discord4j.core.object.entity.Member
-
Gets the raw nickname mention.
- getNonce() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Gets the nonce used in the Guild Members Request, if present.
- getNotFound() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
-
Gets invalid id passed to `REQUEST_GUILD_MEMBERS`, if any.
- getNotificationLevel() - Method in class discord4j.core.object.entity.Guild
-
Gets the default message notification level..
- getNsfwLevel() - Method in class discord4j.core.object.entity.Guild
-
Gets the guild NSFW level.
- getOld() - Method in class discord4j.core.event.domain.channel.CategoryUpdateEvent
-
Gets the old version of the
Category
that has been updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
-
Gets the old version of the
NewsChannel
that was updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.channel.StoreChannelUpdateEvent
-
Gets the old version of the
StoreChannel
that was updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.channel.TextChannelUpdateEvent
-
Gets the old version of the
TextChannel
that was updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.channel.VoiceChannelUpdateEvent
-
Gets the old version of the
VoiceChannel
that was updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.guild.EmojisUpdateEvent
-
Gets a list of ALL old emojis of the
Guild
, if present. - getOld() - Method in class discord4j.core.event.domain.guild.GuildUpdateEvent
-
Gets the old version of the
Guild
involved in this event, if present. - getOld() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Gets the old version of the
Member
involved in the event, if present. - getOld() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Gets the old version of the updated
Message
, if present. - getOld() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the old version of the
Presence
that was changed, if present. - getOld() - Method in class discord4j.core.event.domain.role.RoleUpdateEvent
-
Gets the old version of the
Role
that was updated in this event. - getOld() - Method in class discord4j.core.event.domain.UserUpdateEvent
-
Gets the old version of the
User
that has been updated in this event, if present. - getOld() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
-
Gets the old
VoiceState
that has been updated in this event, if present. - getOldUser() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the old version of the
User
that was updated, if present. - getOldValue() - Method in class discord4j.core.object.audit.AuditLogChange
- getOption(OptionKey<T>) - Method in class discord4j.core.object.audit.AuditLogEntry
- getOption(String) - Method in class discord4j.core.event.domain.interaction.ChatInputInteractionEvent
-
Gets the option corresponding to the provided name, if present.
- getOption(String) - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets the option corresponding to the provided name, if present.
- getOption(String) - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the option corresponding to the provided name, if present.
- getOption(String) - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
-
Gets the option corresponding to the provided name, if present.
- getOption(String) - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the option corresponding to the provided name, if present and if this option is a subcommand or subcommand group type.
- getOptions() - Method in class discord4j.core.event.domain.interaction.ChatInputInteractionEvent
-
Gets the options of the invoked command.
- getOptions() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets the options of the command.
- getOptions() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the options of the invoked command.
- getOptions() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
-
Gets the options, present if this option is a group or subcommand.
- getOptions() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the options, if the option is a subcommand or subcommand group type.
- getOptions() - Method in class discord4j.core.object.component.SelectMenu
-
Gets the options that can be selected in the menu.
- getOverwriteForMember(Snowflake) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the permission overwrite targeting the given member.
- getOverwriteForRole(Snowflake) - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the permission overwrite targeting the given role.
- getOwner() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Requests to retrieve the owner of the application.
- getOwner() - Method in class discord4j.core.object.entity.ApplicationTeam
-
Requests to retrieve the current team owner.
- getOwner() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the owner of the guild.
- getOwner(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.ApplicationInfo
-
Requests to retrieve the owner of the application, using the given retrieval strategy.
- getOwner(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.ApplicationTeam
-
Requests to retrieve the current team owner, using the given retrieval strategy.
- getOwnerId() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the ID of the owner of the application.
- getOwnerId() - Method in class discord4j.core.object.entity.ApplicationTeam
-
Gets the user id of the current team owner.
- getOwnerId() - Method in class discord4j.core.object.entity.Guild
-
Gets the ID of the owner of the guild.
- getPackId() - Method in class discord4j.core.object.entity.Sticker
-
Gets the ID of the pack the sticker is from.
- getPartyId() - Method in class discord4j.core.object.presence.Activity
-
Gets the ID of the party, if present.
- getPermissionOverwrites() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the permission overwrites for this channel.
- getPermissions() - Method in class discord4j.core.object.entity.Role
-
Gets the permissions assigned to this role.
- getPinnedMessages() - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve all the pinned messages for this channel.
- getPlaceholder() - Method in class discord4j.core.object.component.SelectMenu
-
Gets the text displayed if no option is selected.
- getPosition() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to retrieve the position of the channel relative to other channels in the guild.
- getPosition() - Method in class discord4j.core.object.entity.Role
-
Requests to retrieve the position of the role relative to other roles in the guild.
- getPosition(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Role
-
Requests to retrieve the position of the role relative to other roles in the guild, using the given retrieval strategy.
- getPreferredLocale() - Method in class discord4j.core.object.entity.Guild
-
Gets the preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US".
- getPremiumSubscriptionCount() - Method in class discord4j.core.object.entity.Guild
-
Gets the number of boosts this server currently has, if present.
- getPremiumTier() - Method in class discord4j.core.object.entity.Guild
-
Gets the Premium Tier (Server Boost level) for the guild.
- getPremiumTime() - Method in class discord4j.core.object.entity.Member
-
Gets when the user started boosting the server, if present.
- getPresence() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the presence for this user for this guild.
- getPresences() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the presences of the guild.
- getPresenceStore() - Method in class discord4j.core.state.StateHolder
- getPresenceStore() - Method in class discord4j.core.state.StateView
- getPrivacyPolicyUrl() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the url of the app's privacy policy, if present.
- getPrivateChannel() - Method in class discord4j.core.object.entity.User
-
Requests to retrieve the private channel (DM) to this user.
- getProvider() - Method in class discord4j.core.object.Embed
-
Gets the provider information, if present.
- getProxyIconUrl() - Method in class discord4j.core.object.Embed.Author
-
Gets a proxied URL of the author icon.
- getProxyIconUrl() - Method in class discord4j.core.object.Embed.Footer
-
Gets a proxied URL of the footer icon.
- getProxyUrl() - Method in class discord4j.core.object.Embed.Image
-
Gets a proxied URL of the image.
- getProxyUrl() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets a proxied URL of the thumbnail.
- getProxyUrl() - Method in class discord4j.core.object.Embed.Video
-
Gets a proxied URL of the video.
- getProxyUrl() - Method in class discord4j.core.object.entity.Attachment
-
Gets a proxied URL of the file.
- getPruneCount(int) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the number of users that will be pruned.
- getPruneCount(Consumer<? super GuildPruneCountSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the number of users that will be pruned.
- getPublicFlags() - Method in class discord4j.core.object.entity.User
-
Returns the public flags of this
User
, describing its features. - getPublicUpdatesChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where admins and moderators of Community guilds receive notices from Discord, if present.
- getPublicUpdatesChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where admins and moderators of Community guilds receive notices from Discord, if present, using the given retrieval strategy.
- getPublicUpdatesChannelId() - Method in class discord4j.core.object.entity.Guild
-
Gets the id of the channel where admins and moderators of Community guilds receive notices from Discord, if present.
- getRateLimitPerUser() - Method in class discord4j.core.object.entity.channel.TextChannel
-
Gets the amount of seconds an user has to wait before sending another message (0-120).
- getRaw() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOptionValue
- getRaw() - Method in class discord4j.core.object.reaction.ReactionEmoji.Unicode
- getRawPosition() - Method in interface discord4j.core.object.entity.channel.GuildChannel
-
Gets the raw position of the channel as exposed by Discord.
- getRawPosition() - Method in class discord4j.core.object.entity.Role
-
Gets the sorting position of the role.
- getReactions() - Method in class discord4j.core.object.entity.Message
-
Gets the reactions to this message, the order is the same as in the message.
- getReactors(ReactionEmoji) - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the reactors (users) for the specified emoji for this message.
- getReason() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the reason for the change, if present.
- getReason() - Method in class discord4j.core.object.Ban
-
Gets the reason for the ban.
- getReason() - Method in interface discord4j.core.spec.AuditSpec
-
Returns the current audit log reason set on the spec.
- getReason() - Method in class discord4j.core.spec.BanQuerySpec
- getReason() - Method in class discord4j.core.spec.CategoryCreateSpec
- getReason() - Method in class discord4j.core.spec.CategoryEditSpec
- getReason() - Method in class discord4j.core.spec.GuildEditSpec
- getReason() - Method in class discord4j.core.spec.GuildEmojiCreateSpec
- getReason() - Method in class discord4j.core.spec.GuildEmojiEditSpec
- getReason() - Method in class discord4j.core.spec.GuildMemberEditSpec
- getReason() - Method in class discord4j.core.spec.GuildPruneSpec
- getReason() - Method in class discord4j.core.spec.InviteCreateSpec
- getReason() - Method in class discord4j.core.spec.NewsChannelCreateSpec
- getReason() - Method in class discord4j.core.spec.NewsChannelEditSpec
- getReason() - Method in class discord4j.core.spec.RoleCreateSpec
- getReason() - Method in class discord4j.core.spec.RoleEditSpec
- getReason() - Method in class discord4j.core.spec.StoreChannelEditSpec
- getReason() - Method in class discord4j.core.spec.TextChannelCreateSpec
- getReason() - Method in class discord4j.core.spec.TextChannelEditSpec
- getReason() - Method in class discord4j.core.spec.VoiceChannelCreateSpec
- getReason() - Method in class discord4j.core.spec.VoiceChannelEditSpec
- getReason() - Method in class discord4j.core.spec.WebhookCreateSpec
- getReason() - Method in class discord4j.core.spec.WebhookEditSpec
- getRecipientIds() - Method in class discord4j.core.object.entity.channel.PrivateChannel
-
Gets the IDs of the recipients for this private channel.
- getRecipients() - Method in class discord4j.core.object.entity.channel.PrivateChannel
-
Deprecated.this method will return
Set
in v3.2.0, as the recipient Users can be accessed directly. see this pull request for details - getRecipients(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.channel.PrivateChannel
-
Deprecated.this method will be removed in v3.2.0, as the recipient Users can be accessed directly. see this pull request for details
- getReferencedMessage() - Method in class discord4j.core.object.entity.Message
-
Returns the message associated with the
MessageReference
, if present. - getRegion() - Method in class discord4j.core.object.entity.Guild
-
Deprecated.Voice regions are now specific to voice channels. Use
VoiceChannel#getRtcRegion
instead. - getRegionId() - Method in class discord4j.core.object.entity.Guild
-
Deprecated.Voice region are now specific to voice channels. Use
VoiceChannel#getRtcRegion
instead. - getRegions() - Method in class discord4j.core.GatewayDiscordClient
-
Requests to retrieve the voice regions that are available.
- getRegions() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the voice regions for the guild.
- getRequestedToSpeakAt() - Method in class discord4j.core.object.VoiceState
-
Gets the time at which the user requested to speak, if present.
- getResponsibleUserId() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Deprecated.
- getRestChannel() - Method in interface discord4j.core.object.entity.channel.Channel
-
Return a
RestChannel
handle to execute REST API operations on this entity. - getRestChannel() - Method in class discord4j.core.object.entity.Message
- getRestClient() - Method in class discord4j.core.GatewayDiscordClient
-
Returns the
RestClient
used to execute REST API requests. - getRestMessage() - Method in class discord4j.core.object.entity.Message
- getRole() - Method in class discord4j.core.event.domain.role.RoleCreateEvent
-
Gets the
Role
that was created in this event. - getRole() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
-
Gets the
Role
that was deleted in this event, if present. - getRole() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the role this overwrite is associated to, if present.
- getRole(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the role this overwrite is associated to, if present, using the given retrieval strategy.
- getRoleById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the role as represented by the supplied ID.
- getRoleById(Snowflake, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getRoleById(Snowflake, Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the role represented by the supplied IDs.
- getRoleById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getRoleById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getRoleById(Snowflake, Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getRoleById(Snowflake, EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the role as represented by the supplied ID, using the given retrieval strategy.
- getRoleId() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
- getRoleId() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the ID of the role this overwrite targets.
- getRoleIds() - Method in class discord4j.core.object.entity.Guild
-
Gets the guild's roles' IDs.
- getRoleIds() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets the IDs of the roles this emoji is whitelisted to.
- getRoleIds() - Method in class discord4j.core.object.entity.Member
-
Gets the user's guild roles' IDs.
- getRoleMentionIds() - Method in class discord4j.core.object.entity.Message
-
Gets the IDs of the roles specifically mentioned in this message, with the same order as in the message.
- getRoleMentions() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the roles specifically mentioned in this message.
- getRoleMentions(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the roles specifically mentioned in this message, using the given retrieval strategy.
- getRoles() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's roles.
- getRoles() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the roles this emoji is whitelisted to.
- getRoles() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the user's guild roles.
- getRoles(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's roles, using the given retrieval strategy.
- getRoles(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the roles this emoji is whitelisted to, using the given retrieval strategy.
- getRoles(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the user's guild roles, using the given retrieval strategy.
- getRoleStore() - Method in class discord4j.core.state.StateHolder
- getRoleStore() - Method in class discord4j.core.state.StateView
- getRtcRegion() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Gets the voice region id for the voice channel.
- getRulesChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where Community guilds display rules and/or guidelines, if present.
- getRulesChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where Community guilds display rules and/or guidelines, if present, using the given retrieval strategy.
- getRulesChannelId() - Method in class discord4j.core.object.entity.Guild
-
Gets the id of the channel where Community guilds display rules and/or guidelines, if present.
- getSelf() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
Gets the bot
User
. - getSelf() - Method in class discord4j.core.GatewayDiscordClient
- getSelf() - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the bot user.
- getSelf() - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getSelf() - Method in class discord4j.core.retriever.RestEntityRetriever
- getSelf() - Method in class discord4j.core.retriever.StoreEntityRetriever
- getSelfId() - Method in class discord4j.core.GatewayDiscordClient
-
Gets the bot user's ID.
- getSelfMember() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the member as represented by the bot user's ID.
- getSessionId() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
Gets the current session ID of the connection.
- getSessionId() - Method in class discord4j.core.object.VoiceState
-
Gets the session ID for this voice state.
- getShardCoordinator() - Method in class discord4j.core.GatewayResources
-
Returns the
ShardCoordinator
that is capable of coordinating certain shard actions. - getShardCount(RestClient) - Method in class discord4j.core.shard.DefaultShardingStrategy
- getShardCount(RestClient) - Method in interface discord4j.core.shard.ShardingStrategy
-
Return the shard count used to create a group of sharded clients.
- getShardInfo() - Method in class discord4j.core.event.dispatch.DispatchContext
- getShardInfo() - Method in class discord4j.core.event.domain.Event
-
Retrieve the shard details from this
Event
. - getShards(int) - Method in class discord4j.core.shard.DefaultShardingStrategy
- getShards(int) - Method in interface discord4j.core.shard.ShardingStrategy
-
Return the shard factory used to create a group of sharded clients.
- getSize() - Method in class discord4j.core.object.entity.Attachment
-
Gets the size of the file in bytes.
- getSmallImageId() - Method in class discord4j.core.object.presence.Activity
-
Gets the ID for a small asset of the activity, usually a
Snowflake
, if present. - getSmallText() - Method in class discord4j.core.object.presence.Activity
-
Gets the text displayed when hovering over the small image of the activity, if present.
- getSourceChannelId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the id of the channel that this webhook is following (returned for Channel Follower Webhooks), if present.
- getSourceChannelName() - Method in class discord4j.core.object.entity.Webhook
-
Gets the name of the channel that this webhook is following (returned for Channel Follower Webhooks), if present.
- getSourceGuild() - Method in class discord4j.core.object.GuildTemplate
-
Gets the guild snapshot of the template.
- getSourceGuildId() - Method in class discord4j.core.object.entity.Webhook
-
Gets the guild id of the channel that this webhook is following (returned for Channel Follower Webhooks), if present.
- getSourceGuildName() - Method in class discord4j.core.object.entity.Webhook
-
Gets the guild name of the channel that this webhook is following (returned for Channel Follower Webhooks), if present.
- getSpectateSecret() - Method in class discord4j.core.object.presence.Activity
-
Gets the secret for spectating a game, if present.
- getSplash(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the splash of the guild.
- getSplashUrl(Image.Format) - Method in class discord4j.core.object.entity.Guild
-
Gets the splash URL of the guild, if present.
- getStart() - Method in class discord4j.core.object.presence.Activity
-
Gets the UNIX time (in milliseconds) of when the activity started, if present.
- getStartTime() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Gets the time at which the
User
started typing in this event. - getState() - Method in class discord4j.core.object.presence.Activity
-
Gets the user's current party status, if present.
- getStateHolder() - Method in class discord4j.core.event.dispatch.DispatchContext
- getStateView() - Method in class discord4j.core.GatewayResources
-
Deprecated.v3.2.0 will introduce a new way of working with stores, see this pull request for details
- getStatus() - Method in class discord4j.core.event.domain.lifecycle.DisconnectEvent
- getStatus() - Method in class discord4j.core.object.presence.Presence
-
Get the user's status.
- getStatus(Status.Platform) - Method in class discord4j.core.object.presence.Presence
-
Get the user's status for the given platform, if present.
- getStickers() - Method in class discord4j.core.object.entity.Message
-
Gets the stickers sent with the message.
- getStoreService() - Method in class discord4j.core.state.StateHolder
- getStoreService() - Method in class discord4j.core.state.StateView
- getStreamingUrl() - Method in class discord4j.core.object.presence.Activity
-
Gets the stream URL, if present.
- getStyle() - Method in class discord4j.core.object.component.Button
-
Gets the button's style.
- getSubscriberCount() - Method in class discord4j.core.object.entity.Integration
-
Gets how many subscribers this integration has, if present.
- getSubscriberRole() - Method in class discord4j.core.object.entity.Integration
-
Requests to retrieve the role that this integration uses for "subscribers".
- getSubscriberRole(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Integration
-
Requests to retrieve the role that this integration uses for "subscribers", using the given retrieval strategy.
- getSubscriberRoleId() - Method in class discord4j.core.object.entity.Integration
-
Gets the id that this integration uses for "subscribers".
- getSummary() - Method in class discord4j.core.object.entity.IntegrationApplication
-
Gets the summary of the app.
- getSyncedAt() - Method in class discord4j.core.object.entity.Integration
-
Gets when this integration was last synced, if present.
- getSystemChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel to which system messages are sent, if present.
- getSystemChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel to which system messages are sent, if present, using the given retrieval strategy.
- getSystemChannelFlags() - Method in class discord4j.core.object.entity.Guild
-
Returns the flags of the system
channel
. - getSystemChannelId() - Method in class discord4j.core.object.entity.Guild
-
Gets the ID of the channel where guild notices such as welcome messages and boost events are posted, if present.
- getTag() - Method in class discord4j.core.object.entity.User
-
Gets the user's username and discriminator separated by a # This is unique across the discord platform, but may change.
- getTags() - Method in class discord4j.core.object.entity.Role
-
Gets the tags this role has, if present.
- getTags() - Method in class discord4j.core.object.entity.Sticker
-
Gets the list of tags for the sticker.
- getTargetId() - Method in class discord4j.core.event.domain.interaction.MessageInteractionEvent
-
Gets the ID of the targeted Message.
- getTargetId() - Method in class discord4j.core.event.domain.interaction.UserInteractionEvent
-
Gets the ID of the targeted User.
- getTargetId() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the id of the affected entity (webhook, user, role, etc.), if present.
- getTargetId() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the ID of the user or message targeted by a user or message command.
- getTargetId() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the ID of the entity this overwrite targets.
- getTargetMessage() - Method in class discord4j.core.event.domain.interaction.MessageInteractionEvent
-
Requests to retrieve the targeted Message.
- getTargetMessage(EntityRetrievalStrategy) - Method in class discord4j.core.event.domain.interaction.MessageInteractionEvent
-
Requests to retrieve the targeted Message.
- getTargetType() - Method in class discord4j.core.object.Invite
-
Gets the type of target for this voice channel invite, if present.
- getTargetUser() - Method in class discord4j.core.event.domain.interaction.UserInteractionEvent
-
Requests to retrieve the targeted User.
- getTargetUser() - Method in class discord4j.core.object.Invite
-
Deprecated.this method will return
Optional
in v3.2.0, as the inviter User can be accessed directly. see this pull request for details - getTargetUser(EntityRetrievalStrategy) - Method in class discord4j.core.event.domain.interaction.UserInteractionEvent
-
Requests to retrieve the targeted User.
- getTargetUser(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Deprecated.this method will be removed in v3.2.0, as the inviter User can be accessed directly. see this pull request for details
- getTargetUserId() - Method in class discord4j.core.object.Invite
-
Gets the ID of the target user this invite is associated to, if present.
- getTargetUserType() - Method in class discord4j.core.object.Invite
-
Deprecated.
- getTeam() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the members of the application team, if the application belongs to a team.
- getTeamId() - Method in class discord4j.core.object.ApplicationTeamMember
-
Gets the id of the parent team of which they are a member.
- getTemplateByCode(String) - Method in class discord4j.core.GatewayDiscordClient
-
Requests to retrieve the template represented by the supplied code.
- getTemplates() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the templates of the guild.
- getTermsOfServiceUrl() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the url of the app's terms of service, if present.
- getText() - Method in class discord4j.core.object.Embed.Footer
-
Gets the footer text.
- getTextChannel() - Method in class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
-
Gets the current, new version of the
NewsChannel
that was updated in this event as an optional value of aTextChannel
. - getTextChannel() - Method in class discord4j.core.event.domain.channel.TextChannelUpdateEvent
-
Gets the current, new version of the
TextChannel
that was updated in this event as an optional value of aTextChannel
. - getThumbnail() - Method in class discord4j.core.object.Embed
-
Gets the thumbnail information, if present.
- getTimestamp() - Method in class discord4j.core.object.Embed
-
Gets the timestamp of the embed content, if present.
- getTimestamp() - Method in class discord4j.core.object.entity.Message
-
Gets when this message was sent.
- getTitle() - Method in class discord4j.core.object.Embed
-
Gets the title of the embed, if present.
- getToken() - Method in class discord4j.core.event.domain.VoiceServerUpdateEvent
-
Gets the voice connection token for the guild.
- getToken() - Method in class discord4j.core.object.command.Interaction
-
Gets the continuation token for responding to the interaction.
- getToken() - Method in class discord4j.core.object.entity.Webhook
-
Gets the secure token of this webhook.
- getTopic() - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Gets the channel topic, if present.
- getTrace() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
Gets the trace provided by Discord.
- getTrace() - Method in class discord4j.core.event.domain.lifecycle.ResumeEvent
-
Gets the trace of the event.
- getType() - Method in class discord4j.core.object.command.ApplicationCommand
-
Gets the type of the command.
- getType() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
-
Gets the type of this option.
- getType() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets the type of the option.
- getType() - Method in class discord4j.core.object.command.Interaction
-
Gets the type of interaction.
- getType() - Method in class discord4j.core.object.component.MessageComponent
-
Gets the type of the component.
- getType() - Method in class discord4j.core.object.Embed
-
Gets the type of embed, if present.
- getType() - Method in interface discord4j.core.object.entity.channel.Channel
-
Gets the type of channel.
- getType() - Method in class discord4j.core.object.entity.Integration
-
Gets the integration type (twitch, youtube, or discord).
- getType() - Method in class discord4j.core.object.entity.Message
-
Gets the type of message.
- getType() - Method in class discord4j.core.object.entity.Webhook
-
Gets the type of the webhook.
- getType() - Method in class discord4j.core.object.MessageInteraction
-
Gets the type of interaction.
- getType() - Method in class discord4j.core.object.PermissionOverwrite
-
Gets the type of the overwrite.
- getType() - Method in class discord4j.core.object.presence.Activity
-
Gets the type for this activity.
- getUpdatedAt() - Method in class discord4j.core.object.GuildTemplate
-
Gets when the template was last updated.
- getUrl() - Method in class discord4j.core.object.component.Button
-
Gets the button's url.
- getUrl() - Method in class discord4j.core.object.Embed.Author
-
Gets the URL of the author.
- getUrl() - Method in class discord4j.core.object.Embed
-
Gets the URL of the embed, if present.
- getUrl() - Method in class discord4j.core.object.Embed.Image
-
Gets the source URL of the image (only supports http(s) and attachments).
- getUrl() - Method in class discord4j.core.object.Embed.Provider
-
Gets the URL of the provider.
- getUrl() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets the source URL of the thumbnail (only supports http(s) and attachments).
- getUrl() - Method in class discord4j.core.object.Embed.Video
-
Gets the source URL of the video.
- getUrl() - Method in class discord4j.core.object.entity.Attachment
-
Gets the source URL of the file.
- getUrl(String, Image.Format) - Static method in class discord4j.core.util.ImageUtil
-
Gets the URL utilizing a path and the
Image.Format
the URL should represent. - getUsageCount() - Method in class discord4j.core.object.GuildTemplate
-
Gets the number of times the template has been used.
- getUser() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Requests to retrieve the
User
who has started typing in this event. - getUser() - Method in class discord4j.core.event.domain.guild.BanEvent
- getUser() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
- getUser() - Method in class discord4j.core.event.domain.guild.UnbanEvent
-
Gets the
User
that has been unbanned in this event. - getUser() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Requests to retrieve the
User
who added a reaction in this event. - getUser() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
Requests to retrieve the
User
who's reaction has been removed. - getUser() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Requests to retrieve the
User
whose presence has been changed in this event. - getUser() - Method in class discord4j.core.object.ApplicationTeamMember
-
Requests to retrieve the user this member is associated to.
- getUser() - Method in class discord4j.core.object.Ban
-
Gets the banned user.
- getUser() - Method in class discord4j.core.object.command.Interaction
-
Gets the invoking user.
- getUser() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the user that created this emoji.
- getUser() - Method in class discord4j.core.object.entity.Integration
-
Gets the user for this integration, if present.
- getUser() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the user this overwrite is associated to, if present.
- getUser() - Method in class discord4j.core.object.MessageInteraction
-
Gets the user who invoked the interaction.
- getUser() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the user this voice state is for.
- getUser(EntityRetrievalStrategy) - Method in class discord4j.core.object.ApplicationTeamMember
-
Requests to retrieve the user this member is associated to, using the given retrieval strategy.
- getUser(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the user this overwrite is associated to, if present, using the given retrieval strategy.
- getUser(EntityRetrievalStrategy) - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the user this voice state is for, using the given retrieval strategy.
- getUserById(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- getUserById(Snowflake) - Method in interface discord4j.core.retriever.EntityRetriever
-
Requests to retrieve the user represented by the supplied ID.
- getUserById(Snowflake) - Method in class discord4j.core.retriever.FallbackEntityRetriever
- getUserById(Snowflake) - Method in class discord4j.core.retriever.RestEntityRetriever
- getUserById(Snowflake) - Method in class discord4j.core.retriever.StoreEntityRetriever
- getUserData() - Method in class discord4j.core.object.entity.Message
-
Gets the raw author data of this message.
- getUserData() - Method in class discord4j.core.object.entity.User
-
Gets the data of the user.
- getUserId() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
- getUserId() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- getUserId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- getUserId() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
- getUserId() - Method in class discord4j.core.object.ApplicationTeamMember
-
Gets the id of the user associated with this team member.
- getUserId() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the user who made the changes, if present.
- getUserId() - Method in class discord4j.core.object.VoiceState
-
Gets the user ID this voice state is for.
- getUserLimit() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Gets the user limit of this voice channel.
- getUserMentionIds() - Method in class discord4j.core.object.entity.Message
-
Gets the IDs of the users specifically mentioned in this message, with the same order as in the message.
- getUserMentions() - Method in class discord4j.core.object.entity.Message
-
Deprecated.this method will have its return type changed to List in v3.2.0
- getUserMentions(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Message
-
Deprecated.for removal in v3.2.0, as entity retrieval is not used for user mentions anymore
- getUsername() - Method in class discord4j.core.object.entity.User
-
Gets the user's username, not unique across the platform.
- getUsers() - Method in class discord4j.core.GatewayDiscordClient
-
Retrieve the currently stored (cached) users.
- getUserStore() - Method in class discord4j.core.state.StateHolder
- getUserStore() - Method in class discord4j.core.state.StateView
- getUses() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets the number of times this invite has been used (always will be 0).
- getUses() - Method in class discord4j.core.object.ExtendedInvite
-
Gets the number of times this invite has been used.
- getValue() - Method in enum discord4j.core.object.ApplicationTeamMember.MembershipState
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.audit.ActionType
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.command.ApplicationCommand.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in class discord4j.core.object.command.ApplicationCommandInteractionOption
- getValue() - Method in enum discord4j.core.object.command.ApplicationCommandOption.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
Gets the value of this choice.
- getValue() - Method in enum discord4j.core.object.command.Interaction.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.component.Button.Style
- getValue() - Method in enum discord4j.core.object.component.MessageComponent.Type
- getValue() - Method in class discord4j.core.object.component.SelectMenu.Option
-
Gets the option's value.
- getValue() - Method in class discord4j.core.object.Embed.Field
-
Gets the value of the field.
- getValue() - Method in enum discord4j.core.object.Embed.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.channel.Channel.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.ContentFilterLevel
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.MfaLevel
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.NotificationLevel
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.NsfwLevel
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.PremiumTier
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.SystemChannelFlag
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Guild.VerificationLevel
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Integration.ExpireBehavior
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Message.Flag
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Message.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Sticker.Format
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.User.Flag
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.entity.Webhook.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.Invite.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.PermissionOverwrite.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.presence.Activity.Flag
- getValue() - Method in enum discord4j.core.object.presence.Activity.Type
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.presence.Status
-
Gets the underlying value as represented by Discord.
- getValue() - Method in enum discord4j.core.object.Region.Id
-
Gets the underlying value as represented by Discord.
- getValue() - Method in class discord4j.core.state.ParameterData
- getValues() - Method in class discord4j.core.event.domain.interaction.SelectMenuInteractionEvent
-
Get the values selected in the menu.
- getValues() - Method in class discord4j.core.object.command.ApplicationCommandInteraction
-
Gets the values selected if this is a select menu interaction.
- getValueStore(Class<K>, Class<V>) - Method in class discord4j.core.shard.JdkKeyStoreRegistry
- getValueStore(Class<K>, Class<V>) - Method in interface discord4j.core.shard.KeyStoreRegistry
-
Return the saved
Store
with the given key and value type as parameters. - getVanityUrlCode() - Method in class discord4j.core.object.entity.Guild
-
Gets the vanity url code of the guild, if present.
- getVerificationLevel() - Method in class discord4j.core.object.entity.Guild
-
Gets the level of verification required for the guild.
- getVideo() - Method in class discord4j.core.object.Embed
-
Gets the video information, if present.
- getVideoQualityMode() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Gets the camera video quality mode of the voice channel.
- getVoiceConnection() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Returns the current voice connection registered for this voice channel's guild.
- getVoiceConnection() - Method in class discord4j.core.object.entity.Guild
-
Returns the current voice connection registered for this guild.
- getVoiceConnectionFactory() - Method in class discord4j.core.GatewayDiscordClient
-
Returns the
VoiceConnectionFactory
instance created by thisGatewayDiscordClient
. - getVoiceConnectionRegistry() - Method in class discord4j.core.GatewayDiscordClient
-
Return the
VoiceConnectionRegistry
for thisGatewayDiscordClient
. - getVoiceReactorResources() - Method in class discord4j.core.GatewayResources
-
Return the
VoiceReactorResources
used to perform Voice Gateway-related operations. - getVoiceReconnectOptions() - Method in class discord4j.core.GatewayResources
-
Return the reconnect policy used to retry a connection to the Voice Gateway.
- getVoiceState() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve this user's voice state for this guild.
- getVoiceStates() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Requests to retrieve the voice states of this voice channel.
- getVoiceStates() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the voice states of the guild.
- getVoiceStateStore() - Method in class discord4j.core.state.StateHolder
- getVoiceStateStore() - Method in class discord4j.core.state.StateView
- getWebhook() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the webhook that generated this message, if present.
- getWebhook() - Method in class discord4j.core.object.FollowedChannel
-
Requests to retrieve the webhook that has been created when following the news channel.
- getWebhookById(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
-
Requests to retrieve the webhook represented by the supplied ID.
- getWebhookId() - Method in class discord4j.core.object.entity.Message
-
Gets the ID the webhook that generated this message, if present.
- getWebhookId() - Method in class discord4j.core.object.FollowedChannel
-
Returns the ID of the webhook created as the result of following the news channel.
- getWebhooks() - Method in interface discord4j.core.object.entity.channel.GuildMessageChannel
-
Requests to retrieve the webhooks of the channel.
- getWebhooks() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the webhooks of the guild.
- getWidgetChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel for the server widget, if present.
- getWidgetChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel for the server widget, if present, using the given retrieval strategy.
- getWidgetChannelId() - Method in class discord4j.core.object.entity.Guild
-
Gets the channel ID that the widget will generate an invite to, if present.
- getWidth() - Method in class discord4j.core.object.Embed.Image
-
Gets the width of the image.
- getWidth() - Method in class discord4j.core.object.Embed.Thumbnail
-
Gets the width of the thumbnail.
- getWidth() - Method in class discord4j.core.object.Embed.Video
-
Gets the width of the video.
- getWidth() - Method in class discord4j.core.object.entity.Attachment
-
Gets the width of the file, if present.
- GROUP_DM - discord4j.core.object.entity.channel.Channel.Type
-
Represents a group DM.
- Guild - Class in discord4j.core.object.entity
-
A Discord guild.
- Guild(long, boolean) - Constructor for class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
- Guild(GatewayDiscordClient, GuildData) - Constructor for class discord4j.core.object.entity.Guild
-
Constructs a
Guild
with an associatedGatewayDiscordClient
and Discord data. - GUILD_CATEGORY - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
Category
. - GUILD_DISCOVERY_DISQUALIFIED - discord4j.core.object.entity.Message.Type
-
A message created when the Guild is disqualified for Discovery Feature
- GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING - discord4j.core.object.entity.Message.Type
- GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING - discord4j.core.object.entity.Message.Type
- GUILD_DISCOVERY_REQUALIFIED - discord4j.core.object.entity.Message.Type
-
A message created when the Guild is requalified for Discovery Feature
- GUILD_MEMBER_JOIN - discord4j.core.object.entity.Message.Type
-
A message created when an user joins a guild.
- GUILD_NEWS - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
NewsChannel
. - GUILD_STAGE_VOICE - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
VoiceChannel
for hosting events with an audience. - GUILD_STORE - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
StoreChannel
. - GUILD_TEXT - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
TextChannel
. - GUILD_UPDATE - discord4j.core.object.audit.ActionType
- GUILD_VOICE - discord4j.core.object.entity.channel.Channel.Type
-
Represents a
VoiceChannel
. - Guild.ContentFilterLevel - Enum in discord4j.core.object.entity
-
Automatically scan and delete messages sent in the server that contain explicit content.
- Guild.MfaLevel - Enum in discord4j.core.object.entity
-
Prevent potentially dangerous administrative actions for users without two-factor authentication enabled.
- Guild.NotificationLevel - Enum in discord4j.core.object.entity
-
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 - Enum in discord4j.core.object.entity
- Guild.PremiumTier - Enum in discord4j.core.object.entity
-
Represent the server Premium Tier (aka boost level) of the
Guild
. - Guild.SystemChannelFlag - Enum in discord4j.core.object.entity
-
Describes system channel flags.
- Guild.VerificationLevel - Enum in discord4j.core.object.entity
-
Members
of the server must meet the following criteria before they can send messages in text channels or initiate a direct message conversation. - GuildChannel - Interface in discord4j.core.object.entity.channel
-
A Discord channel associated to a
Guild
. - GuildCreateEvent - Class in discord4j.core.event.domain.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 manyguild deletes
will be dispatched), this event will be dispatched as guilds become available again. When the bot is added to a guild. - GuildCreateEvent(GatewayDiscordClient, ShardInfo, Guild) - Constructor for class discord4j.core.event.domain.guild.GuildCreateEvent
- GuildCreateFromTemplateSpec - Class in discord4j.core.spec
-
Spec used to create a guild from a template.
- GuildCreateFromTemplateSpec() - Constructor for class discord4j.core.spec.GuildCreateFromTemplateSpec
- GuildCreateSpec - Class in discord4j.core.spec
-
A spec used to configure and create a
Guild
. - GuildCreateSpec() - Constructor for class discord4j.core.spec.GuildCreateSpec
- GuildDeleteEvent - Class in discord4j.core.event.domain.guild
-
Dispatched in two different scenarios: The bot is kicked from or leaves a guild. A guild becomes unavailable during an outage.
- GuildDeleteEvent(GatewayDiscordClient, ShardInfo, long, Guild, boolean) - Constructor for class discord4j.core.event.domain.guild.GuildDeleteEvent
- GuildEditSpec - Class in discord4j.core.spec
-
A spec used to selectively modify properties from a
Guild
. - GuildEditSpec() - Constructor for class discord4j.core.spec.GuildEditSpec
- GuildEmoji - Class in discord4j.core.object.entity
-
A Discord guild emoji.
- GuildEmoji(GatewayDiscordClient, EmojiData, long) - Constructor for class discord4j.core.object.entity.GuildEmoji
-
Constructs a
GuildEmoji
with an associatedGatewayDiscordClient
and Discord data. - GuildEmojiCreateSpec - Class in discord4j.core.spec
-
Spec used to create
GuildEmoji
objects. - GuildEmojiCreateSpec() - Constructor for class discord4j.core.spec.GuildEmojiCreateSpec
- GuildEmojiEditSpec - Class in discord4j.core.spec
-
Spec used to modify an existing
GuildEmoji
. - GuildEmojiEditSpec() - Constructor for class discord4j.core.spec.GuildEmojiEditSpec
- GuildEvent - Class in discord4j.core.event.domain.guild
-
Represents an event related to a
Guild
. - GuildEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.guild.GuildEvent
- GuildMemberEditSpec - Class in discord4j.core.spec
-
Spec used to modify guild members.
- GuildMemberEditSpec() - Constructor for class discord4j.core.spec.GuildMemberEditSpec
- GuildMessageChannel - Interface in discord4j.core.object.entity.channel
- GuildPruneCountSpec - Class in discord4j.core.spec
-
Spec used to retrieve the number of members that would be removed in a prune operation.
- GuildPruneCountSpec() - Constructor for class discord4j.core.spec.GuildPruneCountSpec
- GuildPruneSpec - Class in discord4j.core.spec
-
Spec used to begin a prune operation.
- GuildPruneSpec() - Constructor for class discord4j.core.spec.GuildPruneSpec
- GuildTemplate - Class in discord4j.core.object
-
A Discord Guild Template.
- GuildTemplate(GatewayDiscordClient, TemplateData) - Constructor for class discord4j.core.object.GuildTemplate
-
Constructs a
GuildTemplate
with an associatedGatewayDiscordClient
and Discord data. - GuildTemplateCreateSpec - Class in discord4j.core.spec
-
Spec to create a guild template.
- GuildTemplateCreateSpec() - Constructor for class discord4j.core.spec.GuildTemplateCreateSpec
- GuildTemplateEditSpec - Class in discord4j.core.spec
-
Spec to edit a guild template.
- GuildTemplateEditSpec() - Constructor for class discord4j.core.spec.GuildTemplateEditSpec
- GuildUpdateEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a guild is updated.
- GuildUpdateEvent(GatewayDiscordClient, ShardInfo, Guild, Guild) - Constructor for class discord4j.core.event.domain.guild.GuildUpdateEvent
H
- handle(DispatchContext<D>) - Method in interface discord4j.core.event.dispatch.DispatchEventMapper
-
Process a
DispatchContext
to potentially obtain anEvent
. - handle(DispatchContext<D>) - Method in interface discord4j.core.event.dispatch.DispatchHandler
-
Operates and transforms a Dispatch event with its context, from gateway to user-friendly Events, so it may be further routed to an event dispatcher downstream.
- handle(DispatchContext<D>) - Method in class discord4j.core.event.dispatch.DispatchHandlers
-
Process a
Dispatch
object wrapped with its context to potentially obtain anEvent
. - hasAnimatedAvatar() - Method in class discord4j.core.object.entity.User
-
Gets if the user's avatar is animated.
- hasGenericStores() - Method in class discord4j.core.shard.ShardAwareStoreService
- hashCode() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
- hashCode() - Method in class discord4j.core.object.entity.ApplicationInfo
- hashCode() - Method in class discord4j.core.object.entity.Attachment
- hashCode() - Method in class discord4j.core.object.entity.Guild
- hashCode() - Method in class discord4j.core.object.entity.GuildEmoji
- hashCode() - Method in class discord4j.core.object.entity.Integration
- hashCode() - Method in class discord4j.core.object.entity.Message
- hashCode() - Method in class discord4j.core.object.entity.Role
- hashCode() - Method in class discord4j.core.object.entity.User
- hashCode() - Method in class discord4j.core.object.entity.Webhook
- hashCode() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
- hashCode() - Method in class discord4j.core.object.reaction.ReactionEmoji.Unicode
- hashCode(Entity) - Static method in class discord4j.core.util.EntityUtil
-
An utility that gets the hash code of an entity.
- hasHigherRoles(Set<Snowflake>) - Method in class discord4j.core.object.entity.Member
-
Requests to determine if the position of this member's highest role is greater than the highest position of the provided roles.
- hasLongObjStores() - Method in class discord4j.core.shard.ShardAwareStoreService
- HIGH - discord4j.core.object.entity.Guild.VerificationLevel
-
Must be a member of the server for longer than 10 minutes.
- HOIST - Static variable in class discord4j.core.object.audit.ChangeKey
-
Role is now displayed/no longer displayed separate from online users
- HONGKONG - discord4j.core.object.Region.Id
- hookOnEvent(Event) - Method in class discord4j.core.event.ReactiveEventAdapter
- HOUSE_BALANCE - discord4j.core.object.entity.User.Flag
- HOUSE_BRAVERY - discord4j.core.object.entity.User.Flag
- HOUSE_BRILLIANCE - discord4j.core.object.entity.User.Flag
- HYPESQUAD_EVENTS - discord4j.core.object.entity.User.Flag
I
- ICON - Static variable in class discord4j.core.object.audit.ChangeKey
-
Icon changed
- ID - Static variable in class discord4j.core.object.audit.ChangeKey
-
The id of the changed entity - sometimes used in conjunction with other keys
- ID - Static variable in class discord4j.core.object.audit.OptionKey
-
Id of the overwritten entity.
- identity() - Static method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Create an
InvalidationStrategy
that falls through the underlyingStore.invalidate()
implementation to invalidate entries on shard session closing. - idle() - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display an idle status.
- idle(ActivityUpdateRequest) - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display an idle status along with a custom activity.
- IDLE - discord4j.core.object.presence.Status
- IMAGE - discord4j.core.object.Embed.Type
-
An embed generated by an image.
- ImageUtil - Class in discord4j.core.util
-
An utility class for image processing.
- INCOMING - discord4j.core.object.entity.Webhook.Type
-
Incoming Webhooks can post messages to channels with a generated token.
- INDIA - discord4j.core.object.Region.Id
- indices(int...) - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Set the list of shard indices to identify to Discord Gateway.
- indices(Function<Integer, Publisher<Integer>>) - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Set a generator function to derive a
Publisher
of shard indices to identify to Discord Gateway. - init(StoreContext) - Method in class discord4j.core.shard.ShardAwareStoreService
- INSTANCE - discord4j.core.object.presence.Activity.Flag
- INTEGER - discord4j.core.object.command.ApplicationCommandOption.Type
- Integration - Class in discord4j.core.object.entity
-
A Discord integration.
- Integration(GatewayDiscordClient, IntegrationData, long) - Constructor for class discord4j.core.object.entity.Integration
-
Constructs an
Integration
with an associatedGatewayDiscordClient
and Discord data. - INTEGRATION_CREATE - discord4j.core.object.audit.ActionType
- INTEGRATION_DELETE - discord4j.core.object.audit.ActionType
- INTEGRATION_UPDATE - discord4j.core.object.audit.ActionType
- Integration.ExpireBehavior - Enum in discord4j.core.object.entity
-
Represents the various integration expire behaviors.
- IntegrationAccount - Class in discord4j.core.object
-
A Discord Integration Account.
- IntegrationAccount(GatewayDiscordClient, IntegrationAccountData) - Constructor for class discord4j.core.object.IntegrationAccount
-
Constructs a
IntegrationAccount
with an associatedGatewayDiscordClient
and Discord data. - IntegrationApplication - Class in discord4j.core.object.entity
-
A Discord Integration Application.
- IntegrationApplication(GatewayDiscordClient, IntegrationApplicationData) - Constructor for class discord4j.core.object.entity.IntegrationApplication
-
Constructs a
IntegrationApplication
with an associatedGatewayDiscordClient
and Discord data. - IntegrationCreateEvent - Class in discord4j.core.event.domain.integration
-
Dispatched when an integration is created.
- IntegrationCreateEvent(GatewayDiscordClient, ShardInfo, long, Integration) - Constructor for class discord4j.core.event.domain.integration.IntegrationCreateEvent
- IntegrationDeleteEvent - Class in discord4j.core.event.domain.integration
-
Dispatched when an integration is deleted.
- IntegrationDeleteEvent(GatewayDiscordClient, ShardInfo, long, long, Long) - Constructor for class discord4j.core.event.domain.integration.IntegrationDeleteEvent
- IntegrationsUpdateEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when guild integrations are updated.
- IntegrationsUpdateEvent(GatewayDiscordClient, ShardInfo, long) - Constructor for class discord4j.core.event.domain.guild.IntegrationsUpdateEvent
- IntegrationUpdateEvent - Class in discord4j.core.event.domain.integration
-
Dispatched when an integration is updated.
- IntegrationUpdateEvent(GatewayDiscordClient, ShardInfo, long, Integration) - Constructor for class discord4j.core.event.domain.integration.IntegrationUpdateEvent
- Interaction - Class in discord4j.core.object.command
-
A Discord interaction.
- Interaction(GatewayDiscordClient, InteractionData) - Constructor for class discord4j.core.object.command.Interaction
-
Constructs an
Interaction
with an associatedGatewayDiscordClient
and Discord data. - Interaction.Type - Enum in discord4j.core.object.command
-
Represents the various types of interaction.
- InteractionApplicationCommandCallbackSpec - Class in discord4j.core.spec
- InteractionApplicationCommandCallbackSpec() - Constructor for class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- InteractionCreateEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user in a guild interacts with an application command or component.
- InteractionCreateEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.InteractionCreateEvent
- invalidate() - Method in class discord4j.core.shard.ShardAwareStore
- invalidate(ShardInfo, StateHolder) - Method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Invalidate the contents of the given
StateHolder
depending on the triggeringshard
. - invalidateStores() - Method in class discord4j.core.state.StateHolder
- InvalidationStrategy - Interface in discord4j.core.shard
-
Deprecated.to be removed and superseded by new Store abstraction under v3.2
- invisible() - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display an invisible status.
- INVISIBLE - discord4j.core.object.presence.Status
- Invite - Class in discord4j.core.object
-
A Discord invite.
- Invite(GatewayDiscordClient, InviteData) - Constructor for class discord4j.core.object.Invite
-
Constructs a
Invite
with an associatedGatewayDiscordClient
and Discord data. - INVITE_CHANNEL_ID - Static variable in class discord4j.core.object.audit.ChangeKey
-
Channel for invite code changed
- INVITE_CODE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Invite code changed
- INVITE_CREATE - discord4j.core.object.audit.ActionType
- INVITE_DELETE - discord4j.core.object.audit.ActionType
- INVITE_MAX_AGE - Static variable in class discord4j.core.object.audit.ChangeKey
-
How long invite code lasts changed
- INVITE_MAX_USES - Static variable in class discord4j.core.object.audit.ChangeKey
-
Change to max number of times invite code can be used
- INVITE_TEMPORARY - Static variable in class discord4j.core.object.audit.ChangeKey
-
Invite code is temporary/never expires
- INVITE_UPDATE - discord4j.core.object.audit.ActionType
- INVITE_USES - Static variable in class discord4j.core.object.audit.ChangeKey
-
Number of times invite code used changed
- Invite.Type - Enum in discord4j.core.object
-
Represents the various types of target user for an invite.
- InviteCreateEvent - Class in discord4j.core.event.domain
-
Dispatched when a new invite to a channel is created.
- InviteCreateEvent(GatewayDiscordClient, ShardInfo, Long, long, String, User, Instant, int, int, int, boolean) - Constructor for class discord4j.core.event.domain.InviteCreateEvent
- InviteCreateSpec - Class in discord4j.core.spec
-
Spec used to create guild channel
Invite
objects. - InviteCreateSpec() - Constructor for class discord4j.core.spec.InviteCreateSpec
- INVITED - discord4j.core.object.ApplicationTeamMember.MembershipState
- InviteDeleteEvent - Class in discord4j.core.event.domain
-
Dispatched when an invite to a channel is deleted.
- InviteDeleteEvent(GatewayDiscordClient, ShardInfo, Long, long, String) - Constructor for class discord4j.core.event.domain.InviteDeleteEvent
- INVITER_ID - Static variable in class discord4j.core.object.audit.ChangeKey
-
Person who created invite code changed
- IS_CROSSPOST - discord4j.core.object.entity.Message.Flag
-
This message originated from a message in another channel (via Channel Following).
- isAnimated() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets whether this emoji is animated.
- isAnimated() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
-
Gets whether this emoji is animated.
- isAvailable() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
-
Whether or not the Guild has been made available via a
GuildCreateEvent
- isAvailable() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets whether this emoji is available for use.
- isBot() - Method in class discord4j.core.object.entity.User
-
Gets whether the user is a bot.
- isContentChanged() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Gets whether or not the content of the
Message
has been changed in this event. - isCurrentPending() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
-
Gets whether the user has currently not yet passed the guild's Membership Screening requirements.
- isCustom() - Method in class discord4j.core.object.Region
-
Gets if this is a custom voice region.
- isDeaf() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is deafened by the server.
- isDefault() - Method in class discord4j.core.object.component.SelectMenu.Option
-
Gets whether the option is default.
- isDeprecated() - Method in class discord4j.core.object.Region
-
Gets if this is a deprecated voice region.
- isDisabled() - Method in class discord4j.core.object.component.Button
-
Gets whether button is disabled.
- isDisabled() - Method in class discord4j.core.object.component.SelectMenu
-
Gets whether the select menu is disabled (i.e., the user is prevented from selecting any options).
- isEmbedEnabled() - Method in class discord4j.core.object.entity.Guild
-
Deprecated.Use
Guild#isWidgetEnabled
instead - isEmbedsChanged() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- isEnabled() - Method in class discord4j.core.object.entity.Integration
-
Gets whether the integration is enabled.
- isEnableEmoticons() - Method in class discord4j.core.object.entity.Integration
-
Gets whether emoticons should be synced for this integration (twitch only currently).
- isEveryone() - Method in class discord4j.core.object.entity.Role
-
Gets whether this role corresponds to the @everyone role.
- isHigher(Snowflake) - Method in class discord4j.core.object.entity.Member
-
Requests to determine if this member is higher in the role hierarchy than the member as represented by the supplied ID or signal IllegalArgumentException if the member as represented by the supplied ID is in a different guild than this member.
- isHigher(Member) - Method in class discord4j.core.object.entity.Member
-
Requests to determine if this member is higher in the role hierarchy than the provided member or signal IllegalArgumentException if the provided member is in a different guild than this member.
- isHoisted() - Method in class discord4j.core.object.entity.Role
-
Gets whether if this role is pinned in the user listing.
- isInline() - Method in class discord4j.core.object.Embed.Field
-
Gets whether or not this field should display inline.
- isInstance() - Method in class discord4j.core.object.presence.Activity
-
Gets whether or not the activity is an instanced game session.
- isJoinEvent() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
-
Gets whether this event is a voice channel join event.
- isLarge() - Method in class discord4j.core.object.entity.Guild
-
Gets whether this guild is considered large.
- isLeaveEvent() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
-
Gets whether this event is a voice channel leave event.
- isManaged() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets whether this emoji is managed.
- isManaged() - Method in class discord4j.core.object.entity.Role
-
Gets whether this role is managed by an integration.
- isMemberConnected(Snowflake) - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Requests to determine if the member represented by the provided
Snowflake
is connected to this voice channel. - isMentionable() - Method in class discord4j.core.object.entity.Role
-
Gets whether this role is mentionable.
- isMoveEvent() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
-
Gets whether this event is a voice channel move event.
- isMuted() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is muted by the server.
- isNsfw() - Method in class discord4j.core.object.entity.channel.TextChannel
-
Gets whether this channel is considered NSFW (Not Safe For Work).
- isNsfw() - Method in class discord4j.core.object.entity.Guild
-
Deprecated.Use
getNsfwLevel()
instead - isOptimal() - Method in class discord4j.core.object.Region
-
Gets if the region is closest to the current user's serviceMediator.
- isPending() - Method in class discord4j.core.object.entity.Member
-
Gets whether the user has not yet passed the guild's Membership Screening requirements.
- isPinned() - Method in class discord4j.core.object.entity.Message
-
Gets whether this message is pinned.
- isPremiumSubscriberRole() - Method in class discord4j.core.object.RoleTags
-
Gets whether this is the guild's premium subscriber role.
- isPublic() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets whether only the app owner can join the app's bot to guilds.
- isRequestingEntireList(RequestGuildMembers) - Static method in class discord4j.core.util.ValidationUtil
-
Return whether the given
RequestGuildMembers
instance is requesting an entire guild's list of members. - isRequired() - Method in class discord4j.core.object.command.ApplicationCommandOption
-
Gets whether this option is required.
- isRevoked() - Method in class discord4j.core.object.entity.Integration
-
Gets whether integration has been revoked.
- isSelfDeaf() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is locally deafened.
- isSelfMuted() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is locally muted.
- isSelfStreaming() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is streaming using "Go Live".
- isSelfVideoEnabled() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user's camera is enabled.
- isSpoiler() - Method in class discord4j.core.object.entity.Attachment
-
Gets whether the attachment is a spoiler.
- isSuppressed() - Method in class discord4j.core.object.VoiceState
-
Gets whether this user is muted by the current user.
- isSyncing() - Method in class discord4j.core.object.entity.Integration
-
Gets whether the integration is syncing.
- isTemporary() - Method in class discord4j.core.event.domain.InviteCreateEvent
-
Gets whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role).
- isTts() - Method in class discord4j.core.object.entity.Message
-
Gets whether this was a TTS (Text-To-Speech) message.
- isUnavailable() - Method in class discord4j.core.event.domain.guild.GuildDeleteEvent
-
Gets whether or not the
Guild
is now unavailable. - isUnavailable() - Method in class discord4j.core.object.entity.Guild
-
Gets whether this guild is unavailable.
- isVip() - Method in class discord4j.core.object.Region
-
Gets if this is a VIP region.
- isWidgetEnabled() - Method in class discord4j.core.object.entity.Guild
-
Gets whether or not the server widget is enabled.
J
- JAPAN - discord4j.core.object.Region.Id
- JdkKeyStore<K extends Comparable<K>> - Class in discord4j.core.shard
-
A repository for the entity keys tracked by each shard.
- JdkKeyStore() - Constructor for class discord4j.core.shard.JdkKeyStore
- JdkKeyStoreRegistry - Class in discord4j.core.shard
-
Registry implementation that is backed by JDK collections like
Map
instances to hold multipleStore
andJdkKeyStore
, using the valueClass
they hold as key. - JdkKeyStoreRegistry() - Constructor for class discord4j.core.shard.JdkKeyStoreRegistry
- join(Consumer<? super VoiceChannelJoinSpec>) - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Request to join this voice channel upon subscription.
- JOIN - discord4j.core.object.presence.Activity.Flag
- JOIN_REQUEST - discord4j.core.object.presence.Activity.Flag
K
- keys() - Method in class discord4j.core.shard.ShardAwareStore
- keys(int) - Method in class discord4j.core.shard.JdkKeyStore
- keys(int) - Method in interface discord4j.core.shard.KeyStore
-
Return an unmodifiable
Set
of keys for the given shard index. - KeyStore<K extends Comparable<K>> - Interface in discord4j.core.shard
- KeyStoreRegistry - Interface in discord4j.core.shard
-
Registry that holds all
Store
andKeyStore
instances in order to support aShardAwareStoreService
creating and invalidating on a per-shard basis. - kick() - Method in class discord4j.core.object.entity.Member
-
Requests to kick this member.
- kick(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to kick the specified user from this guild.
- kick(Snowflake, String) - Method in class discord4j.core.object.entity.Guild
-
Requests to kick the specified user from this guild while optionally specifying a reason.
- kick(String) - Method in class discord4j.core.object.entity.Member
-
Requests to kick this member while optionally specifying the reason.
- KICK - discord4j.core.object.entity.Integration.ExpireBehavior
-
Kick.
L
- LayoutComponent - Class in discord4j.core.object.component
-
A message component that determines how components are laid out in a message and has
ActionComponent
children. - LayoutComponent(ComponentData) - Constructor for class discord4j.core.object.component.LayoutComponent
- leave() - Method in class discord4j.core.object.entity.Guild
-
Requests to leave this guild.
- link(String, ReactionEmoji) - Static method in class discord4j.core.object.component.Button
-
Creates a
link
button. - link(String, ReactionEmoji, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
link
button. - link(String, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
link
button. - LINK - discord4j.core.object.component.Button.Style
- LINK - discord4j.core.object.Embed.Type
-
An embed generated by a link.
- listening(String) - Static method in class discord4j.core.object.presence.Activity
- LISTENING - discord4j.core.object.presence.Activity.Type
-
"Listening to {name}"
- ListUtil - Class in discord4j.core.util
- ListUtil() - Constructor for class discord4j.core.util.ListUtil
- LOADING - discord4j.core.object.entity.Message.Flag
-
This message is an Interaction Response and the bot is "thinking".
- LocalShardCoordinator - Class in discord4j.core.shard
-
A centralized local
ShardCoordinator
that can operate on a single JVM instance to coordinate Gateway connection and identifying attempts across multiple shards. - log - Static variable in interface discord4j.core.event.EventDispatcher
- login() - Method in class discord4j.core.DiscordClient
-
Login the client to the gateway, using the recommended amount of shards, locally coordinated.
- login() - Method in class discord4j.core.shard.GatewayBootstrap
-
Connect to the Discord Gateway upon subscription to build a
GatewayClient
from the set of options configured by this builder. - login(Function<O, GatewayClient>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Connect to the Discord Gateway upon subscription using a custom
factory
to build aGatewayClient
from the set of options configured by this builder. - logout() - Method in class discord4j.core.GatewayDiscordClient
-
Disconnects this
GatewayDiscordClient
from Discord upon subscribing. - LOTTIE - discord4j.core.object.entity.Sticker.Format
-
Represents the Lottie format.
- LOW - discord4j.core.object.entity.Guild.VerificationLevel
-
Must have verified email on account.
M
- MAX_CHARACTER_LENGTH - Static variable in class discord4j.core.object.Embed
-
The maximum amount of total characters that can be present in an embed.
- MAX_CONTENT_LENGTH - Static variable in class discord4j.core.object.entity.Message
-
The maximum amount of characters that can be in the contents of a message.
- MAX_DESCRIPTION_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommand
-
The maximum amount of characters that can be in an application command description.
- MAX_DESCRIPTION_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommandOption
-
The maximum amount of characters that can be in an application command option description.
- MAX_DESCRIPTION_LENGTH - Static variable in class discord4j.core.object.Embed
-
The maximum amount of characters that can be in an embed description.
- MAX_FIELDS - Static variable in class discord4j.core.object.Embed
-
The maximum amount of fields that can be appended to an embed.
- MAX_NAME_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommand
-
The maximum amount of characters that can be in an application command name.
- MAX_NAME_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommandOption
-
The maximum amount of characters that can be in an application command option name.
- MAX_NAME_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
The maximum amount of characters that can be in an application command option choice name.
- MAX_NAME_LENGTH - Static variable in class discord4j.core.object.Embed.Author
-
The maximum amount of characters that can be in an author's name.
- MAX_NAME_LENGTH - Static variable in class discord4j.core.object.Embed.Field
-
The maximum amount of characters that can be in a field name.
- MAX_REASON_LENGTH - Static variable in class discord4j.core.object.audit.AuditLogEntry
-
The maximum amount of characters that can be in an audit log reason.
- MAX_TEXT_LENGTH - Static variable in class discord4j.core.object.Embed.Footer
-
The maximum amount of characters that can be in a footer text.
- MAX_TITLE_LENGTH - Static variable in class discord4j.core.object.Embed
-
The maximum amount of characters that can be in an embed title.
- MAX_VALUE_LENGTH - Static variable in class discord4j.core.object.command.ApplicationCommandOptionChoice
-
The maximum amount of characters that can be in an application command option choice value.
- MAX_VALUE_LENGTH - Static variable in class discord4j.core.object.Embed.Field
-
The maximum amount of characters that can be in a field value.
- maxConcurrency(int) - Method in class discord4j.core.shard.DefaultShardingStrategy.Builder
-
Set the sharding maximum concurrency to use when identifying to the Discord Gateway, determining the amount of shards that will be concurrently identified.
- MEDIUM - discord4j.core.object.entity.Guild.VerificationLevel
-
Must be registered on Discord for longer than 5 minutes.
- Member - Class in discord4j.core.object.entity
-
A Discord guild member.
- Member(GatewayDiscordClient, MemberData, long) - Constructor for class discord4j.core.object.entity.Member
-
Constructs a
Member
with an associatedGatewayDiscordClient
and Discord data. - MEMBER - discord4j.core.object.PermissionOverwrite.Type
-
The
Member
entity. - MEMBER_BAN_ADD - discord4j.core.object.audit.ActionType
- MEMBER_BAN_REMOVE - discord4j.core.object.audit.ActionType
- MEMBER_DISCONNECT - discord4j.core.object.audit.ActionType
- MEMBER_KICK - discord4j.core.object.audit.ActionType
- MEMBER_MOVE - discord4j.core.object.audit.ActionType
- MEMBER_PRUNE - discord4j.core.object.audit.ActionType
- MEMBER_ROLE_UPDATE - discord4j.core.object.audit.ActionType
- MEMBER_UPDATE - discord4j.core.object.audit.ActionType
- MemberChunkEvent - Class in discord4j.core.event.domain.guild
-
Dispatched as members are streamed to the client from Discord.
- MemberChunkEvent(GatewayDiscordClient, ShardInfo, long, Set<Member>, int, int, List<Snowflake>, String) - Constructor for class discord4j.core.event.domain.guild.MemberChunkEvent
- MemberJoinEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a user joins a guild.
- MemberJoinEvent(GatewayDiscordClient, ShardInfo, Member, long) - Constructor for class discord4j.core.event.domain.guild.MemberJoinEvent
- MemberLeaveEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a user leaves a guild OR is kicked from it.
- MemberLeaveEvent(GatewayDiscordClient, ShardInfo, User, long, Member) - Constructor for class discord4j.core.event.domain.guild.MemberLeaveEvent
- MemberRequestFilter - Interface in discord4j.core.shard
-
A filter to customize the guild member request strategy.
- MEMBERS_REMOVED - Static variable in class discord4j.core.object.audit.OptionKey
-
Number of members removed by the prune.
- MEMBERS_WITHOUT_ROLES - discord4j.core.object.entity.Guild.ContentFilterLevel
-
Scan messages from members without a role.
- MemberUpdateEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a user's nickname or roles change in a guild.
- MemberUpdateEvent(GatewayDiscordClient, ShardInfo, long, long, Member, List<Long>, String, String, String, Boolean) - Constructor for class discord4j.core.event.domain.guild.MemberUpdateEvent
- MENTIONABLE - discord4j.core.object.command.ApplicationCommandOption.Type
- MENTIONABLE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Role is now mentionable/unmentionable
- mentionsEveryone() - Method in class discord4j.core.object.entity.Message
-
Gets whether this message mentions everyone.
- Message - Class in discord4j.core.object.entity
-
A Discord message.
- Message(GatewayDiscordClient, MessageData) - Constructor for class discord4j.core.object.entity.Message
-
Constructs a
Message
with an associatedGatewayDiscordClient
and Discord data. - MESSAGE - discord4j.core.object.command.ApplicationCommand.Type
- MESSAGE_BULK_DELETE - discord4j.core.object.audit.ActionType
- MESSAGE_COMPONENT - discord4j.core.object.command.Interaction.Type
- MESSAGE_DELETE - discord4j.core.object.audit.ActionType
- MESSAGE_ID - Static variable in class discord4j.core.object.audit.OptionKey
-
Id of the message that was targeted.
- MESSAGE_PIN - discord4j.core.object.audit.ActionType
- MESSAGE_UNPIN - discord4j.core.object.audit.ActionType
- Message.Flag - Enum in discord4j.core.object.entity
-
Describes extra features of a message.
- Message.Type - Enum in discord4j.core.object.entity
-
Represents the various types of messages.
- MessageBulkDeleteEvent - Class in discord4j.core.event.domain.message
-
Dispatched when multiple messages are deleted at once.
- MessageBulkDeleteEvent(GatewayDiscordClient, ShardInfo, List<Long>, long, long, Set<Message>) - Constructor for class discord4j.core.event.domain.message.MessageBulkDeleteEvent
- MessageChannel - Interface in discord4j.core.object.entity.channel
-
A Discord channel that can utilize messages.
- MessageComponent - Class in discord4j.core.object.component
-
A Discord message component.
- MessageComponent.Type - Enum in discord4j.core.object.component
- MessageCreateEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a message is sent in a message channel.
- MessageCreateEvent(GatewayDiscordClient, ShardInfo, Message, Long, Member) - Constructor for class discord4j.core.event.domain.message.MessageCreateEvent
- MessageCreateSpec - Class in discord4j.core.spec
-
Spec used to create
Messages
toMessageChannels
. - MessageCreateSpec() - Constructor for class discord4j.core.spec.MessageCreateSpec
- MessageDeleteEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a message is deleted.
- MessageDeleteEvent(GatewayDiscordClient, ShardInfo, long, long, Long, Message) - Constructor for class discord4j.core.event.domain.message.MessageDeleteEvent
- MessageEditSpec - Class in discord4j.core.spec
-
Spec used to edit
Message
entities this client has sent before. - MessageEditSpec() - Constructor for class discord4j.core.spec.MessageEditSpec
- MessageEvent - Class in discord4j.core.event.domain.message
-
Represents an event related to a
Message
. - MessageEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.message.MessageEvent
- MessageInteraction - Class in discord4j.core.object
-
A Discord Message Interaction.
- MessageInteraction(GatewayDiscordClient, MessageInteractionData) - Constructor for class discord4j.core.object.MessageInteraction
-
Constructs a
MessageInteraction
with an associatedGatewayDiscordClient
and Discord data. - MessageInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user uses a message command (message context menu)
- MessageInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.MessageInteractionEvent
- MessageReference - Class in discord4j.core.object
-
A Message Reference used by the Server Following feature.
- MessageReference(GatewayDiscordClient, MessageReferenceData) - Constructor for class discord4j.core.object.MessageReference
-
Constructs a
MessageReference
with an associatedGatewayDiscordClient
and Discord data. - MessageReferenceSpec - Class in discord4j.core.spec
-
Spec used to create a message reference.
- MessageReferenceSpec() - Constructor for class discord4j.core.spec.MessageReferenceSpec
- MessageUpdateEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a message is updated.
- MessageUpdateEvent(GatewayDiscordClient, ShardInfo, long, long, Long, Message, boolean, String, boolean, List<Embed>) - Constructor for class discord4j.core.event.domain.message.MessageUpdateEvent
- MFA_LEVEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Two-factor auth requirement changed
- MOBILE - discord4j.core.object.presence.Status.Platform
N
- NAME - Static variable in class discord4j.core.object.audit.ChangeKey
-
Name changed
- NewsChannel - Class in discord4j.core.object.entity.channel
-
A Discord news channel.
- NewsChannel(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.NewsChannel
-
Constructs an
NewsChannel
with an associatedGatewayDiscordClient
and Discord data. - NewsChannelCreateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
NewsChannel
is created in a guild. - NewsChannelCreateEvent(GatewayDiscordClient, ShardInfo, NewsChannel) - Constructor for class discord4j.core.event.domain.channel.NewsChannelCreateEvent
- NewsChannelCreateSpec - Class in discord4j.core.spec
-
Spec used to create guild
NewsChannel
entities. - NewsChannelCreateSpec() - Constructor for class discord4j.core.spec.NewsChannelCreateSpec
- NewsChannelDeleteEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
NewsChannel
is deleted in a guild. - NewsChannelDeleteEvent(GatewayDiscordClient, ShardInfo, NewsChannel) - Constructor for class discord4j.core.event.domain.channel.NewsChannelDeleteEvent
- NewsChannelEditSpec - Class in discord4j.core.spec
-
Spec used to modify a guild
NewsChannel
settings. - NewsChannelEditSpec() - Constructor for class discord4j.core.spec.NewsChannelEditSpec
- NewsChannelUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
NewsChannel
is updated in a guild. - NewsChannelUpdateEvent(GatewayDiscordClient, ShardInfo, GuildMessageChannel, NewsChannel) - Constructor for class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
- none() - Static method in interface discord4j.core.shard.MemberRequestFilter
-
Do not request guild members.
- NONE - discord4j.core.object.entity.Guild.MfaLevel
-
Disabled 2FA requirement.
- NONE - discord4j.core.object.entity.Guild.PremiumTier
-
No Premium Tier.
- NONE - discord4j.core.object.entity.Guild.VerificationLevel
-
Unrestricted.
- noOp() - Static method in interface discord4j.core.event.dispatch.DispatchEventMapper
-
Create a
DispatchEventMapper
that doesn't process any dispatches - noopDestroyHandler() - Static method in class discord4j.core.shard.GatewayBootstrap
-
Destroy handler that doesn't perform any cleanup task.
- NOTIFICATION_LEVEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Default message notification level changed
- NSFW - Static variable in class discord4j.core.object.audit.ChangeKey
-
Channel nsfw restriction changed
- NUMBER - discord4j.core.object.command.ApplicationCommandOption.Type
O
- of(int) - Static method in enum discord4j.core.object.ApplicationTeamMember.MembershipState
-
Gets the membership state of team member.
- of(int) - Static method in enum discord4j.core.object.audit.ActionType
-
Gets the type of action.
- of(int) - Static method in enum discord4j.core.object.command.ApplicationCommand.Type
-
Gets the type of application command.
- of(int) - Static method in enum discord4j.core.object.command.ApplicationCommandOption.Type
-
Gets the type of an application command option.
- of(int) - Static method in enum discord4j.core.object.command.Interaction.Type
-
Gets the type of interaction.
- of(int) - Static method in enum discord4j.core.object.component.Button.Style
- of(int) - Static method in enum discord4j.core.object.component.MessageComponent.Type
- of(int) - Static method in enum discord4j.core.object.entity.channel.Channel.Type
-
Gets the type of channel.
- of(int) - Static method in enum discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Gets the video quality mode.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.ContentFilterLevel
-
Gets the content filter level of the guild.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.MfaLevel
-
Gets the multi-factor authentication level of the guild.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.NotificationLevel
-
Gets the notification level of the guild.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.NsfwLevel
-
Gets the NSFW level of the guild.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.PremiumTier
-
Gets the Premium Tier (aka boost level) of the Guild.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.SystemChannelFlag
-
Gets the flags of system channel.
- of(int) - Static method in enum discord4j.core.object.entity.Guild.VerificationLevel
-
Gets the verification level of the guild.
- of(int) - Static method in enum discord4j.core.object.entity.Integration.ExpireBehavior
-
Gets the integration expire behaviors.
- of(int) - Static method in enum discord4j.core.object.entity.Message.Flag
-
Gets the flags of message.
- of(int) - Static method in enum discord4j.core.object.entity.Message.Type
-
Gets the type of message.
- of(int) - Static method in enum discord4j.core.object.entity.User.Flag
-
Gets the flags of user.
- of(int) - Static method in enum discord4j.core.object.entity.Webhook.Type
-
Gets the type of webhook.
- of(int) - Static method in enum discord4j.core.object.Invite.Type
-
Gets the type of target user.
- of(int) - Static method in enum discord4j.core.object.presence.Activity.Flag
- of(int) - Static method in enum discord4j.core.object.presence.Activity.Type
-
Gets the type of activity.
- of(ActionComponent...) - Static method in class discord4j.core.object.component.ActionRow
-
Creates an
ActionRow
with the given components. - of(EmojiData) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
from aEmojiData
representation. - of(ReactionData) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
from aReactionData
representation. - of(D, GatewayDiscordClient, StateHolder, ShardInfo) - Static method in class discord4j.core.event.dispatch.DispatchContext
- of(Long, String, boolean) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
for generic emoji information. - of(String) - Static method in enum discord4j.core.object.Embed.Type
-
Gets the type of embed.
- of(String) - Static method in enum discord4j.core.object.PermissionOverwrite.Type
-
Gets the type of permission overwrite.
- of(String) - Static method in enum discord4j.core.object.presence.Status
-
Gets the type of status.
- of(String) - Static method in enum discord4j.core.object.Region.Id
-
Gets the enum associated with the value.
- of(String, SelectMenu.Option...) - Static method in class discord4j.core.object.component.SelectMenu
-
Creates a select menu.
- of(String, String) - Static method in class discord4j.core.object.component.SelectMenu.Option
-
Creates a select menu option.
- of(String, List<SelectMenu.Option>) - Static method in class discord4j.core.object.component.SelectMenu
-
Creates a select menu.
- of(List<? extends ActionComponent>) - Static method in class discord4j.core.object.component.ActionRow
-
Creates an
ActionRow
with the given components. - ofDefault(String, String) - Static method in class discord4j.core.object.component.SelectMenu.Option
-
Creates a default select menu option.
- OFFLINE - discord4j.core.object.presence.Status
- on(ReactiveEventAdapter) - Method in interface discord4j.core.event.EventDispatcher
-
Applies a given
adapter
to all events from this dispatcher. - on(ReactiveEventAdapter) - Method in class discord4j.core.GatewayDiscordClient
-
Applies a given
adapter
to all events from this dispatcher. - on(Class<E>) - Method in class discord4j.core.event.DefaultEventDispatcher
- on(Class<E>) - Method in interface discord4j.core.event.EventDispatcher
- on(Class<E>) - Method in class discord4j.core.event.ReplayingEventDispatcher
- on(Class<E>) - Method in class discord4j.core.GatewayDiscordClient
- on(Class<E>, Function<E, Publisher<T>>) - Method in interface discord4j.core.event.EventDispatcher
- on(Class<E>, Function<E, Publisher<T>>) - Method in class discord4j.core.GatewayDiscordClient
- onApplicationCommandCreate(ApplicationCommandCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an application command relevant to the current user is created.
- onApplicationCommandDelete(ApplicationCommandDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an application command relevant to the current user is deleted.
- onApplicationCommandInteraction(ApplicationCommandInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user starts an application command interaction.
- onApplicationCommandUpdate(ApplicationCommandUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an application command relevant to the current user is updated.
- onBan(BanEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user is banned from a guild.
- onButtonInteraction(ButtonInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user interacts with a button component.
- onCategoryCreate(CategoryCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild channel category is created.
- onCategoryDelete(CategoryDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild channel category is deleted.
- onCategoryUpdate(CategoryUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild channel category is updated.
- onChatInputInteraction(ChatInputInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user issues a chat input command (formerly "slash command").
- onComponentInteraction(ComponentInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user interacts with a component.
- onConnect(ConnectEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when connecting to the Gateway for the first time only.
- onDisconnect() - Method in class discord4j.core.GatewayDiscordClient
-
Return a
Mono
that signals completion when allGatewayClient
instances in this shard group have disconnected. - onDisconnect(DisconnectEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when the bot has disconnected from the Gateway.
- onEmojisUpdate(EmojisUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an emoji is added, deleted or edited in a guild.
- onGuildCreate(GuildCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when the bot receives initial information on startup, after it joins a guild, or after an outage is resolved.
- onGuildDelete(GuildDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when the bot leaves or is kicked from a guild, or if a guild has become unavailable due to an outage.
- onGuildUpdate(GuildUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild is updated.
- onIntegrationCreate(IntegrationCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an integration has been created.
- onIntegrationDelete(IntegrationDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an integration has been deleted.
- onIntegrationsUpdate(IntegrationsUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when guild integrations are updated.
- onIntegrationUpdate(IntegrationUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an integration has been updated.
- onInteractionCreate(InteractionCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user starts an interaction.
- onInviteCreate(InviteCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an invite to a channel is created.
- onInviteDelete(InviteDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when an invite to a channel has expired.
- online() - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display an online status.
- online(ActivityUpdateRequest) - Static method in class discord4j.core.object.presence.Presence
-
Create a status update to display an online status along with a custom activity.
- ONLINE - discord4j.core.object.presence.Status
- ONLY_MENTIONS - discord4j.core.object.entity.Guild.NotificationLevel
-
Receive a notification only for mentions.
- onMemberChunk(MemberChunkEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when members are streamed to the client from Discord.
- onMemberJoin(MemberJoinEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user joins a guild.
- onMemberLeave(MemberLeaveEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user leaves a guild, or is kicked from it.
- onMemberUpdate(MemberUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user's nickname or roles change in a guild.
- onMessageBulkDelete(MessageBulkDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when multiple messages are deleted at once.
- onMessageCreate(MessageCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a message is sent in a message channel.
- onMessageDelete(MessageDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a message is deleted.
- onMessageInteraction(MessageInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user issues a message command (context menu action on a message).
- onMessageUpdate(MessageUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a message is updated.
- onNewsChannelCreate(NewsChannelCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild news channel is created.
- onNewsChannelDelete(NewsChannelDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild news channel is deleted.
- onNewsChannelUpdate(NewsChannelUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild news channel is updated.
- onPinsUpdate(PinsUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a channel's pinned messages are updated.
- onPresenceUpdate(PresenceUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user's presence or status has changed.
- onPrivateChannelCreate(PrivateChannelCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Deprecated.event scheduled for removal in v3.2 after being deprecated by Discord in Gateway v8.
- onReactionAdd(ReactionAddEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a reaction is added to a message.
- onReactionRemove(ReactionRemoveEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a reaction is removed from a message.
- onReactionRemoveAll(ReactionRemoveAllEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when all of the reactions on a message are removed.
- onReactionRemoveEmoji(ReactionRemoveEmojiEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when the reactions for one emoji are removed from a message.
- onReady(ReadyEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked as Discord has established a fresh Gateway session.
- onReconnect(ReconnectEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when subsequent reconnections to the Gateway, either through resumption or full retry.
- onReconnectFail(ReconnectFailEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a resumption or reconnection attempt has failed but can be retried.
- onReconnectStart(ReconnectStartEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a resumption or reconnection attempt has begun.
- onResume(ResumeEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when the gateway connection is successfully resumed.
- onRoleCreate(RoleCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a role is created in a guild.
- onRoleDelete(RoleDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a role is deleted from a guild.
- onRoleUpdate(RoleUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when one or more role's properties are updated in a guild.
- onSelectMenuInteraction(SelectMenuInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user interacts with a select menu.
- onStoreChannelCreate(StoreChannelCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild store channel is created.
- onStoreChannelDelete(StoreChannelDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild store channel is deleted.
- onStoreChannelUpdate(StoreChannelUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild store channel is updated.
- onTextChannelCreate(TextChannelCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild text channel is created.
- onTextChannelDelete(TextChannelDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild text channel is deleted.
- onTextChannelUpdate(TextChannelUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild text channel is updated.
- onTypingStart(TypingStartEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user has started typing a message.
- onUnban(UnbanEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user is unbanned from a guild.
- onUserInteraction(UserInteractionEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user issues a user command (context menu action on a user).
- onUserUpdate(UserUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when one or more user's properties were updated.
- onVoiceChannelCreate(VoiceChannelCreateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild voice channel is created.
- onVoiceChannelDelete(VoiceChannelDeleteEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild voice channel is deleted.
- onVoiceChannelUpdate(VoiceChannelUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild voice channel is updated.
- onVoiceServerUpdate(VoiceServerUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a guild's voice server is requested or is updated.
- onVoiceStateUpdate(VoiceStateUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a user's connected voice channel and status, was requested or has updated.
- onWebhooksUpdate(WebhooksUpdateEvent) - Method in class discord4j.core.event.ReactiveEventAdapter
-
Invoked when a webhook is updated in a guild.
- OptionKey<T> - Class in discord4j.core.object.audit
- orderGuildChannels(Flux<GuildChannel>) - Static method in class discord4j.core.util.OrderUtil
-
Sorts
guild channels
according to visual ordering in Discord. - orderRoles(Flux<Role>) - Static method in class discord4j.core.util.OrderUtil
-
Sorts
roles
according to visual ordering in Discord. - OrderUtil - Class in discord4j.core.util
-
A utility class for the sorting of
roles
andguild channels
. - OrderUtil() - Constructor for class discord4j.core.util.OrderUtil
- overflowStrategy - Variable in class discord4j.core.event.DefaultEventDispatcher.Builder
- overflowStrategy(FluxSink.OverflowStrategy) - Method in class discord4j.core.event.DefaultEventDispatcher.Builder
- overflowStrategy(FluxSink.OverflowStrategy) - Method in interface discord4j.core.event.EventDispatcher.Builder
-
Set the
FluxSink.OverflowStrategy
for dealing with overflow scenarios where too many events are being published. - overflowStrategy(FluxSink.OverflowStrategy) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
- OVERWRITES - Static variable in class discord4j.core.object.audit.ChangeKey
-
Permissions on a channel changed
- OWNER - Static variable in class discord4j.core.object.audit.ChangeKey
-
Owner changed
P
- ParameterData - Class in discord4j.core.state
- ParameterData() - Constructor for class discord4j.core.state.ParameterData
- PermissionOverwrite - Class in discord4j.core.object
- PermissionOverwrite.Type - Enum in discord4j.core.object
-
The type of entity a
PermissionOverwrite
is for. - PERMISSIONS - Static variable in class discord4j.core.object.audit.ChangeKey
-
Permissions for a role changed
- PermissionUtil - Class in discord4j.core.util
- PermissionUtil() - Constructor for class discord4j.core.util.PermissionUtil
- pin() - Method in class discord4j.core.object.entity.Message
-
Requests to pin this message.
- PING - discord4j.core.object.command.Interaction.Type
- PinsUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a message is pinned or unpinned in a message channel.
- PinsUpdateEvent(GatewayDiscordClient, ShardInfo, long, Long, Instant) - Constructor for class discord4j.core.event.domain.channel.PinsUpdateEvent
- PLAY - discord4j.core.object.presence.Activity.Flag
- playing(String) - Static method in class discord4j.core.object.presence.Activity
- PLAYING - discord4j.core.object.presence.Activity.Type
-
"Playing {name}"
- PNG - discord4j.core.object.entity.Sticker.Format
-
Represents the Portable Network Graphics format.
- POSITION - Static variable in class discord4j.core.object.audit.ChangeKey
-
Text or voice channel position changed
- PREFERRED_LOCALE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Preferred locale changed
- Presence - Class in discord4j.core.object.presence
-
Presence is the current state of a user on a guild.
- Presence(PresenceData) - Constructor for class discord4j.core.object.presence.Presence
- PresenceUpdateEvent - Class in discord4j.core.event.domain
-
Dispatched when a user's presence changes.
- PresenceUpdateEvent(GatewayDiscordClient, ShardInfo, long, User, PartialUserData, Presence, Presence) - Constructor for class discord4j.core.event.domain.PresenceUpdateEvent
- primary(String, ReactionEmoji) - Static method in class discord4j.core.object.component.Button
-
Creates a
primary
button. - primary(String, ReactionEmoji, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
primary
button. - primary(String, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
primary
button. - PRIMARY - discord4j.core.object.component.Button.Style
- PrivateChannel - Class in discord4j.core.object.entity.channel
-
A Discord private channel (also known as a DM channel).
- PrivateChannel(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.PrivateChannel
-
Constructs an
PrivateChannel
with an associatedGatewayDiscordClient
and Discord data. - PrivateChannelCreateEvent - Class in discord4j.core.event.domain.channel
-
Deprecated.This event will no longer be dispatched by Discord in v8 and thus, will no longer be present in 3.2.
- PrivateChannelCreateEvent(GatewayDiscordClient, ShardInfo, PrivateChannel) - Constructor for class discord4j.core.event.domain.channel.PrivateChannelCreateEvent
-
Deprecated.
- PrivateChannelDeleteEvent - Class in discord4j.core.event.domain.channel
-
TODO what does this mean?
- PrivateChannelDeleteEvent(GatewayDiscordClient, ShardInfo, PrivateChannel) - Constructor for class discord4j.core.event.domain.channel.PrivateChannelDeleteEvent
- provideGenericStore(Class<K>, Class<V>) - Method in class discord4j.core.shard.ShardAwareStoreService
- provideLongObjStore(Class<V>) - Method in class discord4j.core.shard.ShardAwareStoreService
- prune(int) - Method in class discord4j.core.object.entity.Guild
-
Requests to prune users.
- prune(int, String) - Method in class discord4j.core.object.entity.Guild
-
Requests to prune users while optionally specifying a reason.
- prune(Consumer<? super GuildPruneSpec>) - Method in class discord4j.core.object.entity.Guild
-
Requests to prune users while customizing parameters.
- PRUNE_DAYS - Static variable in class discord4j.core.object.audit.ChangeKey
-
Change in number of days after which inactive and role-unassigned members are kicked
- PUBLIC_UPDATES_CHANNEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Od of the public updates channel changed
- publish() - Method in class discord4j.core.object.entity.Message
-
Requests to publish (crosspost) this message if the
channel
is of type 'news'. - publish(Event) - Method in class discord4j.core.event.DefaultEventDispatcher
- publish(Event) - Method in interface discord4j.core.event.EventDispatcher
-
Publishes an
Event
to the dispatcher. - publish(Event) - Method in class discord4j.core.event.ReplayingEventDispatcher
- publishConnected(ShardInfo) - Method in class discord4j.core.shard.LocalShardCoordinator
- publishConnected(ShardInfo) - Method in interface discord4j.core.shard.ShardCoordinator
-
Notifies this coordinator that a given shard has connected successfully.
- publishDisconnected(ShardInfo, SessionInfo) - Method in class discord4j.core.shard.LocalShardCoordinator
- publishDisconnected(ShardInfo, SessionInfo) - Method in interface discord4j.core.shard.ShardCoordinator
-
Notifies this coordinator that a given shard has disconnected.
- putStore(Class<V>, Store<K, V>) - Method in class discord4j.core.shard.JdkKeyStoreRegistry
- putStore(Class<V>, Store<K, V>) - Method in interface discord4j.core.shard.KeyStoreRegistry
-
Add a
Store
to the registry under its value type.
R
- RATE_LIMIT_PER_USER - Static variable in class discord4j.core.object.audit.ChangeKey
-
Amount of seconds a user has to wait before sending another message changed
- Reaction - Class in discord4j.core.object.reaction
-
A Discord message reaction.
- Reaction(GatewayDiscordClient, ReactionData) - Constructor for class discord4j.core.object.reaction.Reaction
-
Constructs a
Reaction
with an associatedGatewayDiscordClient
and Discord data. - ReactionAddEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a reaction is added to a message.
- ReactionAddEvent(GatewayDiscordClient, ShardInfo, long, long, long, Long, ReactionEmoji, Member) - Constructor for class discord4j.core.event.domain.message.ReactionAddEvent
- ReactionEmoji - Class in discord4j.core.object.reaction
-
An emoji used for
message reactions
, provides factory methods such asReactionEmoji.unicode(String)
and others to generate reactions. - ReactionEmoji() - Constructor for class discord4j.core.object.reaction.ReactionEmoji
- ReactionEmoji.Custom - Class in discord4j.core.object.reaction
- ReactionEmoji.Unicode - Class in discord4j.core.object.reaction
- ReactionRemoveAllEvent - Class in discord4j.core.event.domain.message
-
Dispatched when all of the reactions on a message are removed.
- ReactionRemoveAllEvent(GatewayDiscordClient, ShardInfo, long, long, Long) - Constructor for class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- ReactionRemoveEmojiEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a reactions of one emoji are removed on a message.
- ReactionRemoveEmojiEvent(GatewayDiscordClient, ShardInfo, long, long, Long, ReactionEmoji) - Constructor for class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- ReactionRemoveEvent - Class in discord4j.core.event.domain.message
-
Dispatched when a reaction is removed on a message.
- ReactionRemoveEvent(GatewayDiscordClient, ShardInfo, long, long, long, Long, ReactionEmoji) - Constructor for class discord4j.core.event.domain.message.ReactionRemoveEvent
- ReactiveEventAdapter - Class in discord4j.core.event
-
An adapter class to attach reactive listeners to each event type.
- ReactiveEventAdapter() - Constructor for class discord4j.core.event.ReactiveEventAdapter
- ReadyEvent - Class in discord4j.core.event.domain.lifecycle
-
Dispatched when an initial connection to the Discord gateway has been established.
- ReadyEvent(GatewayDiscordClient, ShardInfo, Ready, User, Set<ReadyEvent.Guild>) - Constructor for class discord4j.core.event.domain.lifecycle.ReadyEvent
- ReadyEvent.Guild - Class in discord4j.core.event.domain.lifecycle
-
An incomplete Guild provided by Discord upon the ready event.
- RECIPIENT_ADD - discord4j.core.object.entity.Message.Type
-
A message created when a recipient was added to a DM.
- RECIPIENT_REMOVE - discord4j.core.object.entity.Message.Type
-
A message created when a recipient left a DM.
- recommended() - Static method in interface discord4j.core.shard.ShardingStrategy
-
Sharding strategy that retrieves the recommended shard count and creates as many
GatewayClient
instances as indexes given by that count. - ReconnectEvent - Class in discord4j.core.event.domain.lifecycle
-
Indicates that a gateway connection has correctly reconnected.
- ReconnectEvent(GatewayDiscordClient, ShardInfo, long) - Constructor for class discord4j.core.event.domain.lifecycle.ReconnectEvent
- ReconnectFailEvent - Class in discord4j.core.event.domain.lifecycle
-
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
. - ReconnectFailEvent(GatewayDiscordClient, ShardInfo, long) - Constructor for class discord4j.core.event.domain.lifecycle.ReconnectFailEvent
- ReconnectStartEvent - Class in discord4j.core.event.domain.lifecycle
-
Indicates that a gateway connection is starting a reconnect attempt.
- ReconnectStartEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.lifecycle.ReconnectStartEvent
- Region - Class in discord4j.core.object
-
A Discord voice region.
- Region(GatewayDiscordClient, RegionData) - Constructor for class discord4j.core.object.Region
-
Constructs a
Region
with an associatedGatewayDiscordClient
and Discord data. - REGION - Static variable in class discord4j.core.object.audit.ChangeKey
-
Region changed
- Region.Id - Enum in discord4j.core.object
-
Represents the different non-deprecated voice region ids.
- remove(int, K) - Method in class discord4j.core.shard.JdkKeyStore
- remove(int, K) - Method in interface discord4j.core.shard.KeyStore
-
Remove the given key from a shard index.
- remove(long[], long) - Static method in class discord4j.core.util.ArrayUtil
- remove(List<T>, Predicate<T>) - Static method in class discord4j.core.util.ListUtil
- remove(T[], T) - Static method in class discord4j.core.util.ArrayUtil
- REMOVE_ROLE - discord4j.core.object.entity.Integration.ExpireBehavior
-
Remove role.
- removeAllReactions() - Method in class discord4j.core.object.entity.Message
-
Requests to remove all the reactions on this message.
- removeEmbeds() - Method in class discord4j.core.spec.MessageEditSpec
-
Removes all of the embeds on the message.
- removeReaction(ReactionEmoji, Snowflake) - Method in class discord4j.core.object.entity.Message
-
Requests to remove a reaction from a specified user on this message.
- removeReactions(ReactionEmoji) - Method in class discord4j.core.object.entity.Message
-
Requests to remove all reactions of a specific emoji on this message.
- removeRole(Snowflake) - Method in class discord4j.core.object.entity.Member
-
Requests to remove a role from this member.
- removeRole(Snowflake, String) - Method in class discord4j.core.object.entity.Member
-
Requests to remove a role from this member while optionally specifying the reason.
- removeSelfReaction(ReactionEmoji) - Method in class discord4j.core.object.entity.Message
-
Requests to remove a reaction from the current user on this message.
- replace(List<T>, T, T) - Static method in class discord4j.core.util.ListUtil
- replace(T[], T, T) - Static method in class discord4j.core.util.ArrayUtil
- replayEventFilter - Variable in class discord4j.core.event.ReplayingEventDispatcher.Builder
- replayEventFilter(Predicate<Event>) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
-
Set a filter used to determine whether an incoming
Event
should be stored for replay. - replayEventOverflowStrategy - Variable in class discord4j.core.event.ReplayingEventDispatcher.Builder
- replayEventOverflowStrategy(FluxSink.OverflowStrategy) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
-
Set an overflow strategy while pushing events to the replay processor.
- replayEventProcessor - Variable in class discord4j.core.event.ReplayingEventDispatcher.Builder
- replayEventProcessor(ReplayProcessor<Event>) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
-
Set a processor used to store events while no subscribers are connected and will be forwarded to all late subscribers.
- replaying() - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that is capable of replaying up to 2 minutes worth of important events likeGuildCreateEvent
andGatewayLifecycleEvent
that arrive while no subscribers are connected to all late subscribers, as long as they subscribe within the replay window of 5 seconds. - ReplayingEventDispatcher - Class in discord4j.core.event
-
Distributes events to active subscribers, while using a fallback storage if no subscribers are present that can be replayed to future late subscribers.
- ReplayingEventDispatcher(FluxProcessor<Event, Event>, FluxSink.OverflowStrategy, Scheduler, ReplayProcessor<Event>, FluxSink.OverflowStrategy, Predicate<Event>, Scheduler, Publisher<?>) - Constructor for class discord4j.core.event.ReplayingEventDispatcher
-
Creates a new event dispatcher that is able to retain events to replay to multiple late subscribers, using the given parameters.
- ReplayingEventDispatcher.Builder - Class in discord4j.core.event
-
A builder to create
EventDispatcher
instances. - replayingWithSize(int) - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that will replays up tohistorySize
elements to late subscribers. - replayingWithTimeout(Duration) - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that is time-bounded and retains all elements whose age is at mostmaxAge
, replaying them to late subscribers. - reply(String) - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Requests to respond to the interaction with only
content
. - reply(Consumer<? super InteractionApplicationCommandCallbackSpec>) - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Requests to respond to the interaction with a message.
- REPLY - discord4j.core.object.entity.Message.Type
-
A message created with a reply
- replyEphemeral(String) - Method in class discord4j.core.event.domain.interaction.InteractionCreateEvent
-
Requests to respond to the interaction with only
content
andephemeral set to true
. - requestMemberChunks(RequestGuildMembers) - Method in class discord4j.core.GatewayDiscordClient
-
Submit a
RequestGuildMembers
payload using the current Gateway connection and wait for its completion, delivering rawGuildMembersChunk
elements asynchronously through aFlux
. - requestMembers() - Method in class discord4j.core.object.entity.Guild
- requestMembers(Snowflake) - Method in class discord4j.core.GatewayDiscordClient
- requestMembers(Snowflake, Set<Snowflake>) - Method in class discord4j.core.GatewayDiscordClient
- requestMembers(RequestGuildMembers) - Method in class discord4j.core.GatewayDiscordClient
- requestMembers(Set<Snowflake>) - Method in class discord4j.core.object.entity.Guild
-
Return a set of
members
from this guild using the current Gateway connection. - requireCodeGrant() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets whether the app's bot will only join upon completion of the full OAuth2 code grant flow.
- requiresColons() - Method in class discord4j.core.object.entity.GuildEmoji
-
Gets whether this emoji must be wrapped in colons.
- rest() - Method in class discord4j.core.GatewayDiscordClient
-
Access the parent
DiscordClient
capable of performing direct REST API requests and REST entities. - REST - Static variable in interface discord4j.core.retriever.EntityRetrievalStrategy
-
Strategy that consists of retrieving entities from REST API.
- RestEntityRetriever - Class in discord4j.core.retriever
- RestEntityRetriever(GatewayDiscordClient) - Constructor for class discord4j.core.retriever.RestEntityRetriever
- ResumeEvent - Class in discord4j.core.event.domain.lifecycle
-
Dispatched when the gateway connection is successfully resumed.
- ResumeEvent(GatewayDiscordClient, ShardInfo, List<String>) - Constructor for class discord4j.core.event.domain.lifecycle.ResumeEvent
- RICH - discord4j.core.object.Embed.Type
-
An embed generated by rich content.
- Role - Class in discord4j.core.object.entity
-
A Discord role.
- Role(GatewayDiscordClient, RoleData, long) - Constructor for class discord4j.core.object.entity.Role
-
Constructs a
Role
with an associatedGatewayDiscordClient
and Discord data. - ROLE - discord4j.core.object.command.ApplicationCommandOption.Type
- ROLE - discord4j.core.object.PermissionOverwrite.Type
-
The
Role
entity. - ROLE_CREATE - discord4j.core.object.audit.ActionType
- ROLE_DELETE - discord4j.core.object.audit.ActionType
- ROLE_NAME - Static variable in class discord4j.core.object.audit.OptionKey
-
Name of the role if type is "role".
- ROLE_ORDER - Static variable in class discord4j.core.util.OrderUtil
-
The ordering of Discord
roles
. - ROLE_UPDATE - discord4j.core.object.audit.ActionType
- RoleCreateEvent - Class in discord4j.core.event.domain.role
-
Dispatched when a role is created in a guild.
- RoleCreateEvent(GatewayDiscordClient, ShardInfo, long, Role) - Constructor for class discord4j.core.event.domain.role.RoleCreateEvent
- RoleCreateSpec - Class in discord4j.core.spec
-
Spec used to create a new guild
Role
entity. - RoleCreateSpec() - Constructor for class discord4j.core.spec.RoleCreateSpec
- RoleDeleteEvent - Class in discord4j.core.event.domain.role
-
Dispatched when a role is deleted in a guild.
- RoleDeleteEvent(GatewayDiscordClient, ShardInfo, long, long, Role) - Constructor for class discord4j.core.event.domain.role.RoleDeleteEvent
- RoleEditSpec - Class in discord4j.core.spec
-
Spec used to modify a guild
Role
. - RoleEditSpec() - Constructor for class discord4j.core.spec.RoleEditSpec
- RoleEvent - Class in discord4j.core.event.domain.role
-
Represents an event related to a
Role
. - RoleEvent(GatewayDiscordClient, ShardInfo) - Constructor for class discord4j.core.event.domain.role.RoleEvent
- ROLES_ADD - Static variable in class discord4j.core.object.audit.ChangeKey
-
New role added
- ROLES_REMOVE - Static variable in class discord4j.core.object.audit.ChangeKey
-
Role removed
- RoleTags - Class in discord4j.core.object
- RoleTags(GatewayDiscordClient, RoleTagsData) - Constructor for class discord4j.core.object.RoleTags
- RoleUpdateEvent - Class in discord4j.core.event.domain.role
-
Dispatched when a role is updated in a guild.
- RoleUpdateEvent(GatewayDiscordClient, ShardInfo, Role, Role) - Constructor for class discord4j.core.event.domain.role.RoleUpdateEvent
- RULES_CHANNEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Id of the rules channel changed
- RUSSIA - discord4j.core.object.Region.Id
S
- SAFE - discord4j.core.object.entity.Guild.NsfwLevel
- save(K, V) - Method in class discord4j.core.shard.ShardAwareStore
- save(Publisher<Tuple2<K, V>>) - Method in class discord4j.core.shard.ShardAwareStore
- searchMembers(String, int) - Method in class discord4j.core.object.entity.Guild
-
Returns a list of
members
whose username or nickname starts with the provided username. - secondary(String, ReactionEmoji) - Static method in class discord4j.core.object.component.Button
-
Creates a
secondary
button. - secondary(String, ReactionEmoji, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
secondary
button. - secondary(String, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
secondary
button. - SECONDARY - discord4j.core.object.component.Button.Style
- SELECT_MENU - discord4j.core.object.component.MessageComponent.Type
- SelectMenu - Class in discord4j.core.object.component
-
A message select menu.
- SelectMenu.Option - Class in discord4j.core.object.component
-
An option displayed in a select menu.
- SelectMenuInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user interacts with a
SelectMenu
the bot has sent. - SelectMenuInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.SelectMenuInteractionEvent
- selfReacted() - Method in class discord4j.core.object.reaction.Reaction
-
Gets whether the current bot user reacted using this reaction's emoji.
- sendConnectVoiceState(boolean, boolean) - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Sends a join request to the gateway
- sendDisconnectVoiceState() - Method in class discord4j.core.object.entity.channel.VoiceChannel
-
Sends a leave request to the gateway
- setActionType(ActionType) - Method in class discord4j.core.spec.AuditLogQuerySpec
-
Sets the query to return entries where the action type is the same as the one provided.
- setAfkChannelId(Snowflake) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the ID of the AFK channel for the created
Guild
. - setAfkChannelId(Snowflake) - Method in class discord4j.core.spec.GuildEditSpec
- setAfkTimeout(int) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the AFK timeout, in seconds, for this
Guild
. - setAfkTimeout(Integer) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the AFK timeout, in seconds, for the created
Guild
. - setAllowedMentions(AllowedMentions) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setAllowedMentions(AllowedMentions) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets an allowed mentions object to the message spec.
- setAllowedMentions(AllowedMentions) - Method in class discord4j.core.spec.MessageEditSpec
-
Sets the new allowed mentions for the edited
Message
. - setAuthor(String, String, String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the author section of the embed.
- setAvatar(Image) - Method in class discord4j.core.spec.UserEditSpec
-
Sets the user's avatar.
- setAvatar(Image) - Method in class discord4j.core.spec.WebhookCreateSpec
-
Sets the image of the created
Webhook
. - setAvatar(Image) - Method in class discord4j.core.spec.WebhookEditSpec
-
Sets the image of the modified
Webhook
. - setAwaitConnections(boolean) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set if the connect
Mono
should defer completion until all joining shards have connected. - setBanner(Image) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the image for the guild banner (when the server has the BANNER feature).
- setBefore(Snowflake) - Method in class discord4j.core.spec.AuditLogQuerySpec
-
Sets the query to return entries before a certain entry id.
- setBitrate(int) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the bitrate for the created
VoiceChannel
. - setBitrate(int) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the bitrate for the modified
VoiceChannel
. - setChannel(Snowflake) - Method in class discord4j.core.spec.WebhookEditSpec
-
Sets the channel ID of the modified
Webhook
. - setChannelId(Snowflake) - Method in class discord4j.core.spec.MessageReferenceSpec
-
Sets the ID of the originating message's channel.
- setColor(Color) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the color of the embed.
- setColor(Color) - Method in class discord4j.core.spec.RoleCreateSpec
-
Sets the color of the created
Role
. - setColor(Color) - Method in class discord4j.core.spec.RoleEditSpec
-
Sets the new color of the
Role
. - setComponents(LayoutComponent...) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setComponents(LayoutComponent...) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets the components of the message.
- setComponents(LayoutComponent...) - Method in class discord4j.core.spec.MessageEditSpec
-
Sets the components of the message.
- setComponents(List<LayoutComponent>) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setComponents(List<LayoutComponent>) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets the components of the message.
- setComponents(List<LayoutComponent>) - Method in class discord4j.core.spec.MessageEditSpec
-
Sets the components of the message.
- setComputePruneCount(boolean) - Method in class discord4j.core.spec.GuildPruneSpec
-
Set whether the number of pruned members is returned when this actions completes.
- setContent(String) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setContent(String) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets the created
Message
contents, up to 2000 characters. - setContent(String) - Method in class discord4j.core.spec.MessageEditSpec
-
Sets the new contents for the edited
Message
. - setDays(int) - Method in class discord4j.core.spec.GuildPruneCountSpec
-
Set the number of days to count prune for.
- setDays(int) - Method in class discord4j.core.spec.GuildPruneSpec
-
Set the number of days to prune.
- setDeafen(boolean) - Method in class discord4j.core.spec.GuildMemberEditSpec
-
Sets whether the targeted
Member
is deafened in voice channels, if they are connected to voice. - setDefaultMessageNotificationLevel(Guild.NotificationLevel) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the default message notification level for the created
Guild
. - setDefaultMessageNotificationsLevel(Guild.NotificationLevel) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the default message notification level for the modified
Guild
. - setDeleteMessageDays(int) - Method in class discord4j.core.spec.BanQuerySpec
-
Sets the number of days to delete messages for (0-7).
- setDescription(String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the description of the embed.
- setDescription(String) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the description for the guild, if the guild is discoverable.
- setDescription(String) - Method in class discord4j.core.spec.GuildTemplateCreateSpec
-
Sets the description of the template.
- setDescription(String) - Method in class discord4j.core.spec.GuildTemplateEditSpec
-
Sets the description of the template.
- setDestroyHandler(Function<GatewayDiscordClient, Mono<Void>>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
handler
that generate a destroy sequence to be run once all joining shards have disconnected, after all internal resources have been released. - setDisabledIntents(IntentSet) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set the intents which should not be subscribed from the gateway for this shard.
- setDiscoverySplash(Image) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the image for the guild discovery splash (when the server has the DISCOVERABLE feature).
- setDispatchEventMapper(DispatchEventMapper) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize the
DispatchEventMapper
used to convert Gateway Dispatch intoEvent
instances. - setEmbed(Consumer<? super EmbedCreateSpec>) - Method in class discord4j.core.spec.MessageCreateSpec
-
Deprecated.
- setEmbed(Consumer<? super EmbedCreateSpec>) - Method in class discord4j.core.spec.MessageEditSpec
-
Deprecated.
- setEnabledIntents(IntentSet) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set the intents to subscribe from the gateway for this shard.
- setEntityRetrievalStrategy(EntityRetrievalStrategy) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize the
EntityRetrievalStrategy
to use by default in order to retrieve Discord entities. - setEphemeral(boolean) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setEventDispatcher(EventDispatcher) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
EventDispatcher
to receiveEvents
from all joining shards and publish them to all subscribers. - setExplicitContentFilter(Guild.ContentFilterLevel) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the explicit content filter level for the created
Guild
. - setExplicitContentFilter(Guild.ContentFilterLevel) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the explicit content filter level for the modified
Guild
. - setExtraOptions(Function<? super O, O2>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Add a configuration for
GatewayClient
implementation-specific cases, changing the type of the currentGatewayOptions
object passed to theGatewayClient
factory in connect methods. - setFailIfNotExists(boolean) - Method in class discord4j.core.spec.MessageReferenceSpec
-
Sets to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message, default true.
- setFeatures(Set<String>) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the enabled guild features.
- setFlags(Message.Flag...) - Method in class discord4j.core.spec.MessageEditSpec
-
Sets the flags for the edited
Message
. - setFooter(String, String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the footer of the embed.
- setGatewayObserver(GatewayObserver) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
GatewayObserver
to be notified of Gateway lifecycle events across all joining shards. - setGatewayReactorResources(Function<ReactorResources, GatewayReactorResources>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize the
ReactorResources
used exclusively for Gateway-related operations, such as maintaining the websocket connections and scheduling Gateway tasks. - setGuildId(Snowflake) - Method in class discord4j.core.spec.MessageReferenceSpec
-
Sets the ID of the originating message's guild.
- setGuildSubscriptions(boolean) - Method in class discord4j.core.shard.GatewayBootstrap
-
Deprecated.for removal in 3.2.0, migrate to Gateway Intents feature
- setHoist(boolean) - Method in class discord4j.core.spec.RoleCreateSpec
-
Sets whether the created
Role
should be displayed separately in the sidebar. - setHoist(boolean) - Method in class discord4j.core.spec.RoleEditSpec
-
Sets whether the modified
Role
should be displayed separately in the sidebar. - setIcon(Image) - Method in class discord4j.core.spec.GuildCreateFromTemplateSpec
-
Sets the icon for the created guild.
- setIcon(Image) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the image icon to display for the created
Guild
. - setIcon(Image) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the image icon to display for the modified
Guild
. - setImage(Image) - Method in class discord4j.core.spec.GuildEmojiCreateSpec
-
Sets the image for the created
GuildEmoji
. - setImage(String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the image of the embed.
- setInitialPresence(Function<ShardInfo, StatusUpdate>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a
Function
to determine theStatusUpdate
that each joining shard should use when identifying to the Gateway. - setInitialStatus(Function<ShardInfo, StatusUpdate>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Deprecated.
- setInvalidationStrategy(InvalidationStrategy) - Method in class discord4j.core.shard.GatewayBootstrap
-
Deprecated.to be removed and superseded by new Store abstraction under v3.2
- setIpDiscoveryRetrySpec(RetrySpec) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Set the retry policy to apply when performing IP discovery.
- setIpDiscoveryTimeout(Duration) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Set the maximum amount of time to wait for a single attempt at performing the IP discovery procedure.
- setLimit(int) - Method in class discord4j.core.spec.AuditLogQuerySpec
-
Sets the query to return a max of entries.
- setMaxAge(int) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets the duration of the created
Invite
in seconds before expiration, or0
to never expire. - setMaxMissedHeartbeatAck(int) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set the maximum number of missed heartbeat acknowledge payloads each connection to Gateway will allow before triggering an automatic reconnect.
- setMaxUses(int) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets the maximum number of uses the created
Invite
has before expiring, or0
for unlimited uses. - setMemberRequestFilter(MemberRequestFilter) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a
MemberRequestFilter
to determine how this shard group should request guild members. - setMemberRequestTimeout(Duration) - Method in class discord4j.core.shard.GatewayBootstrap
-
Deprecated.for removal in v3.2, as Gateway Intents become mandatory there is no need to apply a forced timeout on a request as invalid ones will be rejected upon subscription.
- setMentionable(boolean) - Method in class discord4j.core.spec.RoleCreateSpec
-
Sets whether the created
Role
should be mentionable. - setMentionable(boolean) - Method in class discord4j.core.spec.RoleEditSpec
-
Sets whether the modified
Role
should be mentionable. - setMessageId(Snowflake) - Method in class discord4j.core.spec.MessageReferenceSpec
-
Sets the ID of the originating message.
- setMessageReference(Snowflake) - Method in class discord4j.core.spec.MessageCreateSpec
-
Adds a message ID to reply to.
- setMute(boolean) - Method in class discord4j.core.spec.GuildMemberEditSpec
-
Sets whether the targeted
Member
is muted in voice channels, if they are connected to voice. - setName(String) - Method in class discord4j.core.spec.CategoryCreateSpec
-
Sets the name for the created
Category
. - setName(String) - Method in class discord4j.core.spec.CategoryEditSpec
-
Sets the name for the
Category
. - setName(String) - Method in class discord4j.core.spec.GuildCreateFromTemplateSpec
-
Sets the name for the created guild.
- setName(String) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the name for the created
Guild
. - setName(String) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the modified
Guild
name. - setName(String) - Method in class discord4j.core.spec.GuildEmojiCreateSpec
-
Sets the name for the created
GuildEmoji
. - setName(String) - Method in class discord4j.core.spec.GuildEmojiEditSpec
-
Sets the name for the modified
GuildEmoji
. - setName(String) - Method in class discord4j.core.spec.GuildTemplateCreateSpec
-
Sets the name of the template.
- setName(String) - Method in class discord4j.core.spec.GuildTemplateEditSpec
-
Sets the name of the template.
- setName(String) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets the name of the created
NewsChannel
. - setName(String) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets the name of the modified
NewsChannel
. - setName(String) - Method in class discord4j.core.spec.RoleCreateSpec
-
Sets the name of the created
Role
. - setName(String) - Method in class discord4j.core.spec.RoleEditSpec
-
Sets the new name of the
Role
. - setName(String) - Method in class discord4j.core.spec.StoreChannelEditSpec
-
Sets the name for the
StoreChannel
. - setName(String) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the name of the created
TextChannel
. - setName(String) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the name of the modified
TextChannel
. - setName(String) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the name for the created
VoiceChannel
. - setName(String) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the name for the modified
VoiceChannel
. - setName(String) - Method in class discord4j.core.spec.WebhookCreateSpec
-
Sets the name of the created
Webhook
. - setName(String) - Method in class discord4j.core.spec.WebhookEditSpec
-
Sets the name of the modified
Webhook
. - setNewVoiceChannel(Snowflake) - Method in class discord4j.core.spec.GuildMemberEditSpec
-
Sets the new voice channel to move the targeted
Member
, if they are connected to voice. - setNickname(String) - Method in class discord4j.core.spec.GuildMemberEditSpec
-
Sets a new nickname to the targeted
Member
. - setNonce(Snowflake) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets a nonce that can be used for optimistic message sending.
- setNsfw(boolean) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets whether the created
NewsChannel
is NSFW (not safe for work). - setNsfw(boolean) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets whether the modified
NewsChannel
should be NSFW (not safe for work). - setNsfw(boolean) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets whether the created
TextChannel
is NSFW (not safe for work). - setNsfw(boolean) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets whether the modified
TextChannel
should be NSFW (not safe for work). - setOwnerId(Snowflake) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the new owner ID for this
Guild
. - setParentId(Snowflake) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets the identifier of the parent category of the created
NewsChannel
. - setParentId(Snowflake) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets the identifier of the parent category of the modified
NewsChannel
. - setParentId(Snowflake) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the identifier of the parent category of the created
TextChannel
. - setParentId(Snowflake) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the identifier of the parent category of the modified
TextChannel
. - setParentId(Snowflake) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the parent ID for the created
VoiceChannel
. - setParentId(Snowflake) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the parent ID for the modified
VoiceChannel
. - setPayloadReader(PayloadReader) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize how inbound Gateway payloads are decoded from
ByteBuf
. - setPayloadWriter(PayloadWriter) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize how outbound Gateway payloads are encoded into
ByteBuf
. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.CategoryCreateSpec
-
Sets the permission overwrites for the created
Category
. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.CategoryEditSpec
-
Sets the permission overwrites for the
Category
. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets the created
NewsChannel
permission overwrites. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets the modified
NewsChannel
permission overwrites. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.StoreChannelEditSpec
-
Sets the permission overwrites for the
StoreChannel
. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the created
TextChannel
permission overwrites. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the modified
TextChannel
permission overwrites. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the permission overwrites for the created
VoiceChannel
. - setPermissionOverwrites(Set<? extends PermissionOverwrite>) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the permission overwrites for the modified
VoiceChannel
. - setPermissions(PermissionSet) - Method in class discord4j.core.spec.RoleCreateSpec
-
Sets the enabled/disabled permissions, in the form of a
PermissionSet
for the createdRole
. - setPermissions(PermissionSet) - Method in class discord4j.core.spec.RoleEditSpec
-
Sets the new permissions for the
Role
. - setPosition(int) - Method in class discord4j.core.spec.CategoryCreateSpec
-
Sets the position for the created
Category
. - setPosition(int) - Method in class discord4j.core.spec.CategoryEditSpec
-
Sets the position for the
Category
. - setPosition(int) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets the sorting position of the created
NewsChannel
. - setPosition(int) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets the position of the modified
NewsChannel
. - setPosition(int) - Method in class discord4j.core.spec.StoreChannelEditSpec
-
Sets the position for the
StoreChannel
. - setPosition(int) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the sorting position of the created
TextChannel
. - setPosition(int) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the position of the modified
TextChannel
. - setPosition(int) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the position for the created
VoiceChannel
. - setPosition(int) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the position for the modified
VoiceChannel
. - setPreferredLocale(Locale) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US".
- setProvider(AudioProvider) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Configure the
AudioProvider
to use in the createdVoiceConnection
. - setPublicUpdatesChannelId(Snowflake) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the id of the channel where admins and moderators of Community guilds receive notices from Discord.
- setRateLimitPerUser(int) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the amount of seconds a user has to wait before sending another message to the created
TextChannel
, from 0 to 120. - setRateLimitPerUser(int) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the amount of seconds a user has to wait before sending another message to the modified
TextChannel
, from 0 to 21600 seconds. - setReason(String) - Method in interface discord4j.core.spec.AuditSpec
-
Sets the reason to show in the audit logs when the spec is built.
- setReason(String) - Method in class discord4j.core.spec.BanQuerySpec
- setReason(String) - Method in class discord4j.core.spec.CategoryCreateSpec
- setReason(String) - Method in class discord4j.core.spec.CategoryEditSpec
- setReason(String) - Method in class discord4j.core.spec.GuildEditSpec
- setReason(String) - Method in class discord4j.core.spec.GuildEmojiCreateSpec
- setReason(String) - Method in class discord4j.core.spec.GuildEmojiEditSpec
- setReason(String) - Method in class discord4j.core.spec.GuildMemberEditSpec
- setReason(String) - Method in class discord4j.core.spec.GuildPruneSpec
- setReason(String) - Method in class discord4j.core.spec.InviteCreateSpec
- setReason(String) - Method in class discord4j.core.spec.NewsChannelCreateSpec
- setReason(String) - Method in class discord4j.core.spec.NewsChannelEditSpec
- setReason(String) - Method in class discord4j.core.spec.RoleCreateSpec
- setReason(String) - Method in class discord4j.core.spec.RoleEditSpec
- setReason(String) - Method in class discord4j.core.spec.StoreChannelEditSpec
- setReason(String) - Method in class discord4j.core.spec.TextChannelCreateSpec
- setReason(String) - Method in class discord4j.core.spec.TextChannelEditSpec
- setReason(String) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
- setReason(String) - Method in class discord4j.core.spec.VoiceChannelEditSpec
- setReason(String) - Method in class discord4j.core.spec.WebhookCreateSpec
- setReason(String) - Method in class discord4j.core.spec.WebhookEditSpec
- setReceiver(AudioReceiver) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Deprecated.Discord does not officially support bots receiving audio. It is not guaranteed that this functionality works properly. Use at your own risk.
- setReceiveTaskFactory(VoiceReceiveTaskFactory) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Deprecated.Discord does not officially support bots receiving audio. It is not guaranteed that this functionality works properly. Use at your own risk.
- setReconnectOptions(ReconnectOptions) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
ReconnectOptions
to configure how Gateway connections will attempt to reconnect every time a websocket session is closed unexpectedly. - setRegion(Region.Id) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the voice region id for the created
Guild
. - setRegion(Region.Id) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the voice region for the modified
Guild
. - setRegion(String) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the voice region id for the created
Guild
, automatic if null. - setRegion(String) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the voice region for the modified
Guild
, automatic if null. - setResponsibleUser(Snowflake) - Method in class discord4j.core.spec.AuditLogQuerySpec
-
Sets the query to only return entries where the user specified is responsible for the action.
- setResumeOptions(Function<ShardInfo, SessionInfo>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a
Function
to determine the details to resume a session that each joining shard should use when identifying for the first time to the Gateway. - setRoles(Set<Snowflake>) - Method in class discord4j.core.spec.GuildEmojiEditSpec
-
Sets the list of roles for which the modified
GuildEmoji
will be whitelisted. - setRoles(Set<Snowflake>) - Method in class discord4j.core.spec.GuildMemberEditSpec
-
Sets the new role identifiers the targeted
Member
is assigned. - setRtcRegion(String) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the channel voice region id, automatic if null.
- setRulesChannelId(Snowflake) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the id of the channel where Community guilds display rules and/or guidelines.
- setSelfDeaf(boolean) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Set whether to deafen this client when establishing a
VoiceConnection
. - setSelfMute(boolean) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Set whether to mute this client when establishing a
VoiceConnection
. - setSendTaskFactory(VoiceSendTaskFactory) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Configure the
VoiceSendTaskFactory
to use in the createdVoiceConnection
. - setShardCoordinator(ShardCoordinator) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
ShardCoordinator
to manage multipleGatewayDiscordClient
instances, even across boundaries. - setSharding(ShardingStrategy) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set the sharding method to use while building a
GatewayDiscordClient
. - setSplash(Image) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the image for the guild splash (when the server has the INVITE_SPLASH feature).
- setStoreService(StoreService) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
StoreService
, an abstract factory to createStore
instances, to cache Gateway updates. - setSystemChannelFlags(Guild.SystemChannelFlag) - Method in class discord4j.core.spec.GuildEditSpec
-
Deprecated.
- setSystemChannelFlags(Guild.SystemChannelFlag...) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the system channel flags for the created
Guild
. - setSystemChannelFlags(Guild.SystemChannelFlag...) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the system channel flags.
- setSystemChannelId(Snowflake) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the id of the channel where guild notices such as welcome messages and boost events are posted for the created
Guild
. - setSystemChannelId(Snowflake) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the id of the channel where guild notices such as welcome messages and boost events are posted.
- setTargetApplicationId(Snowflake) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag.
- setTargetType(Invite.Type) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets the type of target for this voice channel invite.
- setTargetUserId(Snowflake) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets the id of the user whose stream to display for this invite, required if `target_type` is 1, the user must be streaming in the channel.
- setTemporary(boolean) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets whether the created
Invite
only grants temporary membership. - setThumbnail(String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the thumbnail of the embed.
- setTimeout(Duration) - Method in class discord4j.core.spec.VoiceChannelJoinSpec
-
Set the maximum amount of time to wait before the connection to the voice channel timeouts.
- setTimestamp(Instant) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the timestamp to display in the embed.
- setTitle(String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the title of the embed.
- setTopic(String) - Method in class discord4j.core.spec.NewsChannelCreateSpec
-
Sets the created
NewsChannel
topic. - setTopic(String) - Method in class discord4j.core.spec.NewsChannelEditSpec
-
Sets the topic of the modified
NewsChannel
. - setTopic(String) - Method in class discord4j.core.spec.TextChannelCreateSpec
-
Sets the created
TextChannel
topic. - setTopic(String) - Method in class discord4j.core.spec.TextChannelEditSpec
-
Sets the topic of the modified
TextChannel
. - setTts(boolean) - Method in class discord4j.core.spec.InteractionApplicationCommandCallbackSpec
- setTts(boolean) - Method in class discord4j.core.spec.MessageCreateSpec
-
Sets whether the created
Message
is a TTS message. - setUnique(boolean) - Method in class discord4j.core.spec.InviteCreateSpec
-
Sets whether the created
Invite
is unique. - setUrl(String) - Method in class discord4j.core.spec.EmbedCreateSpec
-
Sets the URL of the embed.
- setUserLimit(int) - Method in class discord4j.core.spec.VoiceChannelCreateSpec
-
Sets the user limit for the created
VoiceChannel
. - setUserLimit(int) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the user limit for the modified
VoiceChannel
. - setUsername(String) - Method in class discord4j.core.spec.UserEditSpec
-
Sets the user's username.
- setValue(Object) - Method in class discord4j.core.state.ParameterData
- setVerificationLevel(Guild.VerificationLevel) - Method in class discord4j.core.spec.GuildCreateSpec
-
Sets the verification level required before a member can send messages in the created
Guild
. - setVerificationLevel(Guild.VerificationLevel) - Method in class discord4j.core.spec.GuildEditSpec
-
Sets the verification level required before a member can send messages in the modified
Guild
. - setVideoQualityMode(VoiceChannel.Mode) - Method in class discord4j.core.spec.VoiceChannelEditSpec
-
Sets the camera video quality mode of the voice channel.
- setVoiceConnectionFactory(VoiceConnectionFactory) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize the
VoiceConnectionFactory
used to establish and maintainVoiceConnection
instances to perform voice-related operations. - setVoiceReactorResources(Function<ReactorResources, VoiceReactorResources>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Customize the
ReactorResources
used exclusively for voice-related operations, such as maintaining the Voice Gateway websocket connections, Voice UDP socket connections and scheduling Gateway tasks. - setVoiceReconnectOptions(ReconnectOptions) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set a custom
ReconnectOptions
to configure how Voice Gateway connections will attempt to reconnect every time a websocket session is closed unexpectedly. - ShardAwareStore<K extends Comparable<K>,V> - Class in discord4j.core.shard
-
A custom and generic
Store
implementation that keeps track of the shard particular entities are cached, in order to allow orderly cleanup if a specific shard needs to invalidate their cache. - ShardAwareStore(Store<K, V>, KeyStore<K>) - Constructor for class discord4j.core.shard.ShardAwareStore
- ShardAwareStoreService - Class in discord4j.core.shard
-
Factory that delegates the creation of the store to a backing factory and then wraps it into a
ShardAwareStore
. - ShardAwareStoreService(KeyStoreRegistry, StoreService) - Constructor for class discord4j.core.shard.ShardAwareStoreService
- ShardCoordinator - Interface in discord4j.core.shard
-
A
ShardCoordinator
defines key operations to leverage shard coordination across boundaries. - ShardingStrategy - Interface in discord4j.core.shard
-
Strategy to build sharding
GatewayClient
instances. - shutdown() - Method in class discord4j.core.event.DefaultEventDispatcher
- shutdown() - Method in interface discord4j.core.event.EventDispatcher
-
Signal that this event dispatcher must terminate and release its resources.
- shutdown() - Method in class discord4j.core.event.ReplayingEventDispatcher
- shutdownDestroyHandler() - Static method in class discord4j.core.shard.GatewayBootstrap
-
Destroy handler that calls
EventDispatcher.shutdown()
followed byStoreService.dispose()
asynchronously. - SINGAPORE - discord4j.core.object.Region.Id
- single() - Static method in interface discord4j.core.shard.ShardingStrategy
-
Sharding strategy that creates a single
GatewayClient
. - SOURCE_MESSAGE_DELETED - discord4j.core.object.entity.Message.Flag
-
The source message for this crosspost has been deleted (via Channel Following).
- SOUTHAFRICA - discord4j.core.object.Region.Id
- Spec<T> - Interface in discord4j.core.spec
-
A contract specifying how an object should be built.
- SPECTATE - discord4j.core.object.presence.Activity.Flag
- SPLASH - Static variable in class discord4j.core.object.audit.ChangeKey
-
Invite splash page artwork changed
- SPOILER_PREFIX - Static variable in class discord4j.core.object.entity.Attachment
-
The prefix of the name of files which are displayed as spoilers.
- StateHolder - Class in discord4j.core.state
-
Holder for various pieces of state for use in caching.
- StateHolder(StoreService, StoreContext, Possible<IntentSet>) - Constructor for class discord4j.core.state.StateHolder
- StateView - Class in discord4j.core.state
-
Read-only view for various pieces of state for use in caching.
- StateView(StateHolder) - Constructor for class discord4j.core.state.StateView
- Status - Enum in discord4j.core.object.presence
-
Represents the various type of status.
- Status.Platform - Enum in discord4j.core.object.presence
- Sticker - Class in discord4j.core.object.entity
- Sticker(GatewayDiscordClient, StickerData) - Constructor for class discord4j.core.object.entity.Sticker
- Sticker.Format - Enum in discord4j.core.object.entity
-
The format of a sticker.
- stopReplayingTrigger - Variable in class discord4j.core.event.ReplayingEventDispatcher.Builder
- stopReplayingTrigger(Publisher<?>) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
-
Set a trigger
Publisher
that is subscribed upon the first subscriber connects to this dispatcher. - STORE - Static variable in interface discord4j.core.retriever.EntityRetrievalStrategy
-
Strategy that consists of retrieving entities from the Gateway state cache.
- STORE_FALLBACK_REST - Static variable in interface discord4j.core.retriever.EntityRetrievalStrategy
-
Strategy that consists of retrieving entities from stores first, then hit the REST API if not found.
- StoreChannel - Class in discord4j.core.object.entity.channel
-
A Discord store channel.
- StoreChannel(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.StoreChannel
-
Constructs an
StoreChannel
with an associatedGatewayDiscordClient
and Discord data. - StoreChannelCreateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
StoreChannel
is created in a guild. - StoreChannelCreateEvent(GatewayDiscordClient, ShardInfo, StoreChannel) - Constructor for class discord4j.core.event.domain.channel.StoreChannelCreateEvent
- StoreChannelDeleteEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
StoreChannel
is deleted in a guild. - StoreChannelDeleteEvent(GatewayDiscordClient, ShardInfo, StoreChannel) - Constructor for class discord4j.core.event.domain.channel.StoreChannelDeleteEvent
- StoreChannelEditSpec - Class in discord4j.core.spec
-
Spec used to modify a guild
StoreChannel
settings. - StoreChannelEditSpec() - Constructor for class discord4j.core.spec.StoreChannelEditSpec
- StoreChannelUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
StoreChannel
is updated in a guild. - StoreChannelUpdateEvent(GatewayDiscordClient, ShardInfo, StoreChannel, StoreChannel) - Constructor for class discord4j.core.event.domain.channel.StoreChannelUpdateEvent
- StoreEntityRetriever - Class in discord4j.core.retriever
- StoreEntityRetriever(GatewayDiscordClient) - Constructor for class discord4j.core.retriever.StoreEntityRetriever
- STREAM - discord4j.core.object.Invite.Type
-
Stream.
- streaming(String, String) - Static method in class discord4j.core.object.presence.Activity
- STREAMING - discord4j.core.object.presence.Activity.Type
-
"Streaming {details}"
- STRING - discord4j.core.object.command.ApplicationCommandOption.Type
- SUB_COMMAND - discord4j.core.object.command.ApplicationCommandOption.Type
- SUB_COMMAND_GROUP - discord4j.core.object.command.ApplicationCommandOption.Type
- success(String, ReactionEmoji) - Static method in class discord4j.core.object.component.Button
-
Creates a
success
button. - success(String, ReactionEmoji, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
success
button. - success(String, String) - Static method in class discord4j.core.object.component.Button
-
Creates a
success
button. - SUCCESS - discord4j.core.object.component.Button.Style
- SUPPRESS_EMBEDS - discord4j.core.object.entity.Message.Flag
-
Do not include any embeds when serializing this message.
- SUPPRESS_GUILD_REMINDER_NOTIFICATIONS - discord4j.core.object.entity.Guild.SystemChannelFlag
-
Suppress server setup tips
- SUPPRESS_JOIN_NOTIFICATIONS - discord4j.core.object.entity.Guild.SystemChannelFlag
-
Member join notifications are suppressed.
- SUPPRESS_PREMIUM_SUBSCRIPTIONS - discord4j.core.object.entity.Guild.SystemChannelFlag
-
Server boost notifications are suppressed.
- suppressEmbeds(boolean) - Method in class discord4j.core.object.entity.Message
-
Requests to suppress all embeds in this message.
- SYDNEY - discord4j.core.object.Region.Id
- sync() - Method in class discord4j.core.object.GuildTemplate
-
Requests to sync this template with the guild's current state.
- SYNC - discord4j.core.object.presence.Activity.Flag
- SYSTEM - discord4j.core.object.entity.User.Flag
- SYSTEM_CHANNEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Id of the system channel changed
T
- TEAM_USER - discord4j.core.object.entity.User.Flag
- TextChannel - Class in discord4j.core.object.entity.channel
-
A Discord text channel.
- TextChannel(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.TextChannel
-
Constructs an
TextChannel
with an associatedGatewayDiscordClient
and Discord data. - TextChannelCreateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
TextChannel
is created in a guild. - TextChannelCreateEvent(GatewayDiscordClient, ShardInfo, TextChannel) - Constructor for class discord4j.core.event.domain.channel.TextChannelCreateEvent
- TextChannelCreateSpec - Class in discord4j.core.spec
-
Spec used to create guild
TextChannel
entities. - TextChannelCreateSpec() - Constructor for class discord4j.core.spec.TextChannelCreateSpec
- TextChannelDeleteEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
TextChannel
is deleted in a guild. - TextChannelDeleteEvent(GatewayDiscordClient, ShardInfo, TextChannel) - Constructor for class discord4j.core.event.domain.channel.TextChannelDeleteEvent
- TextChannelEditSpec - Class in discord4j.core.spec
-
Spec used to modify a guild
TextChannel
settings. - TextChannelEditSpec() - Constructor for class discord4j.core.spec.TextChannelEditSpec
- TextChannelUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
TextChannel
is updated in a guild. - TextChannelUpdateEvent(GatewayDiscordClient, ShardInfo, GuildMessageChannel, TextChannel) - Constructor for class discord4j.core.event.domain.channel.TextChannelUpdateEvent
- throwUnsupportedDiscordValue(Object) - Static method in class discord4j.core.util.EntityUtil
-
Throws an
UnsupportedOperationException
for an unknown Discord value. - TIER_1 - discord4j.core.object.entity.Guild.PremiumTier
-
Premium Tier 1 (Boost Level 1).
- TIER_2 - discord4j.core.object.entity.Guild.PremiumTier
-
Premium Tier 2 (Boost Level 2).
- TIER_3 - discord4j.core.object.entity.Guild.PremiumTier
-
Premium Tier 3 (Boost Level 3).
- timedTaskScheduler - Variable in class discord4j.core.event.ReplayingEventDispatcher.Builder
- timedTaskScheduler(Scheduler) - Method in class discord4j.core.event.ReplayingEventDispatcher.Builder
-
Set a time-capable
Scheduler
used to detect whether all events have replayed to a subscriber. - toObject(long[]) - Static method in class discord4j.core.util.ArrayUtil
- TOPIC - Static variable in class discord4j.core.object.audit.ChangeKey
-
Text channel topic changed
- toString() - Method in class discord4j.core.event.domain.channel.CategoryCreateEvent
- toString() - Method in class discord4j.core.event.domain.channel.CategoryDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.CategoryUpdateEvent
- toString() - Method in class discord4j.core.event.domain.channel.NewsChannelCreateEvent
- toString() - Method in class discord4j.core.event.domain.channel.NewsChannelDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.NewsChannelUpdateEvent
- toString() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
- toString() - Method in class discord4j.core.event.domain.channel.PrivateChannelCreateEvent
-
Deprecated.
- toString() - Method in class discord4j.core.event.domain.channel.PrivateChannelDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.StoreChannelCreateEvent
- toString() - Method in class discord4j.core.event.domain.channel.StoreChannelDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.StoreChannelUpdateEvent
- toString() - Method in class discord4j.core.event.domain.channel.TextChannelCreateEvent
- toString() - Method in class discord4j.core.event.domain.channel.TextChannelDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.TextChannelUpdateEvent
- toString() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
- toString() - Method in class discord4j.core.event.domain.channel.VoiceChannelCreateEvent
- toString() - Method in class discord4j.core.event.domain.channel.VoiceChannelDeleteEvent
- toString() - Method in class discord4j.core.event.domain.channel.VoiceChannelUpdateEvent
- toString() - Method in class discord4j.core.event.domain.guild.BanEvent
- toString() - Method in class discord4j.core.event.domain.guild.EmojisUpdateEvent
- toString() - Method in class discord4j.core.event.domain.guild.GuildCreateEvent
- toString() - Method in class discord4j.core.event.domain.guild.GuildDeleteEvent
- toString() - Method in class discord4j.core.event.domain.guild.GuildUpdateEvent
- toString() - Method in class discord4j.core.event.domain.guild.IntegrationsUpdateEvent
- toString() - Method in class discord4j.core.event.domain.guild.MemberChunkEvent
- toString() - Method in class discord4j.core.event.domain.guild.MemberJoinEvent
- toString() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
- toString() - Method in class discord4j.core.event.domain.guild.MemberUpdateEvent
- toString() - Method in class discord4j.core.event.domain.guild.UnbanEvent
- toString() - Method in class discord4j.core.event.domain.InviteCreateEvent
- toString() - Method in class discord4j.core.event.domain.InviteDeleteEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ConnectEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.DisconnectEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
- toString() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ReconnectEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ReconnectFailEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ReconnectStartEvent
- toString() - Method in class discord4j.core.event.domain.lifecycle.ResumeEvent
- toString() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
- toString() - Method in class discord4j.core.event.domain.message.MessageCreateEvent
- toString() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
- toString() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
- toString() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
- toString() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
- toString() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
- toString() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
- toString() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
- toString() - Method in class discord4j.core.event.domain.role.RoleCreateEvent
- toString() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
- toString() - Method in class discord4j.core.event.domain.role.RoleUpdateEvent
- toString() - Method in class discord4j.core.event.domain.UserUpdateEvent
- toString() - Method in class discord4j.core.event.domain.VoiceServerUpdateEvent
- toString() - Method in class discord4j.core.event.domain.VoiceStateUpdateEvent
- toString() - Method in class discord4j.core.event.domain.WebhooksUpdateEvent
- toString() - Method in class discord4j.core.object.ApplicationTeamMember
- toString() - Method in class discord4j.core.object.audit.AuditLogChange
- toString() - Method in class discord4j.core.object.audit.AuditLogEntry
- toString() - Method in class discord4j.core.object.audit.ChangeKey
- toString() - Method in class discord4j.core.object.audit.OptionKey
- toString() - Method in class discord4j.core.object.Ban
- toString() - Method in class discord4j.core.object.Embed
- toString() - Method in class discord4j.core.object.entity.ApplicationInfo
- toString() - Method in class discord4j.core.object.entity.ApplicationTeam
- toString() - Method in class discord4j.core.object.entity.Attachment
- toString() - Method in class discord4j.core.object.entity.channel.Category
- toString() - Method in class discord4j.core.object.entity.channel.NewsChannel
- toString() - Method in class discord4j.core.object.entity.channel.PrivateChannel
- toString() - Method in class discord4j.core.object.entity.channel.StoreChannel
- toString() - Method in class discord4j.core.object.entity.channel.TextChannel
- toString() - Method in class discord4j.core.object.entity.channel.VoiceChannel
- toString() - Method in class discord4j.core.object.entity.Guild
- toString() - Method in class discord4j.core.object.entity.GuildEmoji
- toString() - Method in class discord4j.core.object.entity.Integration
- toString() - Method in class discord4j.core.object.entity.Member
- toString() - Method in class discord4j.core.object.entity.Message
- toString() - Method in class discord4j.core.object.entity.Role
- toString() - Method in class discord4j.core.object.entity.User
- toString() - Method in class discord4j.core.object.entity.Webhook
- toString() - Method in class discord4j.core.object.ExtendedInvite
- toString() - Method in class discord4j.core.object.Invite
- toString() - Method in class discord4j.core.object.MessageReference
- toString() - Method in class discord4j.core.object.PermissionOverwrite
- toString() - Method in class discord4j.core.object.presence.Activity
- toString() - Method in class discord4j.core.object.presence.Presence
- toString() - Method in class discord4j.core.object.reaction.Reaction
- toString() - Method in class discord4j.core.object.reaction.ReactionEmoji.Custom
- toString() - Method in class discord4j.core.object.reaction.ReactionEmoji.Unicode
- toString() - Method in class discord4j.core.object.Region
- toString() - Method in class discord4j.core.object.RoleTags
- toString() - Method in class discord4j.core.object.VoiceState
- toString() - Method in class discord4j.core.shard.ShardAwareStore
- type() - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to trigger the typing indicator in this channel.
- TYPE - Static variable in class discord4j.core.object.audit.OptionKey
-
Type of overwritten entity ("member" or "role").
- typeUntil(Publisher<?>) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to trigger the typing indicator in this channel.
- TypingStartEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a user starts typing in a message channel.
- TypingStartEvent(GatewayDiscordClient, ShardInfo, long, Long, long, Instant, Member) - Constructor for class discord4j.core.event.domain.channel.TypingStartEvent
U
- unban() - Method in class discord4j.core.object.entity.Member
-
Requests to unban this user.
- unban(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to unban the specified user.
- unban(Snowflake, String) - Method in class discord4j.core.object.entity.Guild
-
Requests to unban the specified user while optionally specifying a reason.
- unban(String) - Method in class discord4j.core.object.entity.Member
-
Requests to unban this user while optionally specifying the reason.
- UnbanEvent - Class in discord4j.core.event.domain.guild
-
Dispatched when a user is unbanned from a guild.
- UnbanEvent(GatewayDiscordClient, ShardInfo, User, long) - Constructor for class discord4j.core.event.domain.guild.UnbanEvent
- unicode(String) - Static method in class discord4j.core.object.reaction.ReactionEmoji
-
Constructs a
ReactionEmoji
for a unicode emoji. - UNKNOWN - discord4j.core.object.ApplicationTeamMember.MembershipState
- UNKNOWN - discord4j.core.object.audit.ActionType
- UNKNOWN - discord4j.core.object.command.ApplicationCommand.Type
- UNKNOWN - discord4j.core.object.command.ApplicationCommandOption.Type
- UNKNOWN - discord4j.core.object.command.Interaction.Type
- UNKNOWN - discord4j.core.object.component.Button.Style
- UNKNOWN - discord4j.core.object.component.MessageComponent.Type
- UNKNOWN - discord4j.core.object.Embed.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.entity.channel.Channel.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Unknown type.
- UNKNOWN - discord4j.core.object.entity.Guild.ContentFilterLevel
-
Unknown content filter level.
- UNKNOWN - discord4j.core.object.entity.Guild.MfaLevel
-
Unknown MFA level.
- UNKNOWN - discord4j.core.object.entity.Guild.NotificationLevel
-
Unknown notification level.
- UNKNOWN - discord4j.core.object.entity.Guild.NsfwLevel
- UNKNOWN - discord4j.core.object.entity.Guild.PremiumTier
-
Unknown Premium Tier.
- UNKNOWN - discord4j.core.object.entity.Guild.VerificationLevel
-
Unknown verification level.
- UNKNOWN - discord4j.core.object.entity.Integration.ExpireBehavior
-
Unknown.
- UNKNOWN - discord4j.core.object.entity.Message.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.entity.Sticker.Format
-
Unknown sticker format.
- UNKNOWN - discord4j.core.object.entity.Webhook.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.Invite.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.PermissionOverwrite.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.presence.Activity.Type
-
Unknown type.
- UNKNOWN - discord4j.core.object.presence.Status
- UNKNOWN - discord4j.core.object.Region.Id
- unpin() - Method in class discord4j.core.object.entity.Message
-
Requests to unpin this message.
- updatePresence(StatusUpdate) - Method in class discord4j.core.GatewayDiscordClient
-
Update the bot's
Presence
(client status) for every shard in this shard group. - updatePresence(StatusUpdate, int) - Method in class discord4j.core.GatewayDiscordClient
-
Update the bot's
Presence
(status) for the given shard index, provided it belongs in this shard group. - URGENT - discord4j.core.object.entity.Message.Flag
-
This message came from the urgent message system.
- US_CENTRAL - discord4j.core.object.Region.Id
- US_EAST - discord4j.core.object.Region.Id
- US_SOUTH - discord4j.core.object.Region.Id
- US_WEST - discord4j.core.object.Region.Id
- User - Class in discord4j.core.object.entity
-
A Discord user.
- User(GatewayDiscordClient, UserData) - Constructor for class discord4j.core.object.entity.User
-
Constructs an
User
with an associatedGatewayDiscordClient
and Discord data. - USER - discord4j.core.object.command.ApplicationCommand.Type
- USER - discord4j.core.object.command.ApplicationCommandOption.Type
- USER_AVATAR - Static variable in class discord4j.core.object.audit.ChangeKey
-
User avatar changed
- USER_DEAFENED - Static variable in class discord4j.core.object.audit.ChangeKey
-
User server deafened/undeafened
- USER_LIMIT - Static variable in class discord4j.core.object.audit.ChangeKey
-
New user limit in a voice channel
- USER_MUTED - Static variable in class discord4j.core.object.audit.ChangeKey
-
User server muted/unmuted
- USER_NICK - Static variable in class discord4j.core.object.audit.ChangeKey
-
User nickname changed
- USER_PREMIUM_GUILD_SUBSCRIPTION - discord4j.core.object.entity.Message.Type
-
A message created when an user boost a guild.
- USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1 - discord4j.core.object.entity.Message.Type
-
A message created when an user boost a guild and the guild reach the tier 1.
- USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2 - discord4j.core.object.entity.Message.Type
-
A message created when an user boost a guild and the guild reach the tier 2.
- USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3 - discord4j.core.object.entity.Message.Type
-
A message created when an user boost a guild and the guild reach the tier 3.
- User.Flag - Enum in discord4j.core.object.entity
-
Describes the flags of a user.
- UserEditSpec - Class in discord4j.core.spec
-
Spec used to modify the current user.
- UserEditSpec() - Constructor for class discord4j.core.spec.UserEditSpec
- UserInteractionEvent - Class in discord4j.core.event.domain.interaction
-
Dispatched when a user uses a user command (user context menu)
- UserInteractionEvent(GatewayDiscordClient, ShardInfo, Interaction) - Constructor for class discord4j.core.event.domain.interaction.UserInteractionEvent
- UserUpdateEvent - Class in discord4j.core.event.domain
-
Dispatched when the bot's user is updated.
- UserUpdateEvent(GatewayDiscordClient, ShardInfo, User, User) - Constructor for class discord4j.core.event.domain.UserUpdateEvent
V
- validateRequestGuildMembers(RequestGuildMembers, Possible<IntentSet>) - Static method in class discord4j.core.util.ValidationUtil
-
Throws if the request is invalid given the current intents.
- ValidationUtil - Class in discord4j.core.util
- ValidationUtil() - Constructor for class discord4j.core.util.ValidationUtil
- valueOf(String) - Static method in enum discord4j.core.object.ApplicationTeamMember.MembershipState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.audit.ActionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.command.ApplicationCommand.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.command.ApplicationCommandOption.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.command.Interaction.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.component.Button.Style
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.component.MessageComponent.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.Embed.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.channel.Channel.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.ContentFilterLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.MfaLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.NotificationLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.NsfwLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.PremiumTier
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.SystemChannelFlag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Guild.VerificationLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Integration.ExpireBehavior
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Message.Flag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Message.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Sticker.Format
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.User.Flag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.entity.Webhook.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.Invite.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.PermissionOverwrite.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.presence.Activity.Flag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.presence.Activity.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.presence.Status.Platform
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.presence.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum discord4j.core.object.Region.Id
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum discord4j.core.object.ApplicationTeamMember.MembershipState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.audit.ActionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.command.ApplicationCommand.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.command.ApplicationCommandOption.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.command.Interaction.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.component.Button.Style
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.component.MessageComponent.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.Embed.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.channel.Channel.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.channel.VoiceChannel.Mode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.ContentFilterLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.MfaLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.NotificationLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.NsfwLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.PremiumTier
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.SystemChannelFlag
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Guild.VerificationLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Integration.ExpireBehavior
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Message.Flag
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Message.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Sticker.Format
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.User.Flag
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.entity.Webhook.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.Invite.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.PermissionOverwrite.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.presence.Activity.Flag
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.presence.Activity.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.presence.Status.Platform
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.presence.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum discord4j.core.object.Region.Id
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class discord4j.core.shard.ShardAwareStore
- VANITY_URL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Invite vanity url changed
- VERIFICATION_LEVEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Required verification level changed
- VERIFIED_BOT - discord4j.core.object.entity.User.Flag
- VERIFIED_BOT_DEVELOPER - discord4j.core.object.entity.User.Flag
- VERY_HIGH - discord4j.core.object.entity.Guild.VerificationLevel
-
Must have a verified phone number.
- VIDEO - discord4j.core.object.Embed.Type
-
An embed generated by a video.
- VoiceChannel - Class in discord4j.core.object.entity.channel
-
A Discord voice channel.
- VoiceChannel(GatewayDiscordClient, ChannelData) - Constructor for class discord4j.core.object.entity.channel.VoiceChannel
-
Constructs an
VoiceChannel
with an associatedGatewayDiscordClient
and Discord data. - VoiceChannel.Mode - Enum in discord4j.core.object.entity.channel
-
Represents the various video quality modes.
- VoiceChannelCreateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
VoiceChannel
is created in a guild. - VoiceChannelCreateEvent(GatewayDiscordClient, ShardInfo, VoiceChannel) - Constructor for class discord4j.core.event.domain.channel.VoiceChannelCreateEvent
- VoiceChannelCreateSpec - Class in discord4j.core.spec
-
A spec used to configure and create a
VoiceChannel
. - VoiceChannelCreateSpec() - Constructor for class discord4j.core.spec.VoiceChannelCreateSpec
- VoiceChannelDeleteEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
VoiceChannel
is deleted in a guild. - VoiceChannelDeleteEvent(GatewayDiscordClient, ShardInfo, VoiceChannel) - Constructor for class discord4j.core.event.domain.channel.VoiceChannelDeleteEvent
- VoiceChannelEditSpec - Class in discord4j.core.spec
-
Spec used to modify a
VoiceChannel
entity. - VoiceChannelEditSpec() - Constructor for class discord4j.core.spec.VoiceChannelEditSpec
- VoiceChannelJoinSpec - Class in discord4j.core.spec
-
Spec used to request a connection to a
VoiceChannel
and handle the initialization of the resultingVoiceConnection
. - VoiceChannelJoinSpec(GatewayDiscordClient, VoiceChannel) - Constructor for class discord4j.core.spec.VoiceChannelJoinSpec
- VoiceChannelUpdateEvent - Class in discord4j.core.event.domain.channel
-
Dispatched when a
VoiceChannel
is updated in a guild. - VoiceChannelUpdateEvent(GatewayDiscordClient, ShardInfo, VoiceChannel, VoiceChannel) - Constructor for class discord4j.core.event.domain.channel.VoiceChannelUpdateEvent
- VoiceServerUpdateEvent - Class in discord4j.core.event.domain
-
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).
- VoiceServerUpdateEvent(GatewayDiscordClient, ShardInfo, String, long, String) - Constructor for class discord4j.core.event.domain.VoiceServerUpdateEvent
- VoiceState - Class in discord4j.core.object
-
A Discord voice state.
- VoiceState(GatewayDiscordClient, VoiceStateData) - Constructor for class discord4j.core.object.VoiceState
-
Constructs a
VoiceState
with an associatedGatewayDiscordClient
and Discord data. - VoiceStateUpdateEvent - Class in discord4j.core.event.domain
-
Dispatched when a user's voice state changes.
- VoiceStateUpdateEvent(GatewayDiscordClient, ShardInfo, VoiceState, VoiceState) - Constructor for class discord4j.core.event.domain.VoiceStateUpdateEvent
W
- watching(String) - Static method in class discord4j.core.object.presence.Activity
- WATCHING - discord4j.core.object.presence.Activity.Type
-
"Watching {name}"
- WEB - discord4j.core.object.presence.Status.Platform
- Webhook - Class in discord4j.core.object.entity
-
A Discord webhook.
- Webhook(GatewayDiscordClient, WebhookData) - Constructor for class discord4j.core.object.entity.Webhook
-
Constructs a
Webhook
with an associatedGatewayDiscordClient
and Discord data. - WEBHOOK_CREATE - discord4j.core.object.audit.ActionType
- WEBHOOK_DELETE - discord4j.core.object.audit.ActionType
- WEBHOOK_UPDATE - discord4j.core.object.audit.ActionType
- Webhook.Type - Enum in discord4j.core.object.entity
-
Represents the various types of webhooks.
- WebhookCreateSpec - Class in discord4j.core.spec
-
Spec used to create a
Webhook
entity. - WebhookCreateSpec() - Constructor for class discord4j.core.spec.WebhookCreateSpec
- WebhookEditSpec - Class in discord4j.core.spec
-
Spec to modify a
Webhook
entity. - WebhookEditSpec() - Constructor for class discord4j.core.spec.WebhookEditSpec
- WebhooksUpdateEvent - Class in discord4j.core.event.domain
-
Dispatched when a webhook is updated in a guild.
- WebhooksUpdateEvent(GatewayDiscordClient, ShardInfo, long, long) - Constructor for class discord4j.core.event.domain.WebhooksUpdateEvent
- WIDGET_CHANNEL - Static variable in class discord4j.core.object.audit.ChangeKey
-
Channel id of the server widget changed
- WIDGET_ENABLED - Static variable in class discord4j.core.object.audit.ChangeKey
-
Server widget enabled/disable
- withCustomRegistry(KeyStoreRegistry) - Static method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Create an
InvalidationStrategy
that uses a customKeyStoreRegistry
to keep track of stored keys and invalidate them on shard session closing. - withDefault(boolean) - Method in class discord4j.core.object.component.SelectMenu.Option
-
Creates a new possibly-default option with the same data as this one.
- withDescription(String) - Method in class discord4j.core.object.component.SelectMenu.Option
-
Creates a new option with the same data as this one, but with the given description.
- withEarliestEvents(int) - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that will buffer incoming events up to the givenbufferSize
elements, where subsequent events will be dropped in favor of retaining the earliest ones. - withEmoji(ReactionEmoji) - Method in class discord4j.core.object.component.SelectMenu.Option
-
Creates a new option with the same data as this one, but with the given emoji.
- withEventDispatcher(Function<EventDispatcher, Publisher<?>>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Set an initial subscriber to the bootstrapped
EventDispatcher
to gain access to early startup events. - withGateway(Function<GatewayDiscordClient, Publisher<?>>) - Method in class discord4j.core.DiscordClient
-
Connect to the Discord Gateway upon subscription to acquire a
GatewayDiscordClient
instance and use it in a declarative way, releasing the object once the derived usageFunction
completes, and the underlying shard group disconnects, according toGatewayDiscordClient.onDisconnect()
. - withGateway(Function<GatewayDiscordClient, Publisher<?>>) - Method in class discord4j.core.shard.GatewayBootstrap
-
Connect to the Discord Gateway upon subscription to acquire a
GatewayDiscordClient
instance and use it in a declarative way, releasing the object once the derived usageFunction
completes, and the underlying shard group disconnects, according toGatewayDiscordClient.onDisconnect()
. - withGuilds(Snowflake...) - Static method in interface discord4j.core.shard.MemberRequestFilter
-
Request guild members for the given guild
Snowflake
IDs. - withJdkRegistry() - Static method in interface discord4j.core.shard.InvalidationStrategy
-
Deprecated.Create an
InvalidationStrategy
that uses aJdkKeyStoreRegistry
to keep track of stored keys and invalidate them on shard session closing. - withLargeGuilds() - Static method in interface discord4j.core.shard.MemberRequestFilter
-
Request members from large guilds.
- withLatestEvents(int) - Static method in interface discord4j.core.event.EventDispatcher
-
Create an
EventDispatcher
that will buffer incoming events up to the givenbufferSize
elements, where earliest events will be dropped in favor of retaining the latest ones. - withMaxValues(int) - Method in class discord4j.core.object.component.SelectMenu
-
Creates a new select menu with the same data as this one, but with the given maximum values.
- withMinValues(int) - Method in class discord4j.core.object.component.SelectMenu
-
Creates a new select menu with the same data as this one, but with the given minimum values.
- withPlaceholder(String) - Method in class discord4j.core.object.component.SelectMenu
-
Creates a new select menu with the same data as this one, but with the given placeholder text.
- withRetrievalStrategy(EntityRetrievalStrategy) - Method in class discord4j.core.GatewayDiscordClient
-
Applies the given strategy to retrieve entities using this
GatewayDiscordClient
.
All Classes All Packages