Работа со списками
Создать новый список
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('Список участников')Добавление клиента в список
add_to_list()
add_to_list(list_id, client_id) - добавляет клиента в список. Функция возвращает none.
Параметры:
! 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).
Если вы не укажете этот параметр, и в списке есть клиенты, вы получите следующий ответ: "Нельзя удалить список, список не пуст"
Если список пуст, он будет удалён без проблем. Однако если вы установите clear_list в True, список будет удалён независимо от того, есть в нём клиенты или нет.
Удаление тегов
remove_label_from_project(list_id, clear_list)
! list_id - обязательный параметр; ID тега, который нужно удалить.
clear_list - необязательный параметр; принимает два значения: True или False (по умолчанию False).
Если этот параметр не указан, и тег назначен клиентам, вы получите следующий ответ: "Нельзя удалить список, список не пуст"
Если тег не назначен ни одному клиенту, он будет удалён без проблем. Однако если 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']
Проверить, находится ли клиент в списке
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 - клиент не находится в указанном списке.
Получение элементов из списка
count_occurrences()
count_occurrences(array, element) - возвращает количество указанных элементов, содержащихся в списке.
Параметры:
массив - обязательный параметр; список элементов
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() .
а
Последнее обновление