@cofo/framework / Exports / Embed
# Class: Embed
# Table of contents
# Constructors
# Properties
# Methods
- addField
- addFields
- setAuthor
- setColor
- setDescription
- setFooter
- setImage
- setThumbnail
- setTimestamp
- setTitle
- setURL
# Constructors
# constructor
• new Embed(data?)
Create a new Embed
since 1.0.0
# Parameters
| Name | Type |
|---|---|
data? | EmbedOptions |
# Defined in
src/Structures/Embed.ts:24
# Properties
# author
• Optional author: EmbedAuthorOptions
# Defined in
src/Structures/Embed.ts:17
# color
• Optional color: number
# Defined in
src/Structures/Embed.ts:13
# description
• Optional description: string
# Defined in
src/Structures/Embed.ts:10
# fields
• fields: EmbedField[]
# Defined in
src/Structures/Embed.ts:18
# footer
• Optional footer: EmbedFooterOptions
# Defined in
src/Structures/Embed.ts:14
# image
• Optional image: EmbedImageOptions
# Defined in
src/Structures/Embed.ts:15
# thumbnail
• Optional thumbnail: EmbedImageOptions
# Defined in
src/Structures/Embed.ts:16
# timestamp
• Optional timestamp: string | Date
# Defined in
src/Structures/Embed.ts:12
# title
• Optional title: string
# Defined in
src/Structures/Embed.ts:9
# url
• Optional url: string
# Defined in
src/Structures/Embed.ts:11
# Methods
# addField
▸ addField(name, value, inline?): Embed
Add a field to embed
# Parameters
| Name | Type |
|---|---|
name | string | any[] |
value | string | any[] |
inline? | boolean |
# Returns
# Defined in
src/Structures/Embed.ts:171
# addFields
▸ addFields(fields): Embed
Add multiple fields to an embed
# Parameters
| Name | Type |
|---|---|
fields | EmbedField[] |
# Returns
# Defined in
src/Structures/Embed.ts:186
# setAuthor
▸ setAuthor(name, url, iconURL): Embed
Set the embed author
# Parameters
| Name | Type |
|---|---|
name | string | any[] |
url | undefined | string |
iconURL | undefined | string |
# Returns
# Defined in
src/Structures/Embed.ts:145
# setColor
▸ setColor(color): Embed
Set The Embed Color
# Parameters
| Name | Type |
|---|---|
color | string | number |
# Returns
# Defined in
src/Structures/Embed.ts:63
# setDescription
▸ setDescription(description): Embed
Set the Embed Description
# Parameters
| Name | Type |
|---|---|
description | string |
# Returns
# Defined in
src/Structures/Embed.ts:52
# setFooter
▸ setFooter(iconURL, text): Embed
Set The embed footer
# Parameters
| Name | Type |
|---|---|
iconURL | undefined | string |
text | string | any[] |
# Returns
# Defined in
src/Structures/Embed.ts:103
# setImage
▸ setImage(imageURL): Embed
Set The Embed Image
# Parameters
| Name | Type |
|---|---|
imageURL | string |
# Returns
# Defined in
src/Structures/Embed.ts:121
# setThumbnail
▸ setThumbnail(url): Embed
Set the embed thumbnail
# Parameters
| Name | Type |
|---|---|
url | string |
# Returns
# Defined in
src/Structures/Embed.ts:132
# setTimestamp
▸ setTimestamp(timestamp?): Embed
Set The Embed Timestamp
# Parameters
| Name | Type |
|---|---|
timestamp | Date |
# Returns
# Defined in
src/Structures/Embed.ts:92
# setTitle
▸ setTitle(title): Embed
Set the Embed Title
# Parameters
| Name | Type |
|---|---|
title | string |
# Returns
# Defined in
src/Structures/Embed.ts:41
# setURL
▸ setURL(url): Embed
Set The Embed URL
# Parameters
| Name | Type |
|---|---|
url | string |
# Returns
# Defined in
src/Structures/Embed.ts:81