kord-rest/dev.kord.rest.builder.message/EmbedBuilder

EmbedBuilder

class EmbedBuilder : RequestBuilder<EmbedRequest> (source)

A builder for discord embeds.

Inline Markdown links are supported in in all description-like fields.

Constructors

EmbedBuilder

constructor()

Types

Author

class Author : RequestBuilder<EmbedAuthorRequest>

Companion

object Companion

Field

class Field : RequestBuilder<EmbedFieldRequest>

Footer

class Footer : RequestBuilder<EmbedFooterRequest>

Limits

object Limits

Thumbnail

class Thumbnail : RequestBuilder<EmbedThumbnailRequest>

Properties

author

var author: EmbedBuilder.Author?

The author of the embed.

color

var color: Color?

The color of the embed.

description

var description: String?

The description of the embed. Limited to the length of Limits.description.

fields

var fields: MutableList<EmbedBuilder.Field>

The embed fields.

footer

var footer: EmbedBuilder.Footer?

The footer of the embed.

image

var image: String?

The image url of the embed.

thumbnail

var thumbnail: EmbedBuilder.Thumbnail?

The thumbnail of the embed.

timestamp

var timestamp: Instant?

The timestamp displayed at the bottom of the embed.

title

var title: String?

The title of the embed. Limited to the length of Limits.title.

url

var url: String?

The url of the embed's title.

Functions

author

inline fun author(builder: EmbedBuilder.Author.() -> Unit)

Adds or updates the author as configured by the builder.

field

inline fun field(builder: EmbedBuilder.Field.() -> Unit)

Adds a new Field configured by the builder.

inline fun field(name: String, inline: Boolean = false, value: () -> String = { ZERO_WIDTH_SPACE })

Adds a new Field using the given name and value.

footer

inline fun footer(builder: EmbedBuilder.Footer.() -> Unit)

Adds or updates the footer as configured by the builder.

thumbnail

inline fun thumbnail(builder: EmbedBuilder.Thumbnail.() -> Unit)

Adds or updates the thumbnail as configured by the builder.

toRequest

open override fun toRequest(): EmbedRequest