Class MessageEmbed.ImageInfo

java.lang.Object

net.dv8tion.jda.api.entities.MessageEmbed.ImageInfo

Enclosing class:

MessageEmbed

public static class MessageEmbed.ImageInfo
extends Object

Represents the information provided to embed an image.

Constructor Summary

Constructors

Constructor	Description
ImageInfo(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 image (alt text), or null if none is set.
@Unmodifiable Set<MessageEmbed.MessageEmbedMediaFlag>	getFlags()	Returns an unmodifiable set of all MessageEmbedMediaFlags present for this image.
long	getFlagsRaw()	Returns the raw media embed flags of this image.
int	getHeight()	The height of the image.
ThumbHashPlaceholder	getPlaceholder()	The placeholder of the image, or null.
AttachmentProxy	getProxy()	Returns an AttachmentProxy for this embed image.
String	getProxyUrl()	The url of the image, proxied by Discord This url is used to access the image through Discord instead of directly to prevent ip scraping.
String	getUrl()	The url of the image.
int	getWidth()	The width of the image.
int	hashCode()

Methods inherited from class Object

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

Constructor Details

ImageInfo

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

Method Details

getUrl

@Nullable
public String getUrl()

The url of the image.

Returns:

Possibly-null String containing the image url.

getProxyUrl

@Nullable
public String getProxyUrl()

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

Returns:

Possibly-null String containing the proxied image url.

getProxy

@Nullable
public AttachmentProxy getProxy()

Returns an AttachmentProxy for this embed image.

Returns:

Possibly-null AttachmentProxy of this embed image

See Also:

• getProxyUrl()

getWidth

public int getWidth()

The width of the image.

Returns:

Non-negative, Non-zero int containing the width of the embedded image.

getHeight

public int getHeight()

The height of the image.

Returns:

Non-negative, Non-zero int containing the height of the embedded image.

getDescription

@Nullable
public String getDescription()

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

Returns:

Description of the image, 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 image, or null.

Returns:

The placeholder or null

See Also:

• ThumbHashPlaceholder

getFlagsRaw

public long getFlagsRaw()

Returns the raw media embed flags of this image.

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 image.

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