net.dv8tion.jda.entities

Interface MessageEmbed

All Known Implementing Classes:

MessageEmbedImpl

public interface MessageEmbed

Represents an embed displayed by Discord.
This class has many possibilities for null values, so be careful!

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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. The videos represented are expected to be played using an HTML5 player from the site which the url belongs to.

Method Summary

Modifier and Type	Method and Description
MessageEmbed.Provider	getAuthor() The information on the creator of the embedded content. This is typically used for Youtube stuff and will return the username of the video uploader.
java.lang.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.
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.
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.
java.lang.String	getTitle() The title of the embed.
EmbedType	getType() The EmbedType of this embed.
java.lang.String	getUrl() The 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. This is used when sites with HTML5 players are linked and embedded.

Method Detail

getUrl

java.lang.String getUrl()

The that was originally placed into chat that spawned this embed.

Returns:

Never-null String containing the original message url.

getTitle

java.lang.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

java.lang.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

EmbedType getType()

The EmbedType of this embed. W

Returns:

The EmbedType of this embed.

getThumbnail

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

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

MessageEmbed.Provider getAuthor()

The information on the creator of the embedded content.
This is typically used for Youtube stuff and will return the username of the video uploader. If Discord did not generate any deliverable author information, this returns null.

Returns:

Possibly-null Provider containing author information.

getVideoInfo

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.