Discord

Типы данных, используемые в шаблонном движке JuniperBot касательно данных Discord.

Guild#

Этот тип данных описывает все доступные данные о сервере.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор сервера
`name`	Строка	Имя сервера
`iconUrl`	Строка	Ссылка на иконку сервера
`afkTimeout`	Число	AFK таймаут голосового канала (в минутах)
`afkChannel`	VoiceChannel	AFK голосовой канал
`memberCount`	Число	Количество участников на сервере (включая ботов)
`userCount`	Число	Количество участников на сервере (без учёта ботов)
`botCount`	Число	Количество ботов на сервере
`createdAt`	DateTime	Дата и время создания сервера
`owner`	Member	Владелец сервера
`selfMember`	Member	Данные о самом боте на сервере
`boostCount`	Число	Количество бустов на сервере

Методы#

`getChannel(ID)`#

ОписаниеПараметры

Возвращает канал сервера по его id.

Возвращаемые типы: TextChannel, NewsChannel, VoiceChannel, StageChannel, ForumChannel

Параметр	Тип	Описание
`ID`	Число, Строка	Идентификатор канала

`getMember(ID)`#

ОписаниеПараметры

Возвращает участника сервера по его id.

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

Параметр	Тип	Описание
`ID`	Число, Строка	Идентификатор участника

`getRole(ID)`#

ОписаниеПараметры

Возвращает роль сервера по её id.

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

Параметр	Тип	Описание
`ID`	Число, Строка	Идентификатор роли

`clearAttributes(Ключ)`#

ОписаниеПараметры

Очищает атрибуты с указанным ключом у всех участников.

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

Это значит, что данный метод можно вызвать только 1¹ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Ключ`	Строка	Ключ атрибута для очистки

`clearAllAttributes()`#

Описание

Очищает все атрибуты у всех участников.

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

Это значит, что данный метод можно вызвать только 1¹ раз(а) в одном шаблоне.

Member#

Этот тип данных описывает все доступные данные об участнике сервера и операции над ним.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор участника
`mention`	Строка	Упоминание участника
`name`	Строка	Имя участника
`displayName`	Строка	Отображаемое имя участника
`nickname`	Строка	Никнейм участника на сервере (если установлен) или его оригинальное имя
`tag`	Строка	Полный тег участника в формате `Ник#1234`
`bot`	Логический	Признак, является ли указанный участник ботом
`moderator`	Логический	Признак, является ли указанный участник модератором сервера
`discriminator`	Строка	Дискриминатор участника (4 числа после #)
`joinedAt`	DateTime	Дата и время присоединения участника на сервер
`createdAt`	DateTime	Дата и время регистрации участника
`status`	Строка	Статус участника (В сети, Нет на месте, Не беспокоить, Оффлайн) с иконкой-эмоцией.
`avatarUrl`	Строка	Ссылка на аватар участника
`bio`	Строка	Информация об участнике, указанная в команде `!осебе`
`rank`	Rank	Данные о рейтинге участника на сервере
`roles`	Список<Role>	Список ролей участника
`guild`	Guild	Данные о сервере
`attributes`	AttributesStorage	Атрибуты участника
`activities`	Список<Activity>	Активности участника
`voiceState`	MemberVoiceState	Состояние подключения к голосовому каналу
`flags`	Список<UserFlag>	Флаги участника

Методы#

`hasRole(Роль)`#

ОписаниеПараметры

Проверяет, есть ли указанная роль у участника.

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

Параметр	Тип	Описание
`Роль`	Число, Role	Идентификатор роли или объект роли

`hasRoles(Роли)`#

ОписаниеПараметры

Проверяет, есть ли все указанные роли у участника.

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

Параметр	Тип	Описание
`Роли`	Список<Число>	Список идентификаторов ролей

`hasAnyRole(Роли)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Роли`	Список<Число>	Список идентификаторов ролей

`hasPermission(Название)`#

ОписаниеПараметры

Проверяет, есть ли у участника указанное право доступа (глобально).

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

Параметр	Тип	Описание
`Название`	Permission	Право доступа для проверки

`hasPermissions(Названия)`#

ОписаниеПараметры

Проверяет, есть ли у участника указанные права доступа (глобально).

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

Параметр	Тип	Описание
`Названия`	Список<Permission>	Права доступа для проверки

`hasPermission(Канал, Название)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Канал`	Число, TextChannel	Идентификатор роли или объект текстового канала
`Название`	Permission	Право доступа для проверки

`hasPermissions(Канал, Названия)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Канал`	Число, TextChannel	Идентификатор роли или объект текстового канала
`Названия`	Список<Permission>	Права доступа для проверки

`hasFlag(Флаг)`#

ОписаниеПараметры

Проверяет, есть ли у участника указанный флаг.

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

Параметр	Тип	Описание
`Флаг`	UserFlag	Флаг для проверки

`addRole(Роль)`#

ОписаниеПараметры

Выдает участнику указанную роль. Возвращает true, если набор ролей участника был изменён.

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роль`	Число, Role	Идентификатор роли или объект роли

`addRoles(Роли)`#

ОписаниеПараметры

Выдает участнику указанные роли. Возвращает true, если набор ролей участника был изменён.

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роли`	Список<Число>	Список идентификаторов ролей

`addTempRole(Роль, ДатаСнятия)`#

ОписаниеПараметры

Выдает участнику указанную роль временно. Возвращает true, если набор ролей участника был изменён (не менее 15 секунд).

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роль`	Число, Role	Идентификатор роли или объект роли
`ДатаСнятия`	DateTime, Число	Точная дата снятия или количество миллисекунд, на время которых надо выдать роль

`addTempRoles(Роли, ДатаСнятия)`#

ОписаниеПараметры

Выдает участнику указанные роли временно. Возвращает true, если набор ролей участника был изменён (не менее 15 секунд).

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роли`	Список<Число>	Список идентификаторов ролей
`ДатаСнятия`	DateTime, Число	Точная дата снятия или количество миллисекунд, на время которых надо выдать роли

`removeRole(Роль)`#

ОписаниеПараметры

Снимает с участника указанную роль. Возвращает true, если набор ролей участника был изменён.

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роль`	Число, Role	Идентификатор роли или объект роли

`removeRoles(Роли)`#

ОписаниеПараметры

Снимает с участника указанные роли. Возвращает true, если набор ролей участника был изменён.

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Роли`	Список<Число>	Список идентификаторов ролей

`modifyRoles(Добавить, Снять)`#

ОписаниеПараметры

Добавляет и снимает указанные роли у участника. Возвращает true, если набор ролей участника был изменён.

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

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

Это значит, что данный метод можно вызвать только 1² раз(а) в одном шаблоне.

Наличие бонусов на сервере позволит изменять роли двум разным участникам в рамках выполнения одного шаблона!

Параметр	Тип	Описание
`Добавить`	Список<Число>	Список идентификаторов ролей
`Снять`	Список<Число>	Список идентификаторов ролей

`modifyNickname(Имя)`#

ОписаниеПараметры

Изменяет никнейм участнику. Длина никнейма должна быть в диапазоне от 2 до 32 символов.
Возвращает true, если имя было успешно изменено.

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

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

Это значит, что данный метод можно вызвать только 1 раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Имя`	Строка	Новый никнейм участника

`getAttribute(Ключ)`#

ОписаниеПараметры

Получает указанный атрибут участника (хранимое значение).

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

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

Это значит, что данный метод можно вызвать только 5 (10 с бонусом) раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Ключ`	Строка	Ключ атрибута

MemberVoiceState#

Этот тип данных описывает состояние подключения участника к голосовому каналу.

Свойства#

Свойство	Тип	Описание
`inChannel`	Логический	Признак, подключен ли участник к голосовому каналу
`channel`	VoiceChannel	Голосовой канал, к которому подключен участник
`muted`	Логический	Признак, замьючен ли участник любым способом (сам или сервером)
`selfMuted`	Логический	Признак, замьючен ли участник самостоятельно
`guildMuted`	Логический	Признак, замьючен ли участник сервером
`deafened`	Логический	Признак, отключен ли участнику звук любым способом (сам или сервером)
`selfDeafened`	Логический	Признак, отключен ли звук участником самостоятельно
`guildDeafened`	Логический	Признак, отключен ли участнику звук сервером
`sendingVideo`	Логический	Признак, включена ли вебка у участника
`streaming`	Логический	Признак, стримит ли участник что-либо
`suppressed`	Логический	Признак, заглушен ли участник каналом (АФК-канал или участник является слушателем трибуны)

Методы#

`approveSpeaker()`#

Описание

Принимает запрос участника стать спикером канала и возвращает true при успехе операции. Для работы метода боту требуется право мьютить других участников в голосовом канале.

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

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

Это значит, что данный метод можно вызвать только 1³ раз(а) в одном шаблоне.

`declineSpeaker()`#

Описание

Отклоняет запрос участника стать спикером канала и возвращает true при успехе операции. Для работы метода боту требуется право мьютить других участников в голосовом канале.

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

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

Это значит, что данный метод можно вызвать только 1³ раз(а) в одном шаблоне.

`inviteSpeaker()`#

Описание

Приглашает участника стать спикером канала и возвращает true при успехе операции. Для работы метода боту требуется право мьютить других участников в голосовом канале.

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

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

Это значит, что данный метод можно вызвать только 1³ раз(а) в одном шаблоне.

Activity#

Этот тип данных описывает информацию об активности (статусе) участника сервера.

Свойства#

Свойство	Тип	Описание
`rich`	Логический	Признак является ли эта активность Rich Presence (подробной)
`type`	Строка	Тип активности (`STREAMING`, `LISTENING`, `WATCHING`, `CUSTOM_STATUS`, `COMPETING`)
`emoji`	Строка	Эмоция пользовательского статуса
`name`	Строка	Название активности
`url`	Строка	Ссылка активности (ссылка на стрим)
`startTime`	DateTime	Время начала активности
`endTime`	DateTime	Время окончания активности
`details`	Строка	Подробности активности (что участник делает)
`state`	Строка	Состояние активности (ищет игру, играет один, в группе и т.п.)
`largeImageUrl`	Строка	Ссылка на большую картинку активности
`largeImageText`	Строка	Текст, связанный с большой картинкой активности
`smallImageUrl`	Строка	Ссылка на маленькую картинку активности
`smallImageText`	Строка	Текст, связанный с маленькой картинкой активности

Rank#

Этот тип данных описывает данные о рейтинге участника на сервере.

Свойства#

Свойство	Тип	Описание
`level`	Число	Уровень участника
`remainingExp`	Число	Опыт, оставшийся до следующего уровня
`levelExp`	Число	Суммарный опыт, необходимый на текущем уровне
`levelCurrentExp`	Число	Опыт на текущем уровне
`totalExp`	Число	Всего опыта у участника
`rank`	Число	Ранг участника по серверу
`cookies`	Число	Количество печенек участника
`voiceActivity`	Строка	Длительность голосовой активности участника текстом
`voiceActivityMs`	Число	Длительность голосовой активности участника в миллисекундах

TextChannel#

Этот тип данных описывает все доступные данные о текстовом канале сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`position`	Число	Номер позиции канала в списке (1 — верх списка)
`parent`	Category	Категория канала (если есть)
`topic`	Строка	Описание (топик) канала
`canTalk`	Логический	Признак, может ли бот отправлять сообщения в этот канал

Методы#

`sendMessage(Текст)`#

ОписаниеПараметры

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Текст`	Строка	Текст сообщения

`createEmbed()`#

Описание

Создает новый конструктор панели (Embed)

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

NewsChannel#

Этот тип данных описывает все доступные данные о новостном канале сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`position`	Число	Номер позиции канала в списке (1 — верх списка)
`parent`	Category	Категория канала (если есть)
`topic`	Строка	Описание (топик) канала
`canTalk`	Логический	Признак, может ли бот отправлять сообщения в этот канал

Методы#

`sendMessage(Текст)`#

ОписаниеПараметры

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Текст`	Строка	Текст сообщения

`createEmbed()`#

Описание

Создает новый конструктор панели (Embed)

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

VoiceChannel#

Этот тип данных описывает все доступные данные о голосовом канале сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`position`	Число	Номер позиции канала в списке (1 — верх списка)
`parent`	Category	Категория канала (если есть)
`bitrate`	Число	Битрейт аудио в канале
`region`	Строка	Регион канала
`members`	Список<Member>	Список подключенных к каналу участников
`canTalk`	Логический	Признак, может ли бот отправлять сообщения в этот канал
`userLimit`	Число	Лимит участников в канале. `0` — без лимита.

Методы#

`sendMessage(Текст)`#

ОписаниеПараметры

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Текст`	Строка	Текст сообщения

`createEmbed()`#

Описание

Создает новый конструктор панели (Embed)

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

StageChannel#

Этот тип данных описывает все доступные данные о трибуне сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`position`	Число	Номер позиции канала в списке (1 — верх списка)
`parent`	Category	Категория канала (если есть)
`bitrate`	Число	Битрейт аудио в канале
`region`	Строка	Регион канала
`members`	Список<Member>	Список подключенных к каналу участников

ForumChannel#

Этот тип данных описывает все доступные данные о форуме сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`position`	Число	Номер позиции канала в списке (1 — верх списка)
`parent`	Category	Категория канала (если есть)
`topic`	Строка	Описание (топик) канала

Thread#

Этот тип данных описывает все доступные данные о ветке.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор канала
`createdAt`	DateTime	Дата и время создания канала
`name`	Строка	Название канала
`type`	Строка	Тип канала
`mention`	Строка	Упоминание канала
`guild`	Guild	Данные о сервере канала
`canTalk`	Логический	Признак, может ли бот отправлять сообщения в этот канал
`parent`	TextChannel, NewsChannel, ForumChannel	Канал ветки
`archived`	Логический	`true` если отправлена в архив
`invitable`	Логический	`true` если участники имеют возможность приглашать в ветку
`joined`	Логический	`true` если бот участвует в ветке
`locked`	Логический	`true` если ветка заблокирована
`pinned`	Логический	`true` если ветка прикреплена (только для публикаций форумов)
`public`	Логический	`true` если ветка является публичной
`owner`	Member	Создатель ветки
`memberCount`	Число	Количество участников, присоединившихся к ветке (учитываются не более 50)
`messageCount`	Число	Количество сообщений в ветке
`totalMessageCount`	Число	Количество сообщений в ветке, включая удалённые

Методы#

`sendMessage(Текст)`#

ОписаниеПараметры

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Текст`	Строка	Текст сообщения

`createEmbed()`#

Описание

Создает новый конструктор панели (Embed)

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

Category#

Этот тип данных описывает все доступные данные о категории (группы) каналов.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор категории
`name`	Строка	Название категории
`position`	Число	Номер позиции категории в списке (1 — верх списка)
`createdAt`	DateTime	Дата и время создание категории
`guild`	Guild	Данные о сервере категории

Role#

Этот тип данных описывает все доступные данные о роли сервера.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор роли
`name`	Строка	Название роли
`iconUrl`	Строка	Ссылка на иконку роли
`position`	Число	Номер позиции роли
`createdAt`	DateTime	Дата и время создания роли
`permissionsRaw`	Число	Числовое представление всех прав доступа этой роли
`managed`	Логический	Признак того, управляется ли эта роль интеграцией
`hoisted`	Логический	Признак того, отображаются ли участники с этой ролью отдельно в списке участников
`publicRole`	Логический	Признак того, является ли эта роль публичной ролью `@everyone`
`color`	Строка	Цвет роли в формате `#RRGGBB`
`guild`	Guild	Данные о сервере роли

Методы#

`hasPermission(Название)`#

ОписаниеПараметры

Проверяет, есть ли у роли указанное право доступа (глобально).

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

Параметр	Тип	Описание
`Название`	Permission	Право доступа для проверки

`hasPermissions(Названия)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Названия`	Список<Permission>	Права доступа для проверки

`hasPermission(Канал, Название)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Канал`	Число, TextChannel	Идентификатор или объект текстового канала
`Название`	Permission	Право доступа для проверки

`hasPermissions(Канал, Названия)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Канал`	Число, TextChannel	Идентификатор или объект текстового канала
`Названия`	Список<Permission>	Права доступа для проверки

Message#

Этот тип данных описывает все доступные данные о сообщении в текстовом канале.

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор сообщения
`contentRaw`	Строка	Содержимое сообщения без какой-либо обработки (как его прислал Discord)
`contentDisplay`	Строка	Содержимое сообщения, где все коды каналов, эмоций и упоминаний заменены их наименованиями
`contentStripped`	Строка	Содержимое сообщения как `contentDisplay`, но дополнительно еще и без какого-либо форматирования
`jumpUrl`	Строка	Ссылка быстрого перехода на это сообщение
`channel`	TextChannel	Канал, в котором опубликовано это сообщение
`guild`	Guild	Данные о сервере сообщения
`author`	Member	Автор этого сообщения
`createdAt`	DateTime	Дата и время создания сообщения
`mentionedMembers`	Список<Member>	Список упоминаний участников в сообщении
`mentionedChannels`	Список<TextChannel>	Список упоминаний каналов в сообщении
`mentionedRoles`	Список<Role>	Список упоминаний ролей в сообщении
`attachments`	Список<Attachment>	Список вложений к сообщению
`referencedMessage`	Message	Отвеченное сообщение (reply)

Методы#

`delete()`#

Описание

Удаляет это сообщение

`pin()`#

Описание

Закрепляет это сообщение. Возвращает true если успешно.

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

`unpin()`#

Описание

Открепляет это сообщение. Возвращает true если успешно.

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

Attachment#

Этот тип данных описывает данные о вложении сообщения (файлы, картинки, видео).

Свойства#

Свойство	Тип	Описание
`id`	Число	Уникальный идентификатор вложения
`createdAt`	DateTime	Дата и время создание вложения
`url`	Строка	Ссылка на вложение
`proxyUrl`	Строка	Ссылка на вложение через Discord CDN прокси
`fileName`	Строка	Имя загруженного файла
`size`	Число	Размер файла в байтах
`height`	Число	Высота картинки/видео. `-1` для остальных типов файлов
`width`	Число	Ширина картинки/видео. `-1` для остальных типов файлов

Embed#

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

withTitle('Заголовок').withDescription('Описание')

Свойства#

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

Методы#

`withContent(Текст)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Текст`	Строка	Содержимое сообщения

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Наименование`	Строка	Содержимое заголовка
`URL`	Строка	Ссылка в заголовке (опционально)

`withAuthor(Имя, URL, IconURL)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Имя`	Строка	Имя автора
`URL`	Строка	Ссылка на автора
`IconURL`	Строка	Ссылка на иконку автора

`withDescription(Текст)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Текст`	Строка	Содержимое описания эмбеда

`appendDescription(Текст)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Текст`	Строка	Содержимое описания эмбеда

`withThumbnail(URL)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`URL`	Строка	Ссылка на картинку-миниатюру

`withImage(URL)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`URL`	Строка	Ссылка на полноразмерную картинку

`withColor(Цвет)`#

ОписаниеПараметры

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

https://htmlcolorcodes.com/

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

Параметр	Тип	Описание
`Цвет`	Строка	Цвет панели в HEX

`withDate(Дата)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Дата`	Строка, Число, DateTime	Принимает: Число (Unix timestamp); Строку в формате: `yyyy-MM-dd'T'HH:mm:ss.SSSZ` Дату из других типов

`withFooter(Текст, IconURL)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Текст`	Строка	Содержимое футера (подвала)
`IconURL`	Строка	Ссылка на иконку в футере (подвале) (Опционально)

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Наименование`	Строка	Содержимое наименования (заголовка) поля
`Значение`	Строка	Содержимое значения (описания) поля
`Однострочное`	Логический	Если `true`, то поле будет однострочным

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Однострочное`	Логический	Если `true`, то поле будет однострочным

`addReaction(Эмоция)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Эмоция`	Строка	Эмоция в одно из следующих форматах: `🦊` — Unicode-символ эмоции; `:fox_face:` — название эмоции, включая стандартные и пользовательские на сервере; `<a:foxwaggy:695917473874051112>` — код пользовательской эмоции.

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Стиль`	Строка	Стиль кнопки: `LINK` — Кнопка-ссылка серого цвета, используется для открытия веб-страниц; `PRIMARY` — Основная кнопка синего цвета, обычно используется для подтверждения какой-либо операции; `SECONDARY` — Вторичная кнопка серого цвета, используется как отмена или для редко используемых операций; `SUCCESS` — Кнопка зелёного цвета, используется для выполнения какой-либо положительной операции; `DANGER` — Кнопка красного цвета, используется для выполнения какой-либо деструктивной операции.
`URL_ID`	Строка	URL для кнопки-ссылки, для остальных видов кнопок уникальный идентификатор
`Наименование`	Строка	Наименование кнопки
`Эмоция`	Строка	Эмоция в одном из следующих форматах: `🦊` — Unicode-символ эмоции; `:fox_face:` — название эмоции, включая стандартные и пользовательские на сервере; `<a:foxwaggy:695917473874051112>` — код пользовательской эмоции. (Опционально)
`UUID`	Строка	UUID Действия для выполнения (Требуется для всех видов кнопок, кроме кнопки-ссылки)
`Отключена`	Логический	Если `true`, кнопка будет отключенной

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Вопрос`	Строка	Вопрос данного опроса
`Срок`	Число	Срок данного опроса в миллисекундах. Допустимые значения от 1 часа до 1 недели. Опционально, сутки если не указано.
`Мультиответ`	Логический	Если `true`, опрос будет допускать несколько ответов. Опционально, `false` если не указано.

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Ответ`	Строка	Текст варианта ответа
`Эмоция`	Строка	Эмоция в одном из следующих форматах: `🦊` — Unicode-символ эмоции; `:fox_face:` — название эмоции, включая стандартные и пользовательские на сервере; `<a:foxwaggy:695917473874051112>` — код пользовательской эмоции. (Опционально)

`clearFields()`#

Описание

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

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

`clear()`#

Описание

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

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

`error()`#

Описание

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

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

`deleteAfterSec(Секунды)`#

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Секунды`	Число	Время в секундах, через которое панель будет удалена после отправки

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

ОписаниеПараметры

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

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

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

Параметр	Тип	Описание
`Эфемерное`	Логический	Если `true`, то сообщение будет эфемерным если это возможно

`editComponentMessage(Заменять)`#

ОписаниеПараметры

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

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

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

Параметр	Тип	Описание
`Заменять`	Логический	Если `true`, то исходное сообщение будет заменено на текущее

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Закрепить`	Логический	Если `true`, то сообщение будет закреплено

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

ОписаниеПараметры

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

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

Параметр	Тип	Описание
`Открепить`	Логический	Если `true`, то сообщение будет откреплено

`send()`#

Описание

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

`update(id)`#

ОписаниеПараметры

Обновляет сообщение с указанным идентификатором на эту панель.
Возвращает true, если сообщение было успешно отредактировано.

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

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

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

Это значит, что данный метод можно вызвать только 2⁴ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`id`	Число	Идентификатор сообщения

AttributesStorage#

Это динамический тип, свойствами которого являются соответствующие атрибуты участника.

Внимание

В рамках выполнения одного шаблона сообщения допускается обращение максимум к 5 атрибутам участника.

Активный бонус на сервере увеличивает этот лимит до 10 атрибутов.

Attribute#

Этот тип данных описывает атрибут участника. С помощью атрибутов можно хранить какие-либо собственные привязанные к участникам данные.

Свойства#

Свойство	Тип	Описание
`value`	Строка	Текущее значение атрибута
`updatedAt`	DateTime	Дата последнего обновления атрибута

Методы#

`update(Значение)`#

ОписаниеПараметры

Обновляет значение атрибута указанной строкой, числом или логическим значением. Максимальная длина значения 2000 символов. Возвращает это же значение.

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

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

Это значит, что данный метод можно вызвать только 1⁵ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Значение`	Строка, Число, Логический	Новое значение атрибута

`increment(Число)`#

ОписаниеПараметры

Увеличивает числовое значение на указанное число. Возвращает новое значение. Отсчет начинается с 0 если текущее хранимое значение не число.

Возвращаемые типы: Число

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

Это значит, что данный метод можно вызвать только 1⁵ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Число`	Число	Увеличить числовое значение на указанное число

`decrement(Число)`#

ОписаниеПараметры

Уменьшает числовое значение на указанное число. Возвращает новое значение. Отсчет начинается с 0 если текущее хранимое значение не число.

Возвращаемые типы: Число

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

Это значит, что данный метод можно вызвать только 1⁵ раз(а) в одном шаблоне.

Параметр	Тип	Описание
`Число`	Число	Уменьшить числовое значение на указанное число

`clear()`#

Описание

Очищает атрибут и удаляет из базы данных.

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

Это значит, что данный метод можно вызвать только 1 раз(а) в одном шаблоне.

Arguments#

Этот тип данных описывает аргументы и параметры вызова пользовательской команды.

Свойства#

Свойство	Тип	Описание
`value`	Строка	Исходная строка вызова пользовательской команды
`args`	Список<Строка>	Список аргументов, извлеченных из строки и разделенных пробелом
`targetMember`	Member	При вызове текстовой командой — первый упомянутый участник или участник с id, указанным первым аргументом; При вызове контекстным меню участника — владелец меню; При вызове контекстным меню сообщения — автор этого сообщения; При вызове слэш-командой — указанный участник в любом из параметров.

Методы#

`get(Номер)`#

ОписаниеПараметры

Получение аргумента по указанному номеру.

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

Параметр	Тип	Описание
`Номер`	Число	Номер аргумента

`after(Номер)`#

ОписаниеПараметры

Получение всех аргументов, начиная с указанного номера включительно.

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

Параметр	Тип	Описание
`Номер`	Число	Номер аргумента

`before(Номер)`#

ОписаниеПараметры

Получение всех аргументов от первого до указанного включительно.

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

Параметр	Тип	Описание
`Номер`	Число	Номер аргумента

`range(Начало, Конец)`#

ОписаниеПараметры

Получение диапазона аргументов.

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

Параметр	Тип	Описание
`Начало`	Число	Начало диапазона
`Конец`	Число	Конец диапазона

`getOption(Название)`#

ОписаниеПараметры

Получение параметра слэш-команды по названию.

Возвращаемые типы: Строка, Число, Логический, Member, Role, TextChannel, VoiceChannel, Category, Attachment

Параметр	Тип	Описание
`Название`	Строка	Название параметра

`getOptionsByType(Тип)`#

ОписаниеПараметры

Получение списка параметров слэш-команды по их типу.

Возвращаемые типы: Список<Строка>, Список<Число>, Список<Логический>, Список<Member>, Список<Role>, Список<TextChannel>, Список<VoiceChannel>, Список<Category>, Список<Attachment>

Параметр	Тип	Описание
`Тип`	Строка	Тип параметра (`STRING`, `INTEGER`, `DECIMAL`, `BOOLEAN`, `MEMBER`, `ROLE`, `CHANNEL`, `MENTIONABLE`, `ATTACHMENT`)

Информация

Отсчет номера аргумента начинается с 1.

Parameters#

Этот тип данных описывает информацию о параметрах действий пользовательских команд.

Свойства#

Этот тип данных использует динамический список свойств в зависимости от переданных в действие параметров методом store или тегом run.

Методы#

`get(Ключ)`#

ОписаниеПараметры

Возвращает значение параметра по его ключу.

Возвращаемые типы: Строка, Число

Параметр	Тип	Описание
`Ключ`	Строка	Ключ параметра

`store(Ключ, Значение)`#

ОписаниеПараметры

Сохраняет указанное значение в текущий контекст параметров.

Параметр	Тип	Описание
`Ключ`	Строка	Ключ параметра
`Значение`	Строка, Число	Значение параметра

Информация

В параметрах можно передавать только числа и строки.

Внимание

Время жизни передаваемых из действия в компоненты параметров — 15 минут с момента последнего обращения к ним!

Component#

Этот тип данных описывает информацию о компонентах действий пользовательских команд.

Свойства#

Свойство	Тип	Описание
`id`	Строка	Идентификатор компонента
`type`	Строка	Тип компонента: `BUTTON` — компонент кнопки; `SELECTION_MENU` — компонент меню выбора.
`selectedOptions`	Список<Строка>	Список указанных вариантов выбора компонента меню.

Этот тип данных описывает информацию о диалоговых окнах действий пользовательских команд.

Свойство	Тип	Описание
`values`	Карта<Строка, Строка>	Карта, содержащая идентификаторы компонентов в качестве ключей и их представленные значения соответственно

Permission#

Здесь описан список всех возможных прав доступа. Их нужно передавать в методы как строки.

Право доступа	Описание
`MANAGE_CHANNEL`	Управлять каналами
`MANAGE_SERVER`	Управлять сервером
`VIEW_AUDIT_LOGS`	Просматривать журнал аудита
`VIEW_CHANNEL`	Просматривать каналы
`VIEW_GUILD_INSIGHTS`	Просмотр аналитики сервера
`MANAGE_ROLES`	Управлять ролями
`MANAGE_PERMISSIONS`	Управлять правами доступа
`MANAGE_WEBHOOKS`	Управлять вебхуками
`MANAGE_GUILD_EXPRESSIONS`	Управлять выражениями
`MANAGE_EVENTS`	Управлять событиями
`USE_EMBEDDED_ACTIVITIES`	Использовать активности
`VIEW_CREATOR_MONETIZATION_ANALYTICS`	Просматривать аналитику монетизации
`CREATE_INSTANT_INVITE`	Создание приглашения
`KICK_MEMBERS`	Выгонять участников
`BAN_MEMBERS`	Банить участников
`NICKNAME_CHANGE`	Изменить никнейм
`NICKNAME_MANAGE`	Управлять никнеймами
`MODERATE_MEMBERS`	Отправить участников подумать о своём поведении
`MESSAGE_ADD_REACTION`	Добавлять реакции
`MESSAGE_SEND`	Отправка сообщений и создание публикаций
`MESSAGE_TTS`	Отправка сообщений Text-to-Speech
`MESSAGE_MANAGE`	Управлять сообщениями
`MESSAGE_EMBED_LINKS`	Встраивать ссылки
`MESSAGE_ATTACH_FILES`	Прикреплять файлы
`MESSAGE_HISTORY`	Читать историю сообщений
`MESSAGE_MENTION_EVERYONE`	Упоминание everyone, here и всех ролей
`MESSAGE_EXT_EMOJI`	Использовать внешние эмодзи
`USE_APPLICATION_COMMANDS`	Использовать команды приложения
`MESSAGE_EXT_STICKER`	Использовать внешние стикеры
`MESSAGE_ATTACH_VOICE_MESSAGE`	Отправлять голосовые сообщения
`USE_EXTERNAL_APPLICATIONS`	Использовать внешние приложения
`MANAGE_THREADS`	Управление ветками и публикациями
`CREATE_PUBLIC_THREADS`	Создать публичные ветки
`CREATE_PRIVATE_THREADS`	Создание приватных веток
`MESSAGE_SEND_IN_THREADS`	Отправлять сообщения в ветках и публикациях
`PRIORITY_SPEAKER`	Приоритетный режим
`VOICE_STREAM`	Видео
`VOICE_CONNECT`	Подключаться
`VOICE_SPEAK`	Говорить
`VOICE_MUTE_OTHERS`	Отключать участникам микрофон
`VOICE_DEAF_OTHERS`	Отключать участникам звук
`VOICE_MOVE_OTHERS`	Перемещать участников
`VOICE_USE_VAD`	Использовать режим активации по голосу
`VOICE_START_ACTIVITIES`	Использовать активности
`VOICE_USE_SOUNDBOARD`	Использовать звуковую панель
`VOICE_USE_EXTERNAL_SOUNDS`	Использовать внешние звуки
`VOICE_SET_STATUS`	Задать статус голосового канала
`REQUEST_TO_SPEAK`	Попросить выступить
`ADMINISTRATOR`	Администратор

UserFlag#

Флаги участника. Их названия нужно передавать в методы как строки.

Название	Описание
`STAFF`	Сотрудник дискорда
`PARTNER`	Владелец партнёрского сервера
`HYPESQUAD`	HyperSquad ивенты
`BUG_HUNTER_LEVEL_1`	Bug Hunter 1 уровня
`BUG_HUNTER_LEVEL_2`	Bug Hunter 2 уровня
`HYPESQUAD_BRAVERY`	HypeSquad Bravery
`HYPESQUAD_BRILLIANCE`	HypeSquad Brilliance
`HYPESQUAD_BALANCE`	HypeSquad Balance
`EARLY_SUPPORTER`	Ранее поддержавшие
`TEAM_USER`	Team User
`VERIFIED_BOT`	Верифицированный бот
`VERIFIED_DEVELOPER`	Первопроходец - верифицированный разработчик бота
`CERTIFIED_MODERATOR`	Сертифицированный модератор дискорда
`ACTIVE_DEVELOPER`	Активный разработчик

У всех методов очистки атрибутов общий счётчик квоты вызовов. ↩↩
У всех методов изменения ролей общий счётчик квоты вызовов. ↩↩↩↩↩↩↩
У всех методов изменения голосового состояния общий счётчик квоты вызовов. ↩↩↩
У всех методов отправки сообщений общий счётчик квоты вызовов. ↩↩↩↩↩↩
У всех методов обновления значения общий счётчик квоты вызовов (в рамках одного атрибута). ↩↩↩

Discord

Guild#

Свойства#

Методы#

getChannel(ID)#

getMember(ID)#

getRole(ID)#

clearAttributes(Ключ)#

clearAllAttributes()#

Member#

Свойства#

Методы#

hasRole(Роль)#

hasRoles(Роли)#

hasAnyRole(Роли)#

hasPermission(Название)#

hasPermissions(Названия)#

hasPermission(Канал, Название)#

hasPermissions(Канал, Названия)#

hasFlag(Флаг)#

addRole(Роль)#

addRoles(Роли)#

addTempRole(Роль, ДатаСнятия)#

addTempRoles(Роли, ДатаСнятия)#

removeRole(Роль)#

removeRoles(Роли)#

modifyRoles(Добавить, Снять)#

modifyNickname(Имя)#

getAttribute(Ключ)#

MemberVoiceState#

Свойства#

Методы#

approveSpeaker()#

declineSpeaker()#

inviteSpeaker()#

Activity#

Свойства#

Rank#

Свойства#

TextChannel#

Свойства#

Методы#

sendMessage(Текст)#

createEmbed()#

NewsChannel#

Свойства#

Методы#

sendMessage(Текст)#

createEmbed()#

VoiceChannel#

Свойства#

Методы#

sendMessage(Текст)#

createEmbed()#

StageChannel#

Свойства#

ForumChannel#

Свойства#

Thread#

Свойства#

Методы#

sendMessage(Текст)#

createEmbed()#

Category#

Свойства#

Role#

Свойства#

Методы#

hasPermission(Название)#

hasPermissions(Названия)#

hasPermission(Канал, Название)#

hasPermissions(Канал, Названия)#

Message#

Свойства#

Методы#

delete()#

pin()#

unpin()#

Attachment#

Свойства#

`getChannel(ID)`#

`getMember(ID)`#

`getRole(ID)`#

`clearAttributes(Ключ)`#

`clearAllAttributes()`#

`hasRole(Роль)`#

`hasRoles(Роли)`#

`hasAnyRole(Роли)`#

`hasPermission(Название)`#

`hasPermissions(Названия)`#

`hasPermission(Канал, Название)`#

`hasPermissions(Канал, Названия)`#

`hasFlag(Флаг)`#

`addRole(Роль)`#

`addRoles(Роли)`#

`addTempRole(Роль, ДатаСнятия)`#

`addTempRoles(Роли, ДатаСнятия)`#

`removeRole(Роль)`#

`removeRoles(Роли)`#

`modifyRoles(Добавить, Снять)`#

`modifyNickname(Имя)`#

`getAttribute(Ключ)`#

`approveSpeaker()`#

`declineSpeaker()`#

`inviteSpeaker()`#

`sendMessage(Текст)`#

`createEmbed()`#

`sendMessage(Текст)`#

`createEmbed()`#

`sendMessage(Текст)`#

`createEmbed()`#

`sendMessage(Текст)`#

`createEmbed()`#

`hasPermission(Название)`#

`hasPermissions(Названия)`#

`hasPermission(Канал, Название)`#

`hasPermissions(Канал, Названия)`#

`delete()`#

`pin()`#

`unpin()`#

`withContent(Текст)`#

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

`withAuthor(Имя, URL, IconURL)`#

`withDescription(Текст)`#

`appendDescription(Текст)`#

`withThumbnail(URL)`#

`withImage(URL)`#

`withColor(Цвет)`#

`withDate(Дата)`#

`withFooter(Текст, IconURL)`#

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

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

`addReaction(Эмоция)`#

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

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

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

`clearFields()`#

`clear()`#

`error()`#

`deleteAfterSec(Секунды)`#

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

`editComponentMessage(Заменять)`#

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

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

`send()`#

`update(id)`#

`update(Значение)`#

`increment(Число)`#

`decrement(Число)`#

`clear()`#

`get(Номер)`#

`after(Номер)`#

`before(Номер)`#

`range(Начало, Конец)`#

`getOption(Название)`#

`getOptionsByType(Тип)`#

`get(Ключ)`#

`store(Ключ, Значение)`#