net.dv8tion.jda.entities

Class Message.Attachment

java.lang.Object

net.dv8tion.jda.entities.Message.Attachment

Enclosing interface:

Message

public static class Message.Attachment
extends java.lang.Object

Represents a Message file attachment.

Constructor Summary

Constructors

Constructor and Description
Attachment(java.lang.String id, java.lang.String url, java.lang.String proxyUrl, java.lang.String fileName, int size, int height, int width, JDA jda)

Method Summary

Modifier and Type	Method and Description
boolean	download(java.io.File file) Downloads this attachment to given File
java.lang.String	getFileName() The file name of the Attachment when it was first uploaded.
int	getHeight() The height of the Attachment if this Attachment is an image. If this Attachment is not an image, this returns 0.
java.lang.String	getId() The id of the attachment.
java.lang.String	getProxyUrl() The url of the Attachment, proxied by Discord.
int	getSize() The size of the attachment in bytes. Example: if getSize() returns 1024, then the attachment is 1024 bytes, or 1KB, in size.
java.lang.String	getUrl() The url of the Attachment, most likely on the Discord servers.
int	getWidth() The width of the Attachment if this Attachment is an image. If this Attachment is not an image, this returns 0.
boolean	isImage() Based on the values of getHeight and getWidth being larger than zero.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attachment

public Attachment(java.lang.String id,
                  java.lang.String url,
                  java.lang.String proxyUrl,
                  java.lang.String fileName,
                  int size,
                  int height,
                  int width,
                  JDA jda)

Method Detail

getId

public java.lang.String getId()

The id of the attachment. This is not the id of the message that the attachment was attached to.

Returns:

Non-null String containing the Attachment ID.

getUrl

public java.lang.String getUrl()

The url of the Attachment, most likely on the Discord servers.

Returns:

Non-null String containing the Attachment URL.

getProxyUrl

public java.lang.String getProxyUrl()

The url of the Attachment, proxied by Discord.

Returns:

Non-null String containing the proxied Attachment url.

getFileName

public java.lang.String getFileName()

The file name of the Attachment when it was first uploaded.

Returns:

Non-null String containing the Attachment file name.

download

public boolean download(java.io.File file)

Downloads this attachment to given File

Parameters:

file - The file, where the attachment will get downloaded to

Returns:

boolean true, if successful, otherwise false

getSize

public int getSize()

The size of the attachment in bytes.
Example: if getSize() returns 1024, then the attachment is 1024 bytes, or 1KB, in size.

Returns:

Positive int containing the size of the Attachment.

getHeight

public int getHeight()

The height of the Attachment if this Attachment is an image.
If this Attachment is not an image, this returns 0.

Returns:

Never-negative int containing image Attachment height.

getWidth

public int getWidth()

The width of the Attachment if this Attachment is an image.
If this Attachment is not an image, this returns 0.

Returns:

Never-negative int containing image Attachment width.

isImage

public boolean isImage()

Based on the values of getHeight and getWidth being larger than zero.

Returns:

True if width and height are greater than zero.