Class: Embed

Constructor

new Embed()

Source: structures/Embed.js, line 17

Example

const { Embed } = require("interactions.js");

const embed = new Embed()
.setTitle('This is a Title')
.setURL('https://github.com/fb-sean/interactions.js')
.setColor('#31B505')
.setAuthor("This is a Author", null, "https://github.com/fb-sean/interactions.js");

Methods

addField(name, value, inline) → {Embed}

Add a field to the embed

You can have a maximum of 25 fields.

Parameters:

Name	Type	Default	Description
`name`	String		The field name
`value`	String		The field value
`inline`	Boolean	false	boolean if the embed should be inline

Source: structures/Embed.js, line 323

Returns:

Type:: Embed

addFields(ArrayOfFields) → {Embed}

Appends fields to the embed You can have a maximum of 25 fields.

Parameters:

Name	Type	Description
`ArrayOfFields`	Array	fields The fields to add

Source: structures/Embed.js, line 273

Returns:

Type:: Embed

Example

const embed = new Embed()
   .addFields(ArrayOfFields);

setAuthor(name, iconUrl, url) → {Embed}

Sets the author of this embed

Parameters:

Name	Type	Description
`name`	String	The name for the author
`iconUrl`	String	The icon url for the author
`url`	String	The url for the author

Source: structures/Embed.js, line 161

Returns:

Type:: Embed

setColor(color) → {Embed}

Sets the color of this embed

Parameters:

Name	Type	Description
`color`	String	The color of the embed

Source: structures/Embed.js, line 144

Returns:

Type:: Embed

setDescription(desc) → {Embed}

Sets the description of this embed

Parameters:

Name	Type	Description
`desc`	String	The description

Source: structures/Embed.js, line 188

Returns:

Type:: Embed

setFields(ArrayOfFields) → {Embed}

Sets the embed's fields You can set a maximum of 25 fields.

Parameters:

Name	Type	Description
`ArrayOfFields`	Array	fields The fields to set

Source: structures/Embed.js, line 225

Returns:

Type:: Embed

setFooter(text, iconUrl) → {Embed}

Sets the footer of this embed

Parameters:

Name	Type	Description
`text`	String	The name for the footer
`iconUrl`	String	The iconUrl for the footer

Source: structures/Embed.js, line 381

Returns:

Type:: Embed

setImage(url) → {Embed}

Sets the image of this embed

Parameters:

Name	Type	Description
`url`	String	The URL of the image

Source: structures/Embed.js, line 350

Returns:

Type:: Embed

setThumbnail(url) → {Embed}

Sets the thumbnail of this embed

Parameters:

Name	Type	Description
`url`	String	The URL of the thumbnail

Source: structures/Embed.js, line 207

Returns:

Type:: Embed

setTimestamp(timestamp) → {Embed}

Sets the timestamp of this embed

Parameters:

Name	Type	Description
`timestamp`	String	The timestamp or date

Source: structures/Embed.js, line 367

Returns:

Type:: Embed

setTitle(title) → {Embed}

Sets the title of this embed

Parameters:

Name	Type	Description
`title`	String	The title

Source: structures/Embed.js, line 114

Returns:

Type:: Embed

setURL(url) → {Embed}

Sets the URL of this embed

Parameters:

Name	Type	Description
`url`	String	The URL

Source: structures/Embed.js, line 129

Returns:

Type:: Embed