Робота зі списками
Створити новий список
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() функцію.
а
Last updated