Package net.dv8tion.jda.api.entities

Class MessageEmbed

java.lang.Object

net.dv8tion.jda.api.entities.MessageEmbed

All Implemented Interfaces:

SerializableData

public class MessageEmbed
extends Object
implements SerializableData

Represents an embed displayed by Discord.
A visual representation of an Embed can be found at: Embed Overview
This class has many possibilities for null values, so be careful!

See Also:

• EmbedBuilder
• Message.getEmbeds()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageEmbed.AuthorInfo	Class that represents the author of content, possibly including an icon that Discord proxies.
static class	MessageEmbed.Field	Represents a field in an embed.
static class	MessageEmbed.Footer	Class that represents a footer at the bottom of an embed
static class	MessageEmbed.ImageInfo	Represents the information provided to embed an image.
static class	MessageEmbed.Provider	Multipurpose class that represents a provider of content, whether directly through creation or indirectly through hosting.
static class	MessageEmbed.Thumbnail	Represents the information Discord provided about a thumbnail image that should be displayed with an embed message.
static class	MessageEmbed.VideoInfo	Represents the information provided to embed a video.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTHOR_MAX_LENGTH	The maximum length the author name of an embed can have
static final int	DESCRIPTION_MAX_LENGTH	The maximum length the description of an embed can have
static final int	EMBED_MAX_LENGTH_BOT	The maximum amount of total visible characters an embed can have
static final int	EMBED_MAX_LENGTH_CLIENT	Deprecated. This will be removed in the future.
static final int	MAX_FIELD_AMOUNT	The maximum amount of total embed fields the embed can hold
static final int	TEXT_MAX_LENGTH	The maximum length the footer of an embed can have
static final int	TITLE_MAX_LENGTH	The maximum length an embed title can have
static final int	URL_MAX_LENGTH	The maximum length any URL can have inside an embed
static final int	VALUE_MAX_LENGTH	The maximum length an embed field value can have

Constructor Summary

Constructors

Constructor	Description
MessageEmbed(String url, String title, String description, EmbedType type, OffsetDateTime timestamp, int color, MessageEmbed.Thumbnail thumbnail, MessageEmbed.Provider siteProvider, MessageEmbed.AuthorInfo author, MessageEmbed.VideoInfo videoInfo, MessageEmbed.Footer footer, MessageEmbed.ImageInfo image, List<MessageEmbed.Field> fields)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MessageEmbed.AuthorInfo	getAuthor()	The information on the creator of the embedded content.
Color	getColor()	The color of the stripe on the side of the embed.
int	getColorRaw()	The raw RGB color value for this embed Defaults to Role.DEFAULT_COLOR_RAW if no color is set
String	getDescription()	The description of the embedded resource.
List<MessageEmbed.Field>	getFields()	The fields in a message embed.
MessageEmbed.Footer	getFooter()	The footer (bottom) of the embedded content.
MessageEmbed.ImageInfo	getImage()	The information about the image in the message embed
int	getLength()	The total amount of characters that is displayed when this embed is displayed by the Discord client.
MessageEmbed.Provider	getSiteProvider()	The information on site from which the embed was generated from.
MessageEmbed.Thumbnail	getThumbnail()	The information about the Thumbnail image to be displayed with the embed.
OffsetDateTime	getTimestamp()	The timestamp of the embed.
String	getTitle()	The title of the embed.
EmbedType	getType()	The EmbedType of this embed.
String	getUrl()	The url that was originally placed into chat that spawned this embed.
MessageEmbed.VideoInfo	getVideoInfo()	The information about the video which should be displayed as an embed.
boolean	isEmpty()	Whether this embed is empty.
boolean	isSendable()	Whether this MessageEmbed can be used in a message.
DataObject	toData()	Creates a new DataObject used for sending.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TITLE_MAX_LENGTH

public static final int TITLE_MAX_LENGTH

The maximum length an embed title can have

See Also:

• EmbedBuilder.setTitle(title)
• EmbedBuilder.addField(title, value, inline)
• Constant Field Values

AUTHOR_MAX_LENGTH

public static final int AUTHOR_MAX_LENGTH

The maximum length the author name of an embed can have

See Also:

• (String) EmbedBuilder.setAuthor(title)
• EmbedBuilder.setAuthor(title, url)
• EmbedBuilder.setAuthor(title, url, iconUrl)
• Constant Field Values

VALUE_MAX_LENGTH

public static final int VALUE_MAX_LENGTH

The maximum length an embed field value can have

See Also:

• EmbedBuilder.addField(title, value, inline)
• Constant Field Values

DESCRIPTION_MAX_LENGTH

public static final int DESCRIPTION_MAX_LENGTH

The maximum length the description of an embed can have

See Also:

• EmbedBuilder.setDescription(text)
• Constant Field Values

TEXT_MAX_LENGTH

public static final int TEXT_MAX_LENGTH

The maximum length the footer of an embed can have

See Also:

• EmbedBuilder.setFooter(text, iconUrl)
• Constant Field Values

URL_MAX_LENGTH

public static final int URL_MAX_LENGTH

The maximum length any URL can have inside an embed

See Also:

• EmbedBuilder.setTitle(text, url)
• EmbedBuilder.setAuthor(text, url, iconUrl)
• EmbedBuilder.setFooter(text, url)
• Constant Field Values

EMBED_MAX_LENGTH_BOT

public static final int EMBED_MAX_LENGTH_BOT

The maximum amount of total visible characters an embed can have

See Also:

• EmbedBuilder.setDescription(CharSequence)
• EmbedBuilder.setTitle(String)
• EmbedBuilder.setFooter(String, String)
• EmbedBuilder.addField(String, String, boolean)
• Constant Field Values

EMBED_MAX_LENGTH_CLIENT

@Deprecated
@ForRemoval
public static final int EMBED_MAX_LENGTH_CLIENT

Deprecated.

This will be removed in the future.

The maximum amount of total visible characters an embed can have

See Also:

• EmbedBuilder.setDescription(CharSequence)
• EmbedBuilder.setTitle(String)
• EmbedBuilder.setFooter(String, String)
• EmbedBuilder.addField(String, String, boolean)
• Constant Field Values

MAX_FIELD_AMOUNT

public static final int MAX_FIELD_AMOUNT

The maximum amount of total embed fields the embed can hold

See Also:

• EmbedBuilder.addField(String, String, boolean)
• Constant Field Values

Constructor Details

MessageEmbed

public MessageEmbed(String url,
 String title,
 String description,
 EmbedType type,
 OffsetDateTime timestamp,
 int color,
 MessageEmbed.Thumbnail thumbnail,
 MessageEmbed.Provider siteProvider,
 MessageEmbed.AuthorInfo author,
 MessageEmbed.VideoInfo videoInfo,
 MessageEmbed.Footer footer,
 MessageEmbed.ImageInfo image,
 List<MessageEmbed.Field> fields)

Method Details

getUrl

@Nullable
public String getUrl()

The url that was originally placed into chat that spawned this embed.
This will return the title url if the type of this embed is RICH.

Returns:

Possibly-null String containing the link that spawned this embed or the title url

getTitle

@Nullable
public String getTitle()

The title of the embed. Typically this will be the html title of the webpage that is being embedded.
If no title could be found, like the case of EmbedType = IMAGE, this method will return null.

Returns:

Possibly-null String containing the title of the embedded resource.

getDescription

@Nullable
public String getDescription()

The description of the embedded resource.
This is provided only if Discord could find a description for the embedded resource using the provided url.
Commonly, this is null. Be careful when using it.

Returns:

Possibly-null String containing a description of the embedded resource.

getType

@Nonnull
public EmbedType getType()

The EmbedType of this embed.

Returns:

The EmbedType of this embed.

getThumbnail

@Nullable
public MessageEmbed.Thumbnail getThumbnail()

The information about the Thumbnail image to be displayed with the embed.
If a Thumbnail was not part of this embed, this returns null.

Returns:

Possibly-null Thumbnail instance containing general information on the displayable thumbnail.

getSiteProvider

@Nullable
public MessageEmbed.Provider getSiteProvider()

The information on site from which the embed was generated from.
If Discord did not generate any deliverable information about the site, this returns null.

Returns:

Possibly-null Provider containing site information.

getAuthor

@Nullable
public MessageEmbed.AuthorInfo getAuthor()

The information on the creator of the embedded content.
This is typically used to represent the account on the providing site.

Returns:

Possibly-null AuthorInfo containing author information.

getVideoInfo

@Nullable
public MessageEmbed.VideoInfo getVideoInfo()

The information about the video which should be displayed as an embed.
This is used when sites with HTML5 players are linked and embedded. Most commonly Youtube.
If this EmbedType != VIDEO this will always return null.

Returns:

Possibly-null VideoInfo containing the information about the video which should be embedded.

getFooter

@Nullable
public MessageEmbed.Footer getFooter()

The footer (bottom) of the embedded content.
This is typically used for timestamps or site icons.

Returns:

Possibly-null Footer containing the embed footer content.

getImage

@Nullable
public MessageEmbed.ImageInfo getImage()

The information about the image in the message embed

Returns:

Possibly-null ImageInfo containing image information.

getFields

@Nonnull
public List<MessageEmbed.Field> getFields()

The fields in a message embed.
Message embeds can contain multiple fields, each with a name, value, and a boolean to determine if it will fall in-line with other fields. If the embed contains no fields, an empty list will be returned.

Returns:

Never-null (but possibly empty) immutable List of Field objects containing field information.

getColor

@Nullable
public Color getColor()

The color of the stripe on the side of the embed.
If the color is 0 (no color), this will return null.

Returns:

Possibly-null Color.

getColorRaw

public int getColorRaw()

The raw RGB color value for this embed
Defaults to Role.DEFAULT_COLOR_RAW if no color is set

Returns:

The raw RGB color value or default

getTimestamp

@Nullable
public OffsetDateTime getTimestamp()

The timestamp of the embed.

Returns:

Possibly-null OffsetDateTime object representing the timestamp.

isEmpty

public boolean isEmpty()

Whether this embed is empty.

Returns:

True, if this embed has no content

getLength

public int getLength()

The total amount of characters that is displayed when this embed is displayed by the Discord client.

The total character limit is defined by EMBED_MAX_LENGTH_BOT as 6000.

Returns:

A never-negative sum of all displayed text characters.

isSendable

public boolean isSendable()

Whether this MessageEmbed can be used in a message.

The total character limit is defined by EMBED_MAX_LENGTH_BOT as 6000.

Returns:

True, if this MessageEmbed can be used to send messages

See Also:

• getLength()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toData

@Nonnull
public DataObject toData()

Creates a new DataObject used for sending.

Specified by:

toData in interface SerializableData

Returns:

JSONObject for this embed