Wiki: Заказы

Система заказов предназначена для размещения заказов зрителями по списку из каталога (а также произвольно), а также для удобного управления списком стримером и модераторами. Система построена как универсальная, но основное предназначение - это использование на музыкальных стримах для заказа песен.

Доступ

Создание заказов доступно всем зрителям. Управление списком заказов, а так же управление каталогом - только модераторам.

Активация

Отключено по-умолчанию. Включение - !az mode requests on, отключение - !az mode requests off.

Базовые сведения о системе заказов

Модуль построен вокруг трёх основных сущностей: каталога, очередей и списка заказов.

Каталог

Каталог - это список всего того, что могут заказывать зрители. Применительно к музыкальным стримам - это список песен. Обычно зрители могут заказывать только то, что находится в данном каталоге, а также делать произвольные заказы, если это позволяют настройки очереди (об этом далее).

Каталог представляет собой иерархическую структуру записей, другими словами - это дерево, в котором у каждой записи есть родительская запись (но только одна). Т.о. мы можем создавать вложенные категории, у всех элементов категории родительской записью является запись самой категории. В свою очередь эти элементы могут сами выступать как категории для своих элементов. Например: мы можем сделать категорию с названием «песни», в неё будут вложены имена исполнителей (у всех них родительской записью будет запись «песни»), а в каждого исполнителя мы можем добавить конкретные композиции, родительской записью у них уже будет запись исполнителя.

Свойства записей каталога

Запись каталога содержит в себе следующие данные:

Команды управления каталогом

Команды управления каталогом начинаются с «!az cat».

cat show - вывести информацию о записи

!az cat show id - выдаёт всю информацию об указанной записи каталога. Команда только для модераторов, потому как выдаёт всю, в т.ч. и «инженерную», информацию о записи, что не нужно для зрителя.

cat export - экспортирование каталога

!az cat export - экспортирует каталог в таблицу Google Spreadsheets и выдаёт на неё ссылку в чат. Экспорт организован так, что при изменении каталога создаётся новая таблица и новая ссылка (при этом старая удаляется). Т.о. не имеет смысла ни редактировать эту таблицу, ни сохранять на неё ссылку.

cat search / cat find - поиск по каталогу

!az cat search id - находит запись с указанным идентификатором и возвращает её название.

!az cat search name - поиск по части названия, возвращает найденную запись с полным названием и идентификатором.

cat add - добавить запись в каталог

Полный формат команды:

!az cat add родительская_запись | название | параметры

Сокращенные форматы команды:

!az cat add родительская_запись | название - когда параметры не задаются.

!az cat add родительская_запись *название*. Обратите внимание на отсутствие символа «|». В данном случае родительская запись должна быть задана идентификатором.

cat del - удалить запись

!az cat del запись - удаляет запись из каталога. Также удаляются все дочерние записи.

cat edit / cat set - редактировать запись

Позволяет изменить свойство записи (меняется одно свойство за раз).

!az cat edit запись *свойство* значение - меняет указанное свойство у указанной записи (запись можно задать как идентификатором, так и текстом в кавычках).

Список свойств:

cat + / cat enable - сделать запись доступной

!az cat + запись - делает запись доступной для заказа. Запись может быть задана в виде идентификатора, либо части названия.

cat - / cat disable - сделать запись недоступной

!az cat - запись - делает запись недоступной для заказа.

cat reload - перезагрузить каталог из БД

Сервисная команда для модераторов.