public interface MessageEmbed
Modifier and Type | Interface and 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.
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.AuthorInfo |
getAuthor()
The information on the creator of the embedded content.
This is typically used to represent the account on the providing site. |
java.awt.Color |
getColor()
The color of the stripe on the side of the embed.
If the color is 0 (no color), this will return null. |
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. |
java.util.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. |
MessageEmbed.Footer |
getFooter()
The footer (bottom) of the embedded content.
This is typically used for timestamps or site icons. |
MessageEmbed.ImageInfo |
getImage()
The information about the image in the message embed
|
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.time.OffsetDateTime |
getTimestamp()
The timestamp of the embed.
|
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.AuthorInfo getAuthor()
AuthorInfo
containing author information.MessageEmbed.VideoInfo getVideoInfo()
EmbedType
!= VIDEO
this will always return null.VideoInfo
containing the information about the video which should be embedded.MessageEmbed.Footer getFooter()
Footer
containing the embed footer content.MessageEmbed.ImageInfo getImage()
ImageInfo
containing image information.java.util.List<MessageEmbed.Field> getFields()
Field
objects containing field information.java.awt.Color getColor()
java.time.OffsetDateTime getTimestamp()