Создать новый список
create_list()
Описание
Введите функцию в поле "Калькулятор" в настройках блока:
create_list(name) - создает новый список. Результат — ID списка.
Параметры:
!** name** - имя списка. Имя указывается в одинарных кавычках.
Пример
list_id = create_list("registered")
Создание списка из блока без дубликатов
create_list_if_not_exist()
Описание
create_list_if_not_exist('list_name') - создает новый список, если список с таким именем еще не существует, и возвращает его идентификатор, или возвращает идентификатор существующего списка.
Обязательный параметр:
list_name - имя для создаваемого нового списка.
Пример
new_list = create_list_if_not_exist('List of participants')
Добавление клиента в список
add_to_list()
Описание
add_to_list(list_id, client_id) - добавляет клиента в список. Функция ничего не возвращает.
Параметры:
!** list_id** - ID списка
client_id - ID клиента MaviBot. Если не указан, используется ID текущего клиента.
Перемещение клиента в список
move_to_list()
Описание
move_to_list(list_id, client_id) - перемещает клиента в список (Важно! Клиент удаляется из всех остальных списков и перемещается в указанный). Результат — логическое значение (True или False).
Параметры:
!** list_id** - ID списка
client_id - ID клиента MaviBot. Если не указан, используется ID текущего клиента.
Удаление клиента из списка
remove_from_list()
Описание
remove_from_list(list_id, client_id) - удаляет клиента с указанным client_id из списка.
Параметры:
!** list_id** - ID списка
client_id - ID клиента MaviBot. Если не указан, используется ID текущего клиента.
Удаление списков
remove_list_from_project(list_id, clear_list)
Описание
!** list_id** - обязательный параметр; ID списка, который нужно удалить.
clear_list — необязательный параметр; принимает два значения: True или False (по умолчанию False).
Если не указать этот параметр и в списке есть клиенты, вы получите следующий ответ:
"Can't delete list, list not empty"
Если список пуст, он будет удален без проблем. Однако, если установить clear_list в True, список будет удален независимо от того, есть в нем клиенты или нет.
Удаление тегов
remove_label_from_project(list_id, clear_list)
Описание
!** list_id** - обязательный параметр; ID тега, который нужно удалить.
clear_list - необязательный параметр; принимает два значения: True или False (по умолчанию False).
Если этот параметр не указан и тег назначен клиентам, вы получите следующий ответ:
"Can't delete list, list not empty"
Если тег не назначен ни одному клиенту, он будет удален без проблем. Однако, если clear_list установлен в True, тег будет удален независимо от того, назначен он клиентам или нет.
Очистить список клиентов
clear_list()
Описание
clear_list(list_id) - очищает список клиентов
Параметры:
!** list_id -** ID списка. После использования все клиенты будут удалены из указанного списка.
Получить количество клиентов в списке
list_size()
Описание
list_size(list_id) – подсчитывает общее количество клиентов в списке
Параметры:
!** list_id**- ID списка
Подсчет количества уникальных записей клиентов в нескольких списках
lists_joint_count()
Описание
lists_joint_count(massive_list) – подсчитывает общее количество уникальных записей клиентов в нескольких списках. Функция принимает массив ID списков и возвращает число.
Параметры:
!** massive_list** - массив, содержащий ID списков, в которых будут подсчитаны уникальные записи клиентов. Формат: ['list_id1', 'list_id2', ..., 'list_idN']
Пример кода для копирования
/*Creating a list*/
list_id = create_list('New list')
/*Check if the client is in the list*/
k=inlist(list_id, client_id)
/*Get the size of the list — total number of clients in the list*/
razm=list_size(1)
/*Get the total number of unique client entries across multiple lists*/
k=lists_joint_count('[144636,144634]')
Проверить, находится ли клиент в списке
inlist()
Описание
inlist(list_id,client_id) - проверяет, находится ли клиент в списке. Результат — логическое значение (True или False).
Параметры:
!** list_id** - ID списка
client_id - ID клиента MaviBot. Если не указан, используется ID текущего клиента.
Проверить, находится ли участник чата в определенном списке
some_client_in_list()
Описание
some_client_in_list(list_id, recepient)
Параметры:
!** list_id** - ID списка;
!** recepient** - ID пользователя мессенджера, который проверяется (platform_id). Для чатов используется значение переменной chat_member_id.
Возвращает значения:
True - клиент находится в списке;
False - клиент не находится в указанном списке.
Пример
Пример кода для копирования
/*Example of checking if a chat participant is in the list, where the first parameter is the list ID, and the second is the user's chat ID*/
r = some_client_in_list(123456, chat_member_id)
Извлечение элементов из списка
count_occurrences()
Описание
count_occurrences(array, element) - возвращает количество указанных элементов, содержащихся в списке.
Параметры:
array - обязательный параметр; список элементов
element - обязательный параметр; элемент для подсчета
Получение случайного ID клиента из списка
random_list_member(list_id)
Описание
random_list_member(list_id) - возвращает один случайный ID клиента в указанном списке.
list_id - обязательный параметр, ID списка.
ID списка, содержащего ваших клиентов, можно найти в разделе "Списки":
Пример работы со списками в Калькуляторе
Рассмотрим пример использования функций в "Калькуляторе" для работы со списками.
Важно! Вам нужно сохранить ID нового списка, чтобы использовать его в дальнейшем. Для этого присвойте результат функции переменной, т.е. list_id = ...
Теперь вы можете легко выполнять другие операции со списком — проверять, находится ли клиент в списке, добавлять, перемещать или удалять клиента.
Например, проверим, находится ли клиент в списке с ID 12333:
Очень удобно использовать списки при отображении статистических данных:
Часто необходимо получить общее количество уникальных записей по набору списков — это легко сделать с помощью функции lists_joint_count().
а
Получить все ID списков клиента
get_all_client_label_ids(client_id)
Описание
get_all_client_list_ids(client_id) — возвращает массив, содержащий ID всех списков, к которым принадлежит клиент.
Если клиент не принадлежит ни одному списку, функция возвращает пустой массив: [].
Параметры:
-
client_id— ID клиента Mavibot. Если опущен, используется ID текущего клиента.