Class EmbedBuilder`Internal`

A builder for embed fields

Remarks

Not meant to be constructed directly

See

Hierarchy

EmbedBuilder

Index

Constructors

Methods

author color description field footer image thumbnail timestamp title url

Constructors

constructor

new EmbedBuilder(): EmbedBuilder
Returns EmbedBuilder

Methods

author

author(author: APIEmbedAuthor): EmbedBuilder
Sets the author of the embed.
Parameters
- author: APIEmbedAuthor
  
  The author of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:98

color

color(color: number): EmbedBuilder
Sets the color of the embed.

Remarks
This is a decimal number representing the hexadecimal color code.
Parameters
- color: number
  
  The color of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:62

description

description(description: string): EmbedBuilder
Sets the description of the embed.
Parameters
- description: string
  
  The description of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:30

field

field(name: string, value: string, inline?: boolean): EmbedBuilder
Adds a field to the embed.
Parameters
- name: string
- value: string
- Optional inline: boolean
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:108

footer

footer(footer: APIEmbedFooter): EmbedBuilder
Sets the footer of the embed.
Parameters
- footer: APIEmbedFooter
  
  The footer of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:71

image

image(url: string): EmbedBuilder
Sets the image of the embed.
Parameters
- url: string
  
  The URL of the image.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:80

thumbnail

thumbnail(url: string): EmbedBuilder
Sets the thumbnail of the embed.
Parameters
- url: string
  
  The URL of the thumbnail.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:89

timestamp

timestamp(timestamp: string): EmbedBuilder
Sets the timestamp of the embed.
Parameters
- timestamp: string
  
  The timestamp of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:51

title

title(title: string): EmbedBuilder
Sets the title of the embed.
Parameters
- title: string
  
  The title of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:21

url

url(url: string): EmbedBuilder
Sets the URL of the embed.

Remarks
If set, the title of the embed will become a hyperlink to this URL.

See
title
Parameters
- url: string
  
  The URL of the embed.
Returns EmbedBuilder
- Defined in comity/builders/embeds.ts:42

Generated using TypeDoc