Package net.dv8tion.jda.api.utils

Class NamedAttachmentProxy

java.lang.Object

net.dv8tion.jda.api.utils.FileProxy

net.dv8tion.jda.api.utils.AttachmentProxy

net.dv8tion.jda.api.utils.NamedAttachmentProxy

public class NamedAttachmentProxy
extends AttachmentProxy

A utility class to retrieve attachments.
This supports downloading the images from the normal URL, as well as downloading the image with a specific width and height.

This is a specialization of AttachmentProxy, which is aware of the file name of the attachment.

Constructor Summary

Constructors

Constructor	Description
NamedAttachmentProxy(String url, String fileName)	Constructs a new AttachmentProxy for the provided URL.

Method Summary

Modifier and Type	Method	Description
FileUpload	downloadAsFileUpload(int width, int height)	Returns a FileUpload which supplies a data stream of this attachment, with the original attachment's file name and at the specified size.
String	getFileName()	The file name of the attachment.

Methods inherited from class net.dv8tion.jda.api.utils.AttachmentProxy

download, downloadAsFileUpload, downloadAsIcon, downloadAsIcon, downloadToFile, downloadToPath, downloadToPath, getUrl, withClient

Methods inherited from class net.dv8tion.jda.api.utils.FileProxy

download, downloadAsFileUpload, downloadToFile, downloadToPath, downloadToPath, getUrl, setDefaultHttpClient

Methods inherited from class java.lang.Object

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

Constructor Details

NamedAttachmentProxy

public NamedAttachmentProxy(@Nonnull
 String url,
 @Nonnull
 String fileName)

Constructs a new AttachmentProxy for the provided URL.

Parameters:

url - The URL to download the attachment from

fileName - An optional file name for downloadAsFileUpload(int, int)

Throws:

IllegalArgumentException - If the provided URL is null

Method Details

getFileName

@Nonnull
public String getFileName()

The file name of the attachment.

Returns:

The file name

downloadAsFileUpload

@Nonnull
public FileUpload downloadAsFileUpload(int width,
 int height)

Returns a FileUpload which supplies a data stream of this attachment, with the original attachment's file name and at the specified size.
The returned FileUpload can be reused safely, and does not need to be closed.

The attachment, if an image, may be resized at any size, however if the size does not fit the ratio of the image, then it will be cropped as to fit the target size.
If the attachment is not an image then the size parameters are ignored and the file is downloaded.

Parameters:

width - The width of this image, must be positive

height - The height of this image, must be positive

Returns:

FileUpload from this attachment.

Throws:

IllegalArgumentException - If any of the follow checks are true

• The requested width is negative or 0
• The requested height is negative or 0