Package net.dv8tion.jda.internal.components.thumbnail

Class ThumbnailFileUpload

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.thumbnail.ThumbnailFileUpload

All Implemented Interfaces:

Component, IComponentUnion, SectionAccessoryComponent, SectionAccessoryComponentUnion, Thumbnail, SerializableData, FileContainerMixin

public class ThumbnailFileUpload
extends AbstractComponentImpl
implements Thumbnail, SectionAccessoryComponentUnion, FileContainerMixin

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.components.Component

Component.Type

Field Summary

Fields inherited from interface net.dv8tion.jda.api.components.thumbnail.Thumbnail

MAX_DESCRIPTION_LENGTH

Constructor Summary

Constructors

Constructor	Description
ThumbnailFileUpload(FileUpload file)

Method Summary

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

Methods inherited from class net.dv8tion.jda.internal.components.AbstractComponentImpl

asActionRow, asButton, asContainer, asEntitySelectMenu, asFileDisplay, asMediaGallery, asSection, asSeparator, asStringSelectMenu, asTextDisplay, asTextInput, asThumbnail

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.components.Component

isMessageCompatible, isModalCompatible

Methods inherited from interface net.dv8tion.jda.api.components.IComponentUnion

isUnknownComponent

Methods inherited from interface net.dv8tion.jda.api.components.section.SectionAccessoryComponentUnion

asButton, asThumbnail

Constructor Details

ThumbnailFileUpload

public ThumbnailFileUpload(FileUpload file)

Method Details

getType

@Nonnull
public Component.Type getType()

Description copied from interface: Component

The type of component.

Specified by:

getType in interface Component

Returns:

Component.Type

withUniqueId

@Nonnull
public ThumbnailFileUpload withUniqueId(int uniqueId)

Description copied from interface: Component

Creates a new component with the provided numeric ID.
If no ID is set, Discord will generate IDs incrementally starting from 1 and will not use existing IDs from the same message/modal.

Specified by:

withUniqueId in interface Component

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface SectionAccessoryComponent

Specified by:

withUniqueId in interface SectionAccessoryComponentUnion

Specified by:

withUniqueId in interface Thumbnail

Parameters:

uniqueId - The new ID; must be higher or equal to 1

Returns:

The new component

withDescription

@Nonnull
public Thumbnail withDescription(@Nullable
 String description)

Description copied from interface: Thumbnail

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

Specified by:

withDescription in interface Thumbnail

Parameters:

description - The new description

Returns:

The new Thumbnail

withSpoiler

@Nonnull
public Thumbnail withSpoiler(boolean spoiler)

Description copied from interface: Thumbnail

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

Specified by:

withSpoiler in interface Thumbnail

Parameters:

spoiler - The new spoiler status

Returns:

The new Thumbnail

getUniqueId

public int getUniqueId()

Description copied from interface: Component

The unique, numeric identifier of this component.
Can be set manually or automatically assigned by Discord (starting from 1). If it has not been assigned yet, this will return -1.

Note: Older messages may return 0.

Specified by:

getUniqueId in interface Component

Returns:

The unique identifier of this component, or -1 if not assigned yet, or 0 on older messages

getUrl

@Nonnull
public String getUrl()

Description copied from interface: Thumbnail

The URL of this thumbnail, 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 Thumbnail.getResolvedMedia() then ResolvedMedia.getProxy(), to avoid connecting your bot to unknown servers.

Specified by:

getUrl in interface Thumbnail

Returns:

The URL of this thumbnail

getFiles

public Stream<FileUpload> getFiles()

Specified by:

getFiles in interface FileContainerMixin

getResolvedMedia

@Nullable
public ResolvedMedia getResolvedMedia()

Description copied from interface: Thumbnail

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

Specified by:

getResolvedMedia in interface Thumbnail

Returns:

Possibly-null ResolvedMedia

getDescription

@Nullable
public String getDescription()

Description copied from interface: Thumbnail

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

Specified by:

getDescription in interface Thumbnail

Returns:

Possibly-null description

isSpoiler

public boolean isSpoiler()

Description copied from interface: Thumbnail

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

Specified by:

isSpoiler in interface Thumbnail

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