- 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
-
- 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>) - Constructor for class discord4j.core.GatewayResources
-
- 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.
- 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.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 approximate count of total members of the guild this invite is associated to, if present.
- getApproximatePresenceCount() - Method in class discord4j.core.object.Invite
-
Gets an approximate count of online members (only present when the target user is set) of the guild this invite
is associated to, if present.
- getAttachments() - Method in class discord4j.core.object.entity.Message
-
Gets any attached files.
- 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(Image.Format) - Method in class discord4j.core.object.entity.User
-
Gets the user's avatar.
- 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.
- getAvatarUrl(Image.Format) - Method in class discord4j.core.object.entity.User
-
Gets the user's avatar URL, if present.
- getAvatarUrl() - Method in class discord4j.core.object.entity.User
-
Gets the user's effective avatar URL.
- 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.
- 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
-
- getChannel() - Method in class discord4j.core.event.domain.channel.NewsChannelDeleteEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.PrivateChannelCreateEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.PrivateChannelDeleteEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.StoreChannelCreateEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.StoreChannelDeleteEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.TextChannelCreateEvent
-
- getChannel() - Method in class discord4j.core.event.domain.channel.TextChannelDeleteEvent
-
- 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
-
- getChannel() - Method in class discord4j.core.event.domain.channel.VoiceChannelDeleteEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.MessageBulkDeleteEvent
-
Requests to retrieve the
TextChannel
representation of the
Channel
the messages were deleted
in.
- getChannel() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
- getChannel() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
- 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.entity.Message
-
Requests to retrieve the channel the message was sent in.
- 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() - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the channel this webhook is associated to.
- 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() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the channel associated to this overwrite.
- getChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the channel associated to this overwrite, using the given retrieval strategy.
- getChannel() - Method in class discord4j.core.object.Invite
-
Requests to retrieve the channel this invite is associated to.
- 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() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the channel this user is connected to, if present.
- 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.
- getChannel(GatewayDiscordClient, ChannelData) - Static method in class discord4j.core.util.EntityUtil
-
An utility that converts some instance of ChannelBean
to its associated Channel
type
.
- 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, 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.
- 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
-
- getChannelId() - Method in class discord4j.core.event.domain.channel.PinsUpdateEvent
-
- getChannelId() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
- 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
-
- 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
-
Gets the
Snowflake
ID of the channel containing the
Message
and the removed Reactions.
- 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.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(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() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's channels.
- 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
-
- 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
-
- getClient() - Method in class discord4j.core.object.audit.AuditLogEntry
-
- getClient() - Method in class discord4j.core.object.Ban
-
- getClient() - Method in interface discord4j.core.object.DiscordObject
-
- 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.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.Message
-
- getClient() - Method in class discord4j.core.object.entity.Role
-
- 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.Invite
-
- 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.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.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.
- 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.
- getCoreResources() - Method in class discord4j.core.DiscordClient
-
- getCoreResources() - Method in class discord4j.core.GatewayDiscordClient
-
- 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.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(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.
- 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
-
Gets the current, new, version of the
Message
's
Embed
in this event.
- 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
-
- 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.Embed
-
Gets the description of the embed, if present.
- getDescription() - Method in class discord4j.core.object.entity.ApplicationInfo
-
Gets the description of the app, if present.
- getDescription() - Method in class discord4j.core.object.entity.Guild
-
Gets the description of the guild, 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
-
- getEmbeds() - Method in class discord4j.core.object.entity.Message
-
Gets any embedded content.
- getEmoji() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
- getEmoji() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
- getEmoji() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
- 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.
- 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.
- 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.
- getGateway() - Method in class discord4j.core.event.dispatch.DispatchContext
-
- getGatewayClient(int) - Method in class discord4j.core.GatewayDiscordClient
-
- getGatewayClientGroup() - Method in class discord4j.core.GatewayDiscordClient
-
- getGatewayReactorResources() - Method in class discord4j.core.GatewayResources
-
- 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
-
Requests to retrieve the
Guild
the pinned/unpinned
Message
is in, if this happened in a guild.
- getGuild() - Method in class discord4j.core.event.domain.guild.BanEvent
-
Requests to retrieve the
Guild
the
User
was banned from.
- 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
-
Requests to retrieve the
Guild
the
Member
has joined in this event.
- getGuild() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
-
Requests to retrieve the
Guild
that the
User
has left in this event.
- 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
-
Requests to retrieve the
Guild
the
Message
was created in, if present.
- getGuild() - Method in class discord4j.core.event.domain.message.MessageDeleteEvent
-
Requests to retrieve the
Guild
the
Message
was deleted from, if present.
- getGuild() - Method in class discord4j.core.event.domain.message.MessageUpdateEvent
-
Request to retrieve the
Guild
containing the updated
Message
in this event.
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Request to retrieve the
Guild
containing the
Message
and reaction, if present.
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveAllEvent
-
Request to retrieve the
Guild
containing the
Message
the reactions were removed from, if present.
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveEmojiEvent
-
Requests to retrieve the
Guild
the
Message
involved is in, if present.
- getGuild() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
Requests to retrieve the
Guild
the
Message
involved is in, if present.
- getGuild() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the
Guild
containing the
User
whose presence has been updated.
- getGuild() - Method in class discord4j.core.event.domain.role.RoleCreateEvent
-
Requests to retrieve the
Guild
the
Role
was created in.
- getGuild() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
-
Requests to retrieve the
Guild
the
Role
was deleted in.
- 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 interface discord4j.core.object.entity.channel.GuildChannel
-
Requests to retrieve the guild this channel is associated to.
- 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() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the guild this emoji is associated to.
- 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() - Method in class discord4j.core.object.entity.Member
-
Requests to retrieve the guild this user is associated to.
- 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() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the guild this message is associated to, if present.
- 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() - Method in class discord4j.core.object.entity.Role
-
Requests to retrieve the guild this role is associated to.
- 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() - Method in class discord4j.core.object.entity.Webhook
-
Requests to retrieve the guild this webhook is associated to.
- 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() - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the guild associated to this overwrite.
- getGuild(EntityRetrievalStrategy) - Method in class discord4j.core.object.ExtendedPermissionOverwrite
-
Requests to retrieve the guild associated to this overwrite, using the given retrieval strategy.
- getGuild() - Method in class discord4j.core.object.Invite
-
Requests to retrieve the guild this invite is associated to, if present.
- 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() - Method in class discord4j.core.object.VoiceState
-
Requests to retrieve the guild this voice state is for.
- 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, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
-
- getGuildEmojiById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild emoji as represented by the supplied ID.
- 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.
- 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
-
- 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
-
Gets the
Snowflake
ID of the
Guild
the user has started typing in, if this happened in a guild.
- 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.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 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.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 present.
- 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.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
-
- 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.
- getId() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
-
- getId() - Method in class discord4j.core.object.audit.AuditLogEntry
-
- getId() - Method in class discord4j.core.object.entity.ApplicationInfo
-
- 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.Message
-
- getId() - Method in class discord4j.core.object.entity.Role
-
- 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.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.
- getIntents() - Method in class discord4j.core.GatewayResources
-
- 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
-
Requests to retrieve the user who created the invite.
- getInviter(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Requests to retrieve the user who created the invite, using the given retrieval strategy.
- 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.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.
- 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.
- 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.
- 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
-
Gets the
Member
that has joined the
Guild
in this event.
- getMember() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
-
Gets the
Member
object of the
User
that has left the
Guild
in this event, if present.
- 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
-
Gets the
Member
who has sent the
Message
created in this event, if present.
- 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
-
Requests to retrieve the
Member
object of the
User
involved in this event.
- 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, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
-
- getMemberById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the member as represented by the supplied ID.
- 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.
- 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
-
- getMemberCount() - Method in class discord4j.core.object.entity.Guild
-
Gets the total number of members in the guild.
- 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.
- 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 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.
- 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.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.
- getMessageById(Snowflake, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
-
- getMessageById(Snowflake) - Method in interface discord4j.core.object.entity.channel.MessageChannel
-
Requests to retrieve the message as represented by the supplied ID.
- 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.
- 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
-
- 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
-
Gets the
Snowflake
ID of the
Message
the reactions were removed from in this event.
- 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
in this message (Server Following feature), 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.
- getName() - Method in class discord4j.core.object.audit.ChangeKey
-
Gets the name of audit log change key.
- 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 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.Role
-
Gets the role name.
- getName() - Method in class discord4j.core.object.entity.Webhook
-
Gets the default name of the webhook.
- 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 a
NewsChannel
.
- 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 a
NewsChannel
.
- 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..
- 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.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
-
- 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(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.ApplicationInfo
-
Requests to retrieve the owner of the application, using the given retrieval strategy.
- getOwner() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the owner of the guild.
- 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.Guild
-
Gets the ID of the owner of the guild.
- 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.
- 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 "PUBLIC" 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
-
- 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.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.
- getPublicUpdatesChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where admins and moderators of "PUBLIC" 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 "PUBLIC" 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 "PUBLIC" 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 enum discord4j.core.object.entity.channel.AllowedMentions.Type
-
- 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.
- 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
-
Requests to retrieve the recipients for this private channel.
- getRecipients(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.channel.PrivateChannel
-
Requests to retrieve the recipients for this private channel, using the given retrieval strategy.
- getRegion() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the voice region for the guild.
- getRegionId() - Method in class discord4j.core.object.entity.Guild
-
Gets the voice region ID for the guild.
- 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.
- getResponsibleUserId() - Method in class discord4j.core.object.audit.AuditLogEntry
-
Gets the user who made the changes.
- 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, Snowflake) - Method in class discord4j.core.GatewayDiscordClient
-
- getRoleById(Snowflake) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the role as represented by the supplied ID.
- 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.
- 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
-
- getRoleId() - Method in class discord4j.core.event.domain.role.RoleDeleteEvent
-
Gets the
Snowflake
ID of the
Role
that was deleted in this event.
- 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.
- 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(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the guild's roles, using the given retrieval strategy.
- getRoles() - Method in class discord4j.core.object.entity.GuildEmoji
-
Requests to retrieve the roles this emoji is whitelisted to.
- 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() - 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.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
-
- getRulesChannel() - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
- getRulesChannel(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Guild
-
Requests to retrieve the channel where "PUBLIC" 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 "PUBLIC" guilds display rules and/or guidelines, if present.
- getSelf() - Method in class discord4j.core.event.domain.lifecycle.ReadyEvent
-
- 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.
- 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
-
Repository aggregate view of all caching related operations.
- 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.
- 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.
- 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.
- 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.PermissionOverwrite
-
Gets the ID of the entity this overwrite targets.
- getTargetUser() - Method in class discord4j.core.object.Invite
-
Requests to retrieve the target user this invite is associated to.
- getTargetUser(EntityRetrievalStrategy) - Method in class discord4j.core.object.Invite
-
Requests to retrieve the target user this invite is associated to, using the given retrieval strategy.
- 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
-
Gets the type of target user for this invite, 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 a
TextChannel
.
- 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 a
TextChannel
.
- 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.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.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.Message
-
Gets the type of message.
- 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.
- 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.
- 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
-
Gets the
User
that has been banned from the
Guild
.
- getUser() - Method in class discord4j.core.event.domain.guild.MemberLeaveEvent
-
Gets the
User
that has left the
Guild
in this event.
- 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.Ban
-
Gets the banned 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.ExtendedPermissionOverwrite
-
Requests to retrieve the user this overwrite is associated to, if present.
- 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() - 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.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.
- getUserId() - Method in class discord4j.core.event.domain.channel.TypingStartEvent
-
Gets the
Snowflake
ID of the
User
who has started typing in this event.
- getUserId() - Method in class discord4j.core.event.domain.message.ReactionAddEvent
-
Gets the
Snowflake
ID of the
User
who added a reaction in this event.
- getUserId() - Method in class discord4j.core.event.domain.message.ReactionRemoveEvent
-
Gets the
Snowflake
ID of the
User
who's reaction has been removed.
- getUserId() - Method in class discord4j.core.event.domain.PresenceUpdateEvent
-
Gets the
Snowflake
ID of the
User
whose presence has been updated in this event.
- 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.
- getUserMentions() - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the users specifically mentioned in this message.
- getUserMentions(EntityRetrievalStrategy) - Method in class discord4j.core.object.entity.Message
-
Requests to retrieve the users specifically mentioned in this message, using the given retrieval strategy.
- 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.audit.ActionType
-
Gets the underlying value as represented by Discord.
- 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.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.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.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.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 class discord4j.core.state.ParameterData
-
- 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.
- getVoiceConnectionFactory() - Method in class discord4j.core.GatewayDiscordClient
-
- getVoiceConnectionRegistry() - Method in class discord4j.core.GatewayDiscordClient
-
- getVoiceReactorResources() - Method in class discord4j.core.GatewayResources
-
- 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.
- 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.
- 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.
- Guild(long, boolean) - Constructor for class discord4j.core.event.domain.lifecycle.ReadyEvent.Guild
-
- Guild - Class in discord4j.core.object.entity
-
A Discord guild.
- Guild(GatewayDiscordClient, GuildData) - Constructor for class discord4j.core.object.entity.Guild
-
Constructs an Guild
with an associated ServiceMediator and Discord data.
- 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.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 many
guild 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
-
- 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 associated ServiceMediator and Discord data.
- GuildEmojiCreateSpec - Class in discord4j.core.spec
-
- GuildEmojiCreateSpec() - Constructor for class discord4j.core.spec.GuildEmojiCreateSpec
-
- GuildEmojiEditSpec - Class in discord4j.core.spec
-
- 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
-
- 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
-