Package net.dv8tion.jda.api.entities

Entities representing Discord API objects like Users and Channels

This package contains all supported Discord Entities as java classes. They contain information about the specific entity and have operations to interact with them.

Interface Summary

Interface	Description
AbstractChannel	Abstract Channel interface for all ChannelTypes.
Activity	Represents a Discord Activity.
ApplicationInfo	Represents a Discord Application from its bot's point of view.
ApplicationTeam	Meta-data for the team of an application.
Category	Represents a channel category in the official Discord API.
Emote	Represents a Custom Emote.
Guild	Represents a Discord Guild.
GuildChannel	Represents a Guild channel.
GuildVoiceState	Represents the voice state of a Member in a Guild.
IFakeable	Deprecated.
IMentionable	Marks a mentionable entity.
Invite	Representation of a Discord Invite.
Invite.Channel	POJO for the channel information provided by an invite.
Invite.EmbeddedApplication	POJO for the target application information provided by an invite.
Invite.Group	POJO for the group information provided by an invite.
Invite.Guild	POJO for the guild information provided by an invite.
Invite.InviteTarget	POJO for the target of this invite.
IPermissionHolder	Marker for entities that hold Permissions within JDA
ISnowflake	Marks a snowflake entity.
ListedEmote	Represents an emote retrieved from Guild.retrieveEmotes() or Guild.retrieveEmoteById(long)
Member	Represents a Guild-specific User.
Message	Represents a Text message received from Discord.
MessageChannel	Represents a Discord channel that can have Messages and files sent to it.
PermissionOverride	Represents the specific Member or Role permission overrides that can be set for channels.
PrivateChannel	Represents the connection used for direct messaging.
RichPresence	Used to hold additional information about a users Activity relevant to Rich Presence.
Role	Represents a Guild's Role.
Role.RoleTags	Tags associated with this role.
SelfUser	Represents the currently logged in account.
StageChannel	Represents a Stage Channel.
StageInstance	A Stage Instance holds information about a live stage.
StoreChannel	Represents a Discord Store GuildChannel.
TeamMember	Member of a ApplicationTeam.
TextChannel	Represents a Discord Text GuildChannel.
User	Represents a Discord User.
VoiceChannel	Represents a Discord Voice GuildChannel.
Webhook	An object representing Webhooks in Discord
WebhookClient<T>	Interface which allows sending messages through the webhooks API.

Class Summary

Class	Description
Activity.Emoji	Emoji for a custom status.
Activity.Timestamps	Represents the start and end timestamps for a running match
Emoji	Represents a Discord Emoji.
Guild.Ban	Represents a Ban object.
Guild.MetaData	Meta-Data for a Guild
Icon	Icon containing a base64 encoded jpeg/png/gif/gifv image.
Message.Attachment	Represents a Message file attachment.
Message.Interaction	Represents an Interaction provided with a Message.
MessageActivity	Represents a Message activity.
MessageActivity.Application	Represents the Application of a MessageActivity, if it has been set.
MessageEmbed	Represents an embed displayed by Discord.
MessageEmbed.AuthorInfo	Class that represents the author of content, possibly including an icon that Discord proxies.
MessageEmbed.Field	Represents a field in an embed.
MessageEmbed.Footer	Class that represents a footer at the bottom of an embed
MessageEmbed.ImageInfo	Represents the information provided to embed an image.
MessageEmbed.Provider	Multipurpose class that represents a provider of content, whether directly through creation or indirectly through hosting.
MessageEmbed.Thumbnail	Represents the information Discord provided about a thumbnail image that should be displayed with an embed message.
MessageEmbed.VideoInfo	Represents the information provided to embed a video.
MessageHistory	Represents an access point to the Message history of a MessageChannel.
MessageHistory.MessageRetrieveAction	Constructs a MessageHistory object with initially retrieved Messages before or after a certain pivot message id.
MessageReaction	An object representing a single MessageReaction from Discord.
MessageReaction.ReactionEmote	Represents an Emoji/Emote of a MessageReaction This is used to wrap both emojis and emotes
MessageReference	An object representing a reference in a Discord message.
MessageSticker	An object representing a sticker in a Discord message.
RichPresence.Image	Used to hold information on images within a Rich Presence profile
RichPresence.Party	Holds information on a player's party
RoleIcon	An object representing a Role's icon.
User.Profile	Represents the information contained in a User's profile.
VanityInvite	Meta data for the vanity invite of a guild
Webhook.ChannelReference	Partial Channel which references the source channel for a follower webhook.
Webhook.GuildReference	Partial Guild which references the source guild for a follower webhook.
Webhook.WebhookReference	Partial Webhook which can be resolved to a Webhook.

Enum Summary

Enum	Description
Activity.ActivityType	The type game being played, differentiating between a game and stream types.
ActivityFlag	Enum representing the flags in a RichPresence
ChannelType	Enum used to differentiate between the different types of Discord channels.
ClientType	The type of client a user might be active on.
EmbedType	Represents the embedded resource type.
Guild.BoostTier	The boost tier for this guild.
Guild.ExplicitContentLevel	The Explicit-Content-Filter Level of a Guild.
Guild.MFALevel	Represents the Multifactor Authentication level required by the Guild.
Guild.NotificationLevel	Represents the Notification-level of the Guild.
Guild.NSFWLevel	Represents the NSFW level for this guild.
Guild.Timeout	Represents the idle time allowed until a user is moved to the AFK VoiceChannel if one is set (Guild.getAfkChannel()).
Guild.VerificationLevel	Represents the Verification-Level of the Guild.
Icon.IconType	Supported image types for the Discord API.
Invite.InviteType	Enum representing the type of an invite.
Invite.TargetType	A TargetType indicates additional action to be taken by the client on accepting the invite, typically connecting external services or launching external applications depending on the specific TargetType.
Message.MentionType	Mention constants, useful for use with Patterns
Message.MessageFlag	Enum representing the flags on a Message.
MessageActivity.ActivityType	An enum representing MessageActivity types.
MessageSticker.StickerFormat
MessageType	Represents the different types of Messages that can be received from Discord.
StageInstance.PrivacyLevel	The privacy level for a stage instance.
TeamMember.MembershipState	The membership state on the team.
User.UserFlag	Represents the bit offsets used by Discord for public flags
WebhookType