embed

Building an embed to send.

embed.new()
|> embed.title("glyde")
|> embed.description("A sans-IO Discord library for Gleam.")
|> embed.color(0x5865F2)
|> embed.field("Runs on", "Erlang", inline: True)

Setters replace, field appends. glyde/model/embed is the receive side, a different type because Discord rejects fields on send that it returns on receive.

Nothing here checks a length. Discord allows a 256 title, a 4096 description, 25 fields and 6000 characters overall.

Types

Embed

</>

Transparent, so a record update works as well as the pipeline.

pub type Embed {
  Embed(
    title: option.Option(String),
    description: option.Option(String),
    url: option.Option(String),
    timestamp: option.Option(String),
    color: option.Option(Int),
    footer: option.Option(EmbedFooter),
    image: option.Option(String),
    thumbnail: option.Option(String),
    author: option.Option(EmbedAuthor),
    fields: List(EmbedField),
  )
}

Constructors

Embed(
  title: option.Option(String),
  description: option.Option(String),
  url: option.Option(String),
  timestamp: option.Option(String),
  color: option.Option(Int),
  footer: option.Option(EmbedFooter),
  image: option.Option(String),
  thumbnail: option.Option(String),
  author: option.Option(EmbedAuthor),
  fields: List(EmbedField),
)

Arguments

timestamp: ISO-8601. glyde does not own a clock, so this is a string you supply.
color: 24-bit RGB, so 0x5865F2 is blurple.
image: Just the URL: Discord rejects height, width and proxy_url on send. Point it at attachment://<filename> to use a file uploaded in the same request.

EmbedAuthor

</>

pub type EmbedAuthor {
  EmbedAuthor(
    name: String,
    url: option.Option(String),
    icon_url: option.Option(String),
  )
}

Constructors

EmbedAuthor(
  name: String,
  url: option.Option(String),
  icon_url: option.Option(String),
)

EmbedField

</>

pub type EmbedField {
  EmbedField(name: String, value: String, inline: Bool)
}

Constructors

EmbedField(name: String, value: String, inline: Bool)

EmbedFooter

</>

pub type EmbedFooter {
  EmbedFooter(text: String, icon_url: option.Option(String))
}

Constructors

EmbedFooter(text: String, icon_url: option.Option(String))

Values

author

</>

pub fn author(embed: Embed, name: String) -> Embed

character_count

</>

pub fn character_count(embeds: List(Embed)) -> Int

What Discord counts against total_character_limit: title, description, footer text, author name, and every field name and value, over all the embeds a message carries. One embed on its own is character_count([it]).

color

</>

pub fn color(embed: Embed, rgb: Int) -> Embed

The colour of the bar down the left, as 24-bit RGB.

description

</>

pub fn description(embed: Embed, description: String) -> Embed

field

</>

pub fn field(
  embed: Embed,
  name: String,
  value: String,
  inline inline: Bool,
) -> Embed

Append a field. Discord shows up to three inline fields side by side and stacks the rest.

</>

pub fn footer(embed: Embed, text: String) -> Embed

image

</>

pub fn image(embed: Embed, url: String) -> Embed

new

</>

pub fn new() -> Embed

thumbnail

</>

pub fn thumbnail(embed: Embed, url: String) -> Embed

timestamp

</>

pub fn timestamp(embed: Embed, iso8601: String) -> Embed

ISO-8601, for the timestamp Discord renders in the footer.

title

</>

pub fn title(embed: Embed, title: String) -> Embed

to_json

</>

pub fn to_json(embed: Embed) -> json.Json

Public so a hand-rolled request can reuse it.

total_character_limit

</>

pub const total_character_limit: Int

Discord’s cap across every embed on one message, not per embed. In UTF-16 code units, so an emoji spends two of them.

url

</>

pub fn url(embed: Embed, url: String) -> Embed

Makes the title a link. Without a title it shows nothing.