net.dv8tion.jda.entities.impl

Class MessageEmbedImpl

java.lang.Object

net.dv8tion.jda.entities.impl.MessageEmbedImpl

All Implemented Interfaces:

MessageEmbed

public class MessageEmbedImpl
extends java.lang.Object
implements MessageEmbed

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.entities.MessageEmbed

MessageEmbed.Provider, MessageEmbed.Thumbnail, MessageEmbed.VideoInfo

Constructor Summary

Constructors

Constructor and Description
MessageEmbedImpl()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
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.
int	hashCode()
MessageEmbedImpl	setAuthor(MessageEmbed.Provider author)
MessageEmbedImpl	setDescription(java.lang.String description)
MessageEmbedImpl	setSiteProvider(MessageEmbed.Provider siteProvider)
MessageEmbedImpl	setThumbnail(MessageEmbed.Thumbnail thumbnail)
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()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageEmbedImpl

public MessageEmbedImpl()

Method Detail

getUrl

public java.lang.String getUrl()

Description copied from interface: MessageEmbed

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

Specified by:

getUrl in interface MessageEmbed

Returns:

Never-null String containing the original message url.

getTitle

public java.lang.String getTitle()

Description copied from interface: MessageEmbed

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.

Specified by:

getTitle in interface MessageEmbed

Returns:

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

getDescription

public java.lang.String getDescription()

Description copied from interface: MessageEmbed

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.

Specified by:

getDescription in interface MessageEmbed

Returns:

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

getType

public EmbedType getType()

Description copied from interface: MessageEmbed

The EmbedType of this embed. W

Specified by:

getType in interface MessageEmbed

Returns:

The EmbedType of this embed.

getThumbnail

public MessageEmbed.Thumbnail getThumbnail()

Description copied from interface: MessageEmbed

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

Specified by:

getThumbnail in interface MessageEmbed

Returns:

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

getSiteProvider

public MessageEmbed.Provider getSiteProvider()

Description copied from interface: MessageEmbed

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.

Specified by:

getSiteProvider in interface MessageEmbed

Returns:

Possibly-null Provider containing site information.

getAuthor

public MessageEmbed.Provider getAuthor()

Description copied from interface: MessageEmbed

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.

Specified by:

getAuthor in interface MessageEmbed

Returns:

Possibly-null Provider containing author information.

getVideoInfo

public MessageEmbed.VideoInfo getVideoInfo()

Description copied from interface: MessageEmbed

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.

Specified by:

getVideoInfo in interface MessageEmbed

Returns:

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

setUrl

public MessageEmbedImpl setUrl(java.lang.String url)

setTitle

public MessageEmbedImpl setTitle(java.lang.String title)

setDescription

public MessageEmbedImpl setDescription(java.lang.String description)

setType

public MessageEmbedImpl setType(EmbedType type)

setThumbnail

public MessageEmbedImpl setThumbnail(MessageEmbed.Thumbnail thumbnail)

setSiteProvider

public MessageEmbedImpl setSiteProvider(MessageEmbed.Provider siteProvider)

setAuthor

public MessageEmbedImpl setAuthor(MessageEmbed.Provider author)

setVideoInfo

public MessageEmbedImpl setVideoInfo(MessageEmbed.VideoInfo videoInfo)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object