Package net.dv8tion.jda.internal.components.mediagallery

Class MediaGalleryItemFileUpload

java.lang.Object

net.dv8tion.jda.internal.components.mediagallery.MediaGalleryItemFileUpload

All Implemented Interfaces:

MediaGalleryItem, SerializableData, FileContainerMixin

public class MediaGalleryItemFileUpload
extends Object
implements MediaGalleryItem, FileContainerMixin

Field Summary

Fields inherited from interface net.dv8tion.jda.api.components.mediagallery.MediaGalleryItem

MAX_DESCRIPTION_LENGTH

Constructor Summary

Constructors

Constructor	Description
MediaGalleryItemFileUpload(FileUpload upload)
MediaGalleryItemFileUpload(FileUpload file, String description, boolean spoiler)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	The description of this item, or null if none has been set.
Stream<FileUpload>	getFiles()
ResolvedMedia	getResolvedMedia()	The media resolved from this item, this is only available if you receive this component from Discord.
String	getUrl()	The URL of this item, this is always where the file originally came from.
int	hashCode()
boolean	isSpoiler()	Whether this item is hidden until the user clicks on it.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
MediaGalleryItem	withDescription(String description)	Creates a new MediaGalleryItem with the provided description.
MediaGalleryItem	withSpoiler(boolean spoiler)	Creates a new MediaGalleryItem with the provided spoiler status.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MediaGalleryItemFileUpload

public MediaGalleryItemFileUpload(FileUpload upload)

MediaGalleryItemFileUpload

public MediaGalleryItemFileUpload(FileUpload file,
 String description,
 boolean spoiler)

Method Details

withDescription

@Nonnull
public MediaGalleryItem withDescription(@Nullable
 String description)

Description copied from interface: MediaGalleryItem

Creates a new MediaGalleryItem with the provided description.
The description is known as an "alternative text", and must not exceed 1024 characters.

Specified by:

withDescription in interface MediaGalleryItem

Parameters:

description - The new description

Returns:

The new MediaGalleryItem

withSpoiler

@Nonnull
public MediaGalleryItem withSpoiler(boolean spoiler)

Description copied from interface: MediaGalleryItem

Creates a new MediaGalleryItem with the provided spoiler status.
Spoilers are hidden until the user clicks on it.

Specified by:

withSpoiler in interface MediaGalleryItem

Parameters:

spoiler - The new spoiler status

Returns:

The new MediaGalleryItem

getUrl

@Nonnull
public String getUrl()

Description copied from interface: MediaGalleryItem

The URL of this item, this is always where the file originally came from.
This can be either attachment://filename.extension or an actual URL.

If you want to download the file, you should use MediaGalleryItem.getResolvedMedia() then ResolvedMedia.getProxy(), to avoid connecting your bot to unknown servers.

Specified by:

getUrl in interface MediaGalleryItem

Returns:

The URL of this item

getResolvedMedia

@Nullable
public ResolvedMedia getResolvedMedia()

Description copied from interface: MediaGalleryItem

The media resolved from this item, this is only available if you receive this component from Discord.

Specified by:

getResolvedMedia in interface MediaGalleryItem

Returns:

Possibly-null ResolvedMedia

getFiles

public Stream<FileUpload> getFiles()

Specified by:

getFiles in interface FileContainerMixin

getDescription

@Nullable
public String getDescription()

Description copied from interface: MediaGalleryItem

The description of this item, or null if none has been set.

Specified by:

getDescription in interface MediaGalleryItem

Returns:

Possibly-null description

isSpoiler

public boolean isSpoiler()

Description copied from interface: MediaGalleryItem

Whether this item is hidden until the user clicks on it.

Specified by:

isSpoiler in interface MediaGalleryItem

Returns:

true if this is hidden by default, false otherwise

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object