discord4j.core.object.entity

Class Attachment

java.lang.Object

discord4j.core.object.entity.Attachment

All Implemented Interfaces:

DiscordObject, Entity

public final class Attachment
extends Object
implements Entity

A Discord attachment.

See Also:

Attachment Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPOILER_PREFIX The prefix of the name of files which are displayed as spoilers.

Constructor Summary

Constructors

Constructor and Description
Attachment(GatewayDiscordClient gateway, discord4j.discordjson.json.AttachmentData data) Constructs an Attachment with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
GatewayDiscordClient	getClient() Returns the GatewayDiscordClient that created this object.
String	getFilename() Gets the name of the file attached.
OptionalInt	getHeight() Gets the height of the file, if present.
Snowflake	getId() Gets the Snowflake that uniquely identifies this entity.
String	getProxyUrl() Gets a proxied URL of the file.
int	getSize() Gets the size of the file in bytes.
String	getUrl() Gets the source URL of the file.
OptionalInt	getWidth() Gets the width of the file, if present.
int	hashCode()
boolean	isSpoiler() Gets whether the attachment is a spoiler.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SPOILER_PREFIX

public static final String SPOILER_PREFIX

The prefix of the name of files which are displayed as spoilers.

See Also:

Constant Field Values

Constructor Detail

Attachment

public Attachment(GatewayDiscordClient gateway,
                  discord4j.discordjson.json.AttachmentData data)

Constructs an Attachment with an associated ServiceMediator and Discord data.

Parameters:

gateway - The GatewayDiscordClient associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

Method Detail

getClient

public GatewayDiscordClient getClient()

Description copied from interface: DiscordObject

Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.

Specified by:

getClient in interface DiscordObject

Returns:

The GatewayDiscordClient associated to this object.

getId

public Snowflake getId()

Description copied from interface: Entity

Gets the Snowflake that uniquely identifies this entity.

Specified by:

getId in interface Entity

Returns:

The Snowflake that uniquely identifies this entity.

getFilename

public String getFilename()

Gets the name of the file attached.

Returns:

The name of the file attached.

getSize

public int getSize()

Gets the size of the file in bytes.

Returns:

The size of the file in bytes.

getUrl

public String getUrl()

Gets the source URL of the file.

Returns:

The source URL of the file.

getProxyUrl

public String getProxyUrl()

Gets a proxied URL of the file.

Returns:

A proxied URL of the file.

getHeight

public OptionalInt getHeight()

Gets the height of the file, if present.

Returns:

The height of the file, if present.

getWidth

public OptionalInt getWidth()

Gets the width of the file, if present.

Returns:

The width of the file, if present.

isSpoiler

public boolean isSpoiler()

Gets whether the attachment is a spoiler.

Returns:

true if the attachment is a spoiler, false otherwise.

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object