kord-core/dev.kord.core.entity/Attachment

Attachment

data class Attachment(val data: AttachmentData, val kord: Kord) : KordEntity(source)

An instance of a Discord Attachment.

A file attached to a Message.

Constructors

Attachment

constructor(data: AttachmentData, kord: Kord)

Properties

contentType

val contentType: String?

The attachment's media type.

data

val data: AttachmentData

description

val description: String?

The description for the file.

duration

val duration: Duration?

The duration of the audio file (currently for voice messages).

filename

val filename: String

The name of the file.

flags

val flags: AttachmentFlags?

The AttachmentFlags of this attachment.

height

val height: Int?

The height of the file, if it is an image.

open override val id: Snowflake

The unique identifier of this entity.

isEphemeral

val isEphemeral: Boolean

Whether this attachment is ephemeral.

isImage

val isImage: Boolean

If this file is an image. Denoted by the presence of a width and height.

isSpoiler

val isSpoiler: Boolean

If this file is displayed as a spoiler. Denoted by the SPOILER_ prefix in the name.

kord

open override val kord: Kord

The kord instance that created this object.

placeholder

val placeholder: String?

A thumbhash placeholder for the file, if it is an image or video.

placeholderVersion

val placeholderVersion: Int?

The version of the placeholder, if it is present.

proxyUrl

val proxyUrl: String

The proxied url of the file.

size

val size: Int

The size of the file in bytes.

url

val url: String

The url of the file.

waveform

val waveform: ByteArray?

A sampled waveform (currently for voice messages).

width

val width: Int?

The width of the file, if it is an image.

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toRawType

fun Attachment.toRawType(): DiscordAttachment

toString

open override fun toString(): String