Embed

data class Embed(val data: EmbedData, val kord: Kord) : KordObject(source)

An instance of a Discord Embed.

Constructors

Embed

constructor(data: EmbedData, kord: Kord)

Types

Author

data class Author(val data: EmbedAuthorData, val kord: Kord) : KordObject

Field

data class Field(val data: EmbedFieldData, val kord: Kord) : KordObject

Footer

data class Footer(val data: EmbedFooterData, val kord: Kord) : KordObject

Image

data class Image(val data: EmbedImageData, val kord: Kord) : KordObject

Provider

data class Provider(val data: EmbedProviderData, val kord: Kord) : KordObject

Thumbnail

data class Thumbnail(val data: EmbedThumbnailData, val kord: Kord) : KordObject

Video

data class Video(val data: EmbedVideoData, val kord: Kord) : KordObject

Properties

author

val author: Embed.Author?

The embed author, if present.

color

val color: Color?

The color of the embed, if present.

data

val data: EmbedData

description

val description: String?

The description, if present.

fields

val fields: List<Embed.Field>

The embed fields.

footer

val footer: Embed.Footer?

The footer, if present.

image

val image: Embed.Image?

The image, if present.

kord

open override val kord: Kord

The kord instance that created this object.

provider

val provider: Embed.Provider?

The embed provider, if present.

thumbnail

val thumbnail: Embed.Thumbnail?

The thumbnail, if present.

timestamp

val timestamp: Instant?

The timestamp, if present. Unrelated to the creation time of the embed.

title

val title: String?

The title, if present.

type

val type: EmbedType?

The type of embed, if present. Always Rich for webhook embeds.

url

val url: String?

The title url, if present.

video

val video: Embed.Video?

The embedded video, if present.

Functions

apply

fun apply(builder: EmbedBuilder)

Applies this embed to the builder, copying its properties to it.

toString

open override fun toString(): String