public class MessageEmbedImpl extends java.lang.Object implements MessageEmbed
MessageEmbed.AuthorInfo, MessageEmbed.Field, MessageEmbed.Footer, MessageEmbed.ImageInfo, MessageEmbed.Provider, MessageEmbed.Thumbnail, MessageEmbed.VideoInfo
Constructor and Description |
---|
MessageEmbedImpl() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
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. |
int |
hashCode() |
MessageEmbedImpl |
setAuthor(MessageEmbed.AuthorInfo author) |
MessageEmbedImpl |
setColor(java.awt.Color color) |
MessageEmbedImpl |
setDescription(java.lang.String description) |
MessageEmbedImpl |
setFields(java.util.List<MessageEmbed.Field> fields) |
MessageEmbedImpl |
setFooter(MessageEmbed.Footer footer) |
MessageEmbedImpl |
setImage(MessageEmbed.ImageInfo image) |
MessageEmbedImpl |
setSiteProvider(MessageEmbed.Provider siteProvider) |
MessageEmbedImpl |
setThumbnail(MessageEmbed.Thumbnail thumbnail) |
MessageEmbedImpl |
setTimestamp(java.time.OffsetDateTime timestamp) |
MessageEmbedImpl |
setTitle(java.lang.String title) |
MessageEmbedImpl |
setType(EmbedType type) |
MessageEmbedImpl |
setUrl(java.lang.String url) |
MessageEmbedImpl |
setVideoInfo(MessageEmbed.VideoInfo videoInfo) |
java.lang.String |
toString() |
public java.lang.String getUrl()
MessageEmbed
getUrl
in interface MessageEmbed
public java.lang.String getTitle()
MessageEmbed
EmbedType
= IMAGE
,
this method will return null.getTitle
in interface MessageEmbed
public java.lang.String getDescription()
MessageEmbed
getDescription
in interface MessageEmbed
public EmbedType getType()
MessageEmbed
EmbedType
of this embed.
WgetType
in interface MessageEmbed
EmbedType
of this embed.public MessageEmbed.Thumbnail getThumbnail()
MessageEmbed
Thumbnail
image to be displayed with the embed.Thumbnail
was not part of this embed, this returns null.getThumbnail
in interface MessageEmbed
Thumbnail
instance containing general information on the displayable thumbnail.public MessageEmbed.Provider getSiteProvider()
MessageEmbed
getSiteProvider
in interface MessageEmbed
Provider
containing site information.public MessageEmbed.AuthorInfo getAuthor()
MessageEmbed
getAuthor
in interface MessageEmbed
AuthorInfo
containing author information.public MessageEmbed.VideoInfo getVideoInfo()
MessageEmbed
EmbedType
!= VIDEO
this will always return null.getVideoInfo
in interface MessageEmbed
VideoInfo
containing the information about the video which should be embedded.public MessageEmbed.Footer getFooter()
MessageEmbed
getFooter
in interface MessageEmbed
Footer
containing the embed footer content.public MessageEmbed.ImageInfo getImage()
MessageEmbed
getImage
in interface MessageEmbed
ImageInfo
containing image information.public java.util.List<MessageEmbed.Field> getFields()
MessageEmbed
getFields
in interface MessageEmbed
Field
objects containing field information.public java.awt.Color getColor()
MessageEmbed
getColor
in interface MessageEmbed
public java.time.OffsetDateTime getTimestamp()
MessageEmbed
getTimestamp
in interface MessageEmbed
public MessageEmbedImpl setUrl(java.lang.String url)
public MessageEmbedImpl setTitle(java.lang.String title)
public MessageEmbedImpl setDescription(java.lang.String description)
public MessageEmbedImpl setType(EmbedType type)
public MessageEmbedImpl setThumbnail(MessageEmbed.Thumbnail thumbnail)
public MessageEmbedImpl setSiteProvider(MessageEmbed.Provider siteProvider)
public MessageEmbedImpl setAuthor(MessageEmbed.AuthorInfo author)
public MessageEmbedImpl setVideoInfo(MessageEmbed.VideoInfo videoInfo)
public MessageEmbedImpl setFooter(MessageEmbed.Footer footer)
public MessageEmbedImpl setImage(MessageEmbed.ImageInfo image)
public MessageEmbedImpl setFields(java.util.List<MessageEmbed.Field> fields)
public MessageEmbedImpl setColor(java.awt.Color color)
public MessageEmbedImpl setTimestamp(java.time.OffsetDateTime timestamp)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object