Embed

Этот тип данных используется для построения embed-сообщения (панели). Большинство методов возвращают этот же embed, поэтому можно строить цепочки вроде:

{% do channel
    .createEmbed()
    .withContent('Содержимое вне панели')
    .withTitle('Заголовок', 'https://juniper.bot')
    .withDescription('О! Привет!')
    .appendDescription('\nКак дела?')
    .withDate(1587713425964)
    .withColor('ffff00')
    .withThumbnail(member.avatarUrl)
    .withImage('https://i.pinimg.com/originals/a4/41/6e/a4416e024d691af3a2971e4114a6da7f.png')
    .withAuthor(member.nickname)
    .withFooter('Уф, пока!', member.avatarUrl)
    .addField('Первое поле', 'О, значение первого поля', true)
    .addField('Второе поле', 'Ну и здесь что-нибудь', true)
    .addReaction(':fox_face:')
    .addButton('LINK', 'https://juniper.bot/', 'Website', '🦊')
    .send()
%}

Свойства

Свойство	Тип	Описание
empty	Логический	Признак того, пустая ли сейчас панель
validLength	Логический	Признак того, допустимая ли длина содержимого панели для отправки в канал
length	Число	Возвращает длину содержимого панели

Методы

withContent(Текст)

---

Устанавливает текст, который будет отправлен вне панели.

Возвращаемые типы: Embed

withTitle(Наименование, URL)

---

Устанавливает наименование панели и опционально ссылку.

Возвращаемые типы: Embed

withAuthor(Имя, URL, IconURL)

---

Устанавливает имя автора, опционально ссылки на страницу и на иконку

Возвращаемые типы: Embed

withDescription(Текст)

---

Устанавливает содержимое панели (описание)

Возвращаемые типы: Embed

appendDescription(Текст)

---

Дописывает указанный текст к уже существующему содержимому панели (описанию)

Возвращаемые типы: Embed

withThumbnail(URL)

---

Устанавливает ссылку на картинку-миниатюру

Возвращаемые типы: Embed

withImage(URL)

---

Устанавливает ссылку на полноразмерную картинку

Возвращаемые типы: Embed

withColor(Цвет)

---

Устанавливает цвет панели, необходимо указывать шестизначный цвет в HEX, например #FF0000 для красного (можно без решетки).

https://htmlcolorcodes.com/

Возвращаемые типы: Embed

withDate(Дата)

---

Устанавливает дату в подвале (футере) панели.

Возвращаемые типы: Embed

withFooter(Текст, IconURL)

---

Устанавливает текст футера (подвала) и опционально ссылку на иконку

Возвращаемые типы: Embed

addField(Наименование, Значение, Однострочное)

---

Добавляет новое поле к панели, с указанным наименованием, значением и признаком однострочности.

Возвращаемые типы: Embed

addBlankField(Однострочное)

---

Добавляет пустое поле с указанным признаком однострочности.

Возвращаемые типы: Embed

addReaction(Эмоция)

---

Добавляет реакцию к сообщению. Работает аналогично функции reaction.

Возвращаемые типы: Embed

addButton(Стиль, URL_ID, Наименование, Эмоция, UUID, Отключена)

---

Добавляет кнопку к сообщению. Работает аналогично функции button.

Возвращаемые типы: Embed

addSelectMenu(Тип, ID, Наименование, UUID, Отключена)

---

Добавляет меню выбора к сообщению. Работает аналогично функции select_menu.

Возвращаемые типы: MenuBuilder

addComponentsRow()

---

Добавляет новый ряд компонентов сообщений.

Возвращаемые типы: Embed

withPoll(Вопрос, Срок, Мультиответ)

---

Добавляет опрос к сообщению.

Возвращаемые типы: Embed

addPollAnswer(Ответ, Эмоция)

---

Добавляет вариант ответа к опросу (до 10). Должно вызываться после withPoll.

Возвращаемые типы: Embed

clearFields()

---

Очищает все поля панели.

Возвращаемые типы: Embed

clear()

---

Очищает панель полностью.

Возвращаемые типы: Embed

error()

---

Предустанавливает панели красный цвет и заголовок ошибки (для удобства построения ошибок).

Возвращаемые типы: Embed

deleteAfterSec(Секунды)

---

Устанавливает время в секундах, через которое панель будет удалена после отправки.

Возвращаемые типы: Embed

preferEphemeral(Эфемерное)

---

Устанавливает, следует ли отправлять сообщение как эфемерное (персональное).

Работает только если действие вызвано интеракцией (слэш-командой, компонентом сообщения, меню, диалогом и т.п.), не отложенное и только для override!

Возвращаемые типы: Embed

editComponentMessage(Заменять)

---

Устанавливает, следует ли заменять исходное сообщение на текущее.

Работает только если действие вызвано компонентом сообщения или диалогом и только для override!

Возвращаемые типы: Embed

withAllowedMentions(Типы)

---

Устанавливает допустимые типы упоминаний.

Возвращаемые типы: Embed

pin(Закрепить)

---

Закрепляет сообщение.

Возвращаемые типы: Embed

unpin(Открепить)

---

Открепляет сообщение. Работает только в случае редактирования сообщения.

Возвращаемые типы: Embed

send()

---

Отправляет сообщение.

Возвращает true, если сообщение было успешно отправлено.

Возвращаемые типы: Логический

Внимание! Квота вызовов

У следующих методов методов общая квота вызовов в 2 раз(а) в рамках одного шаблоне:

• send
• sendAndGet
• update
• updateAndGet
• Channel#sendMessage
• Channel#sendMessageAndGet

sendAndGet()

---

Отправляет сообщение.

Возвращает объект полученного сообщения, если оно было успешно отправлено.

Возвращаемые типы: Message

Внимание! Квота вызовов

У следующих методов методов общая квота вызовов в 2 раз(а) в рамках одного шаблоне:

• send
• sendAndGet
• update
• updateAndGet
• Channel#sendMessage
• Channel#sendMessageAndGet

update(id)

---

Обновляет сообщение с указанным идентификатором.

Возвращает true, если сообщение было успешно отредактировано.

Можно редактировать только сообщения самого бота!

Возвращаемые типы: Логический

Внимание! Квота вызовов

У следующих методов методов общая квота вызовов в 2 раз(а) в рамках одного шаблоне:

• send
• sendAndGet
• update
• updateAndGet
• Channel#sendMessage
• Channel#sendMessageAndGet

updateAndGet(id)

---

Обновляет сообщение с указанным идентификатором.

Возвращает объект полученного сообщения, если сообщение было успешно отредактировано.

Можно редактировать только сообщения самого бота!

Возвращаемые типы: Message

Внимание! Квота вызовов

У следующих методов методов общая квота вызовов в 2 раз(а) в рамках одного шаблоне:

• send
• sendAndGet
• update
• updateAndGet
• Channel#sendMessage
• Channel#sendMessageAndGet