Class MessageEmbed.Thumbnail

java.lang.Object

net.dv8tion.jda.api.entities.MessageEmbed.Thumbnail

Enclosing class:

MessageEmbed

public static class MessageEmbed.Thumbnail
extends Object

Represents the information Discord provided about a thumbnail image that should be displayed with an embed message.

Constructor Summary

Constructors

Constructor	Description
Thumbnail(String url, String proxyUrl, int width, int height, String description, String contentType, ThumbHashPlaceholder placeholder, int flags)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getContentType()	The media type, if available, or null.
String	getDescription()	The description of the thumbnail (alt text), or null if none is set.
@Unmodifiable Set<MessageEmbed.MessageEmbedMediaFlag>	getFlags()	Returns an unmodifiable set of all MessageEmbedMediaFlags present for this thumbnail.
long	getFlagsRaw()	Returns the raw media embed flags of this thumbnail.
int	getHeight()	The height of the thumbnail image.
ThumbHashPlaceholder	getPlaceholder()	The placeholder of the thumbnail, or null.
AttachmentProxy	getProxy()	Returns an AttachmentProxy for this embed thumbnail.
String	getProxyUrl()	The Discord proxied url of the thumbnail image.
String	getUrl()	The web url of this thumbnail image.
int	getWidth()	The width of the thumbnail image.
int	hashCode()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Thumbnail

public Thumbnail(String url,
 String proxyUrl,
 int width,
 int height,
 String description,
 String contentType,
 ThumbHashPlaceholder placeholder,
 int flags)

Method Details

getUrl

@Nullable
public String getUrl()

The web url of this thumbnail image.

Returns:

Possibly-null String containing the url of the displayed image.

getProxyUrl

@Nullable
public String getProxyUrl()

The Discord proxied url of the thumbnail image.
This url is used to access the image through Discord instead of directly to prevent ip scraping.

Returns:

Possibly-null String containing the proxied url of this image.

getProxy

@Nullable
public AttachmentProxy getProxy()

Returns an AttachmentProxy for this embed thumbnail.

Returns:

Possibly-null AttachmentProxy of this embed thumbnail

See Also:

• getProxyUrl()

getWidth

public int getWidth()

The width of the thumbnail image.

Returns:

Never-negative, Never-zero int containing the width of the image.

getHeight

public int getHeight()

The height of the thumbnail image.

Returns:

Never-negative, Never-zero int containing the height of the image.

getDescription

@Nullable
public String getDescription()

The description of the thumbnail (alt text), or null if none is set.

Returns:

Description of the thumbnail, or null

getContentType

@Nullable
public String getContentType()

The media type, if available, or null.

This may be absent if the media failed to load.

Returns:

The media type, or null

getPlaceholder

@Nullable
public ThumbHashPlaceholder getPlaceholder()

The placeholder of the thumbnail, or null.

Returns:

The placeholder or null

See Also:

• ThumbHashPlaceholder

getFlagsRaw

public long getFlagsRaw()

Returns the raw media embed flags of this thumbnail.

Returns:

The raw media flags

See Also:

• getFlags()

getFlags

@Nonnull
public @Unmodifiable Set<MessageEmbed.MessageEmbedMediaFlag> getFlags()

Returns an unmodifiable set of all MessageEmbedMediaFlags present for this thumbnail.

Returns:

Unmodifiable set of present MessageEmbedMediaFlags

See Also:

• MessageEmbed.MessageEmbedMediaFlag

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object