public interface MessageEmbed
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. |
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()
|
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. |
java.lang.String getUrl()
java.lang.String getTitle()
EmbedType
= IMAGE
,
this method will return null.java.lang.String getDescription()
MessageEmbed.Thumbnail getThumbnail()
Thumbnail
image to be displayed with the embed.Thumbnail
was not part of this embed, this returns null.Thumbnail
instance containing general information on the displayable thumbnail.MessageEmbed.Provider getSiteProvider()
Provider
containing site information.MessageEmbed.Provider getAuthor()
Provider
containing author information.MessageEmbed.VideoInfo getVideoInfo()
EmbedType
!= VIDEO
this will always return null.VideoInfo
containing the information about the video which should be embedded.