EmbedBuilder

class EmbedBuilder : SpecBuilder<EmbedCreateSpec>

Types

EmbedAuthor

class EmbedAuthor

Embed author field builder

EmbedField

class EmbedField

EmbedFooter

class EmbedFooter

Functions

author

fun author(authorSpec: EmbedBuilder.EmbedAuthor.() -> Unit)

fun author(name: String, url: String? = null, iconUrl: String? = null)

Sets the author for this embed.

build

open override fun build(): EmbedCreateSpec

Create the spec from this builder.

color

fun color(color: Color)

Sets the color for this embed.

description

fun description(description: String)

Sets the description for this embed.

field

fun field(fieldSpec: EmbedBuilder.EmbedField.() -> Unit)

fun field(name: String, value: String, inline: Boolean = false)

Adds a field to this embed.

footer

fun footer(footerSpec: EmbedBuilder.EmbedFooter.() -> Unit)

fun footer(text: String, icon: String? = null)

Sets the footer for this embed.

image

fun image(url: String)

Sets the image for this embed.

thumbnail

fun thumbnail(url: String)

Sets the thumbnail for this embed.

timestamp

fun timestamp(timestamp: Instant)

Sets the timestamp for this embed.

title

fun title(title: String)

Sets the title for this embed.

url

fun url(url: String)

Sets the url for this embed.

Properties

color

var color: Color

The color for this embed.

description

var description: String

The description for this embed.

image

var image: String

The image url for this embed.

imageUrl

~~var~~ ~~imageUrl~~: String

thumbnail

var thumbnail: String

The thumbnail url for this embed.

thumbnailUrl

~~var~~ ~~thumbnailUrl~~: String

timestamp

var timestamp: Instant

The timestamp for this embed.

title

var title: String

The title for this embed.

url

var url: String

The url for this embed.

Sources

jvm source