Class Embed

The embed builder for Guilded embeds.

Example

new Embed()
    .setTitle('Embed Title')
    .setDescription('This is the embed description.');

Hierarchy

Embed

Index

Constructors

constructor

new Embed(data?: APIEmbed): Embed
Parameters
- data: APIEmbed = {}
  
  The initial data of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:40

Properties

`Optional` author

author?: APIEmbedAuthor

The author of the embed.

`Optional` color

color?: number

The color of the embed.

`Optional` description

description?: string

The description of the embed.

fields

fields: APIEmbedField[]

The fields of the embed.

`Optional` footer

footer?: APIEmbedFooter

The footer of the embed.

`Optional` image

image?: APIEmbedMedia

The image of the embed.

`Optional` thumbnail

thumbnail?: APIEmbedMedia

The thumbnail of the embed.

`Optional` timestamp

timestamp?: Date

The timestamp of the embed.

`Optional` title

title?: string

The title of the embed.

`Optional` url

url?: string

The URL of the embed.

Methods

addField

addField(name: string, value: string, inline?: boolean): Embed
Add a field to the embed.

Returns
The embed builder.

Example
```
// Add a field to the embed.
embed.addField('Field Name', 'Field Value');
// Add a inline field to the embed.
embed.addField('Field Name', 'Field Value', true);
```
Parameters
- name: string
  
  The name of the field.
- value: string
  
  The value of the field.
- Optional inline: boolean
  
  Whether the field is inline.
Returns Embed
- Defined in builders/src/Embed.ts:182

setAuthor

setAuthor(author?: string | APIEmbedAuthor): Embed

Set the author of the embed.

Returns

The embed builder.

Example

// Set the author of the embed with a name.
embed.setAuthor('Author Name');
// Set the author of the embed with a name, icon, and URL.
embed.setAuthor({ name: 'Author Name', icon_url: 'https://example.com', url: 'https://example.com' });

Parameters

Optional author: string | APIEmbedAuthor

The author of the embed.

Returns Embed

setColor

setColor(color?: ColorResolvable): Embed

Set the color of the embed.

Returns

The embed builder.

Example

// Set the color of the embed with a hex color.
embed.setColor(0xFFFFFF);
embed.setColor('#FFFFFF');
// Set the color of the embed with a preset color.
embed.setColor('WHITE');
// Set the color of the embed with RGB values.
embed.setColor([255, 255, 255]);

Parameters

Optional color: ColorResolvable

The color of the embed.

Returns Embed

setDescription

setDescription(description?: string): Embed
Set the description of the embed.

Returns
The embed builder.

Example
```
embed.setDescription('This is the embed description.');
```
Parameters
- Optional description: string
  
  The description of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:70

setFields

setFields(fields?: APIEmbedField[]): Embed
Set the fields of the embed.

Returns
The embed builder.

Example
```
embed.setFields([{ name: 'Field Name', value: 'Field Value' }]);
```
Parameters
- fields: APIEmbedField[] = []
  
  The fields of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:193

setFooter

setFooter(text?: string, iconUrl?: string): Embed
Set the footer of the embed.

Returns
The embed builder.

Example
```
embed.setFooter('Footer Text', 'https://example.com');
```
Parameters
- Optional text: string
  
  The text of the footer.
- Optional iconUrl: string
  
  The icon URL of the footer.
Returns Embed
- Defined in builders/src/Embed.ts:111

setImage

setImage(imageUrl?: string): Embed
Set the image of the embed.

Returns
The embed builder.

Example
```
embed.setImage('https://example.com');
```
Parameters
- Optional imageUrl: string
  
  The image URL of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:150

setThumbnail

setThumbnail(thumbnailUrl?: string): Embed
Set the thumbnail of the embed.

Returns
The embed builder.

Example
```
embed.setThumbnail('https://example.com');
```
Parameters
- Optional thumbnailUrl: string
  
  The thumbnail URL of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:139

setTimestamp

setTimestamp(timestamp?: string | number | Date): Embed

Set the timestamp of the embed.

Returns

The embed builder.

Example

// Set the timestamp of the embed with an ISO 8601 date.
embed.setTimestamp('2022-01-01T00:00:00.000Z');
// Set the timestamp of the embed with a number of milliseconds since the epoch.
embed.setTimestamp(1640995200000);
// Set the timestamp of the embed with a Date object.
embed.setTimestamp(new Date('2022-01-01T00:00:00.000Z'));

Parameters

Optional timestamp: string | number | Date

The timestamp of the embed.

Returns Embed

setTitle

setTitle(title?: string): Embed
Set the title of the embed.

Returns
This embed builder.

Example
```
embed.setTitle('Embed Title');
```
Parameters
- Optional title: string
  
  The title of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:59

setUrl

setUrl(url?: string): Embed
Set the URL of the embed.

Returns
The embed builder.

Example
```
embed.setUrl('https://example.com');
```
Parameters
- Optional url: string
  
  The URL of the embed.
Returns Embed
- Defined in builders/src/Embed.ts:81

Class Embed

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: APIEmbed = {}

Returns Embed

Properties

Optional author

Optional color

Optional description

fields

Optional footer

Optional image

Optional thumbnail

Optional timestamp

Optional title

Optional url

Methods

addField

Returns

Example

Parameters

name: string

value: string

Optional inline: boolean

Returns Embed

setAuthor

Returns

Example

Parameters

Optional author: string | APIEmbedAuthor

Returns Embed

setColor

Returns

Example

Parameters

Optional color: ColorResolvable

Returns Embed

setDescription

Returns

Example

Parameters

Optional description: string

Returns Embed

setFields

Returns

Example

Parameters

fields: APIEmbedField[] = []

Returns Embed

setFooter

Returns

Example

Parameters

Optional text: string

Optional iconUrl: string

Returns Embed

setImage

Returns

Example

Parameters

Optional imageUrl: string

Returns Embed

setThumbnail

Returns

Example

Parameters

Optional thumbnailUrl: string

Returns Embed

setTimestamp

Returns

Example

Parameters

Optional timestamp: string | number | Date

`Optional` author

`Optional` color

`Optional` description

`Optional` footer

`Optional` image

`Optional` thumbnail

`Optional` timestamp

`Optional` title

`Optional` url

`Optional` inline: boolean

`Optional` author: string | APIEmbedAuthor

`Optional` color: ColorResolvable

`Optional` description: string

`Optional` text: string

`Optional` iconUrl: string

`Optional` imageUrl: string

`Optional` thumbnailUrl: string

`Optional` timestamp: string | number | Date

`Optional` title: string

`Optional` url: string