Embed | @klasa/core

Handles Embed creation and received embeds

Hierarchy

Embed

Implements

APIEmbedData

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Embed(data?: APIEmbedData): Embed

- Defined in src/lib/caching/structures/Embed.ts:99
Parameters
- Default value data: APIEmbedData = {}
Returns Embed

Properties

Optional author

author: APIEmbedAuthorData

The embed author data.

since: 0.0.1

Optional color

color: undefined | number

The embed bar color.

since: 0.0.1

Optional description

description: undefined | string

The embed description.

since: 0.0.1

fields

fields: APIEmbedFieldData[]

Embed Fields.

since: 0.0.1

Optional footer

footer: APIEmbedFooterData

The embed footer data.

since: 0.0.1

Optional image

image: APIEmbedImageData

The embed image data.

since: 0.0.1

Optional provider

provider: APIEmbedProviderData

Received data about the embed provider.

since: 0.0.1

Optional thumbnail

thumbnail: APIEmbedImageData

The embed thumbnail data.

since: 0.0.1

Optional timestamp

timestamp: undefined | string

The timestamp of the embed.

since: 0.0.1

Optional title

title: undefined | string

The embed title.

since: 0.0.1

Optional type

type: EmbedType

The type of embed.

since: 0.0.1

Optional url

url: undefined | string

The embed url.

since: 0.0.1

Optional video

video: APIEmbedVideoData

Received video data.

since: 0.0.1

Accessors

createdAt

get createdAt(): Date | null

- Defined in src/lib/caching/structures/Embed.ts:161
JS Date of the embed timestamp

Returns Date | null

hexColor

get hexColor(): string | null

- Defined in src/lib/caching/structures/Embed.ts:168
The color as hex

Returns string | null

Methods

addBlankField

addBlankField(inline?: undefined | false | true): this

- Defined in src/lib/caching/structures/Embed.ts:187
Adds a blank field to the embed

Parameters
- Optional inline: undefined | false | true
  
  If the field should be inline with other fields
Returns this

addField

addField(name: StringResolvable, value: StringResolvable, inline?: undefined | false | true): this

- Defined in src/lib/caching/structures/Embed.ts:178
Adds a field to the embed

Parameters
- name: StringResolvable
  
  The field name
- value: StringResolvable
  
  The field value
- Optional inline: undefined | false | true
  
  If the field should be inline with other fields
Returns this

setAuthor

setAuthor(name?: StringResolvable, iconURL?: StringResolvable, url?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:211
Sets the author with new data

Parameters
- Optional name: StringResolvable
  
  The author's name
- Optional iconURL: StringResolvable
  
  The icon url for the author
- Optional url: StringResolvable
  
  The url for clicking on the author
Returns this

setColor

setColor(color?: undefined | number): this

- Defined in src/lib/caching/structures/Embed.ts:232
Sets the color of the embed bar

Parameters
- Optional color: undefined | number
  
  The color to set the bar
Returns this

setDescription

setDescription(description?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:324
Sets the title of the embed

Parameters
- Optional description: StringResolvable
  
  The description you want
Returns this

setFooter

setFooter(text?: StringResolvable, iconURL?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:242
Sets the footer to new data

Parameters
- Optional text: StringResolvable
  
  The footer text
- Optional iconURL: StringResolvable
  
  The url for the footer icon
Returns this

setImage

setImage(url?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:262
Sets the image url you would like

Parameters
- Optional url: StringResolvable
  
  The url of the image
Returns this

setThumbnail

setThumbnail(url?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:280
Sets the image url you would like

Parameters
- Optional url: StringResolvable
  
  The url of the image
Returns this

setTimestamp

setTimestamp(timestamp?: number | Date): this

- Defined in src/lib/caching/structures/Embed.ts:298
Sets the timestamp for the Embed

Parameters
- Optional timestamp: number | Date
  
  The timestamp you want to set
Returns this

setTitle

setTitle(title?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:315
Sets the title of the embed

Parameters
- Optional title: StringResolvable
  
  The title you want
Returns this

setURL

setURL(url?: StringResolvable): this

- Defined in src/lib/caching/structures/Embed.ts:333
Sets the url of the embed

Parameters
- Optional url: StringResolvable
  
  The url to click on
Returns this

spliceField

spliceField(index: number, deleteCount: number, name?: StringResolvable, value?: StringResolvable, inline?: undefined | false | true): this

- Defined in src/lib/caching/structures/Embed.ts:199
Deletes and/or inserts fields by index in the embed

Parameters
- index: number
  
  The index to start at
- deleteCount: number
  
  How many fields to delete
- Optional name: StringResolvable
  
  The field name to insert
- Optional value: StringResolvable
  
  The field value to insert
- Optional inline: undefined | false | true
  
  If the inserted field is inline
Returns this

updateAuthor

updateAuthor(data: APIEmbedAuthorData): this

- Defined in src/lib/caching/structures/Embed.ts:223
Updates existing author data fields

Parameters
- data: APIEmbedAuthorData
  
  The fields you want to update
Returns this

updateFooter

updateFooter(data: APIEmbedFooterData): this

- Defined in src/lib/caching/structures/Embed.ts:253
Updates the footer to new data

Parameters
- data: APIEmbedFooterData
  
  The fields you want to update
Returns this

updateImage

updateImage(data: APIEmbedImageData): this

- Defined in src/lib/caching/structures/Embed.ts:271
Updates the image data you would like

Parameters
- data: APIEmbedImageData
  
  The fields you want to update
Returns this

updateThumbnail

updateThumbnail(data: APIEmbedImageData): this

- Defined in src/lib/caching/structures/Embed.ts:289
Updates the image data you would like

Parameters
- data: APIEmbedImageData
  
  The fields you want to update
Returns this

updateTimestamp

updateTimestamp(): this

- Defined in src/lib/caching/structures/Embed.ts:306
Sets the timestamp to now

Returns this

Static Private checkField

checkField(name: StringResolvable, value: StringResolvable, inline?: boolean): APIEmbedFieldData

- Defined in src/lib/caching/structures/Embed.ts:344
Checks for valid field input and resolves strings

Parameters
- name: StringResolvable
  
  The name of the field
- value: StringResolvable
  
  The value of the field
- Default value inline: boolean = false
  
  Set the field to display inline
Returns APIEmbedFieldData

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value data: APIEmbedData = {}

Returns Embed

Properties

Optional author

Optional color

Optional description

fields

Optional footer

Optional image

Optional provider

Optional thumbnail

Optional timestamp

Optional title

Optional type

Optional url

Optional video

Accessors

createdAt

Returns Date | null

hexColor

Returns string | null

Methods

addBlankField

Parameters

Optional inline: undefined | false | true

Returns this

addField

Parameters

name: StringResolvable

value: StringResolvable

Optional inline: undefined | false | true

Returns this

setAuthor

Parameters

Optional name: StringResolvable

Optional iconURL: StringResolvable

Optional url: StringResolvable

Returns this

setColor

Parameters

Optional color: undefined | number

Returns this

setDescription

Parameters

Optional description: StringResolvable

Returns this

setFooter

Parameters

Optional text: StringResolvable

Optional iconURL: StringResolvable

Returns this

setImage

Parameters

Optional url: StringResolvable

Returns this

setThumbnail

Parameters

Optional url: StringResolvable

Returns this

setTimestamp

Parameters

Optional timestamp: number | Date

Returns this

setTitle

Parameters

Optional title: StringResolvable

Returns this

setURL

Parameters

Optional url: StringResolvable