/embed¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Spawn or edit embeds
/embed create¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Create and send an embed to a channel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
channel
|
Optional[TextChannel]
|
The channel you'd like the embed to be sent to. Defaults to the current channel. |
None
|
title
|
Optional[Range[str, 0, 256]]
|
The title you'd like the embed to have. |
None
|
description
|
Optional[Transform[Range[str, 0, 2000], TextTransformer]]
|
The description you'd like the embed to have. |
None
|
footer_text
|
Optional[Transform[Range[str, 0, 2000], TextTransformer]]
|
The text you'd like the footer to have. |
None
|
footer_icon_url
|
Optional[str]
|
The icon_url (image) you'd like the footer to have. |
None
|
author_text
|
Optional[Range[str, 0, 256]]
|
The text you'd like the author field to have. |
None
|
author_url
|
Optional[str]
|
The url you'd like the author field to have. |
None
|
author_icon_url
|
Optional[str]
|
The icon_url (image) you'd like the author to have. |
None
|
thumbnail_url
|
Optional[str]
|
The url for the thumbnail you'd like the embed to have. |
None
|
image_url
|
Optional[str]
|
The url for the image you'd like the embed to have. |
None
|
color
|
Optional[Transform[str, ColorTransformer]]
|
The color you'd like the embed to have. |
None
|
include_timestamp
|
Optional[ChoiceYesNo]
|
Whether to include a timestamp or not. Defaults to not. |
no
|
/embed edit¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Edit an embed created with the /embed create command.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
Transform[str, MessageTransformer]
|
A link to a message or a message ID of the embed you'd like to modify. |
required |
/embed clone¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Clones an embed to the current channel or a given channel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
Transform[Message, MessageTransformer]
|
A link to a message or a message ID of the embed you'd like to clone. |
required |
channel
|
Optional[TextChannel]
|
The channel the cloned embed needs to be sent to. Defaults to current channel. |
None
|
delete_original
|
Optional[ChoiceYesNo]
|
Whether to delete the original message or not. |
no
|
/embed export¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Exports an embed to json.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
Transform[str, MessageTransformer]
|
A link to a message or a message ID of the embed you'd like to export. |
required |
/embed import¶
Tip
This command requires the administrator permission by default.
To learn how to change this, please check the faq command.
Imports an embed from json.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_data
|
str
|
The json data of the embed you'd like to import. |
required |
channel
|
TextChannel
|
The channel the embed should get posted in. |
None
|