kord-common/dev.kord.common.entity/DiscordEmbed

DiscordEmbed

data class DiscordEmbed(val title: Optional<String> = Optional.Missing(), val type: Optional<EmbedType> = Optional.Missing(), val description: Optional<String> = Optional.Missing(), val url: Optional<String> = Optional.Missing(), val timestamp: Optional<Instant> = Optional.Missing(), val color: OptionalInt = OptionalInt.Missing, val footer: Optional<DiscordEmbed.Footer> = Optional.Missing(), val image: Optional<DiscordEmbed.Image> = Optional.Missing(), val thumbnail: Optional<DiscordEmbed.Thumbnail> = Optional.Missing(), val video: Optional<DiscordEmbed.Video> = Optional.Missing(), val provider: Optional<DiscordEmbed.Provider> = Optional.Missing(), val author: Optional<DiscordEmbed.Author> = Optional.Missing(), val fields: Optional<List<DiscordEmbed.Field>> = Optional.Missing())(source)

A representation of a Discord Embed structure.

Parameters

title

The title of the embed.

type

The type of the embed (always EmbedType.Rich for webhook embeds).

description

The description of the embed.

url

The url of the embed.

timestamp

The timestamp of the embed content.

color

The color code of the embed.

footer

The footer information.

image

The image information.

thumbnail

The thumbnail information.

video

The video information.

provider

The provider information.

author

The author information.

fields

The fields information.

Constructors

DiscordEmbed

constructor(title: Optional<String> = Optional.Missing(), type: Optional<EmbedType> = Optional.Missing(), description: Optional<String> = Optional.Missing(), url: Optional<String> = Optional.Missing(), timestamp: Optional<Instant> = Optional.Missing(), color: OptionalInt = OptionalInt.Missing, footer: Optional<DiscordEmbed.Footer> = Optional.Missing(), image: Optional<DiscordEmbed.Image> = Optional.Missing(), thumbnail: Optional<DiscordEmbed.Thumbnail> = Optional.Missing(), video: Optional<DiscordEmbed.Video> = Optional.Missing(), provider: Optional<DiscordEmbed.Provider> = Optional.Missing(), author: Optional<DiscordEmbed.Author> = Optional.Missing(), fields: Optional<List<DiscordEmbed.Field>> = Optional.Missing())

Types

Author

@Serializable

data class Author(val name: Optional<String> = Optional.Missing(), val url: Optional<String?> = Optional.Missing(), val iconUrl: Optional<String> = Optional.Missing(), val proxyIconUrl: Optional<String> = Optional.Missing())

A representation of a Discord Embed Author structure.

Field

@Serializable

data class Field(val name: String, val value: String, val inline: OptionalBoolean = OptionalBoolean.Missing)

A representation of a Discord Embed Field structure.

Footer

@Serializable

data class Footer(val text: String, val iconUrl: Optional<String> = Optional.Missing(), val proxyIconUrl: Optional<String> = Optional.Missing())

A representation of a Discord Embed Footer structure.

Image

@Serializable

data class Image(val url: Optional<String> = Optional.Missing(), val proxyUrl: Optional<String> = Optional.Missing(), val height: OptionalInt = OptionalInt.Missing, val width: OptionalInt = OptionalInt.Missing)

A representation of a Discord Embed Image structure.

Provider

@Serializable

data class Provider(val name: Optional<String> = Optional.Missing(), val url: Optional<String?> = Optional.Missing())

A representation of a Discord Embed Provider structure.

Thumbnail

@Serializable

data class Thumbnail(val url: Optional<String> = Optional.Missing(), val proxyUrl: Optional<String> = Optional.Missing(), val height: OptionalInt = OptionalInt.Missing, val width: OptionalInt = OptionalInt.Missing)

A representation of a Discord Embed Thumbnail structure.

Video

@Serializable

data class Video(val url: Optional<String> = Optional.Missing(), val height: OptionalInt = OptionalInt.Missing, val width: OptionalInt = OptionalInt.Missing)

A representation of a Discord Embed Video structure.