Package net.dv8tion.jda.internal.components.filedisplay

Class FileDisplayImpl

java.lang.Object

net.dv8tion.jda.internal.components.AbstractComponentImpl

net.dv8tion.jda.internal.components.filedisplay.FileDisplayImpl

All Implemented Interfaces:

Component, ContainerChildComponent, ContainerChildComponentUnion, FileDisplay, IComponentUnion, MessageTopLevelComponent, MessageTopLevelComponentUnion, SerializableData, FileContainerMixin

public class FileDisplayImpl
extends AbstractComponentImpl
implements FileDisplay, MessageTopLevelComponentUnion, ContainerChildComponentUnion, FileContainerMixin

Represents either an attachment:// link, or a deserialized file component

Nested Class Summary

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

Component.Type

Constructor Summary

Constructors

Constructor	Description
FileDisplayImpl(String url)
FileDisplayImpl(DataObject data)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Stream<FileUpload>	getFiles()
ResolvedMedia	getResolvedMedia()	The media resolved from this file, 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 file, this is always where the file originally came from.
int	hashCode()
boolean	isSpoiler()	Whether this file is hidden until the user clicks on it.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
FileDisplay	withSpoiler(boolean spoiler)	Creates a new FileDisplay with the provided spoiler status.
FileDisplayImpl	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.container.ContainerChildComponentUnion

asActionRow, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

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

isUnknownComponent

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

asActionRow, asContainer, asFileDisplay, asMediaGallery, asSection, asSeparator, asTextDisplay

Constructor Details

FileDisplayImpl

public FileDisplayImpl(DataObject data)

FileDisplayImpl

public FileDisplayImpl(String url)

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 FileDisplayImpl 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 ContainerChildComponent

Specified by:

withUniqueId in interface ContainerChildComponentUnion

Specified by:

withUniqueId in interface FileDisplay

Specified by:

withUniqueId in interface IComponentUnion

Specified by:

withUniqueId in interface MessageTopLevelComponent

Specified by:

withUniqueId in interface MessageTopLevelComponentUnion

Parameters:

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

Returns:

The new component

withSpoiler

@Nonnull
public FileDisplay withSpoiler(boolean spoiler)

Description copied from interface: FileDisplay

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

Specified by:

withSpoiler in interface FileDisplay

Parameters:

spoiler - The new spoiler status

Returns:

The new FileDisplay

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: FileDisplay

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

Specified by:

getUrl in interface FileDisplay

Returns:

The URL of this file

getResolvedMedia

@Nullable
public ResolvedMedia getResolvedMedia()

Description copied from interface: FileDisplay

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

Specified by:

getResolvedMedia in interface FileDisplay

Returns:

Possibly-null ResolvedMedia

getFiles

public Stream<FileUpload> getFiles()

Specified by:

getFiles in interface FileContainerMixin

isSpoiler

public boolean isSpoiler()

Description copied from interface: FileDisplay

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

Specified by:

isSpoiler in interface FileDisplay

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