Skip to content

$getEmbed

$getEmbed will return properties about an given embed.

Usage

$getEmbed[channelID?;messageID?;index?;option?]

Parameters

FieldTypeDescriptionRequired
channelIDnumberID of the channel where the message is located in.true
messageIDnumberThe ID of the message that has an embed.true
indexnumberThe index of the embed.true
optionstringThe option to fetch.true

Options

TypeDescription
titleTitle of the embed.
descriptionDescription of the embed.
urlThe URL in the title.
colorColor of the embed.
timestampTimestamp located in the footer.
field(index).name / field1.nameField title.
field(index).value / field1.valueField description.
thumbnailThumbnail (image top right).
imageLarge image at the bottom.
videoVideo/GIF.
authornameAuthor content, above title field.
authorurlAuthor Icon Url, above title field besides author field.
footertextFooter text.
footericonFooter icon, besides footer.
filesAttached files.
createdAtCreation date of the embed.
hexColorHex color of the embed.
lengthLength of the embed.

Example(s)

This will return the description of an embed:

1
client.command({
2
name: "getEmbed",
3
code: `
4
$getEmbed[$channelID;messageID;1;description]
5
` // make sure to replace messageID with the actual message ID
6
});