Travailler avec des listes
Créer une nouvelle liste
create_list()
Saisissez la fonction dans le « Calculatrice » champ dans les paramètres du bloc :
create_list(name) - crée une nouvelle liste. Le résultat est l’ID de la liste.
Paramètres :
! name - nom de la liste. Le nom est indiqué entre guillemets simples.
list_id = create_list("registered")
Création d’une liste à partir du bloc sans doublons
create_list_if_not_exist()
create_list_if_not_exist('list_name') - crée une nouvelle liste si aucune liste portant le nom donné n’existe encore et renvoie son identifiant, ou renvoie l’identifiant de la liste existante.
Paramètre requis :
list_name - nom de la nouvelle liste à créer.
new_list = create_list_if_not_exist('Liste des participants')Ajout d’un client à la liste
add_to_list()
add_to_list(list_id, client_id) - ajoute un client à une liste. La fonction ne renvoie rien.
Paramètres :
! list_id - ID de la liste
client_id - ID client de MaviBot. Si non fourni, l’ID du client actuel est utilisé.
Déplacement d’un client vers la liste
move_to_list()
move_to_list(list_id, client_id) - déplace un client vers la liste (Important ! Le client est supprimé de toutes les autres listes et déplacé vers celle spécifiée). Le résultat est une valeur booléenne (True ou False).
Paramètres :
! list_id - ID de la liste
client_id - ID client de MaviBot. Si non fourni, l’ID du client actuel est utilisé.
Suppression d’un client de la liste
remove_from_list()
remove_from_list(list_id, client_id) - supprime de la liste un client ayant l’identifiant client_id spécifié.
Paramètres :
! list_id - ID de la liste
client_id - ID client de MaviBot. Si non fourni, l’ID du client actuel est utilisé.
Suppression de listes
remove_list_from_project(list_id, clear_list)
! list_id - paramètre requis ; l’ID de la liste à supprimer.
clear_list — paramètre facultatif ; accepte deux valeurs : True ou False (False par défaut).
Si vous ne fournissez pas ce paramètre et que la liste contient des clients, vous recevrez la réponse suivante : "Impossible de supprimer la liste, la liste n’est pas vide"
Si la liste est vide, elle sera supprimée sans problème. Cependant, si vous définissez clear_list sur True, la liste sera supprimée qu’elle contienne des clients ou non.
Suppression de tags
remove_label_from_project(list_id, clear_list)
! list_id - paramètre requis ; l’ID du tag à supprimer.
clear_list - paramètre facultatif ; accepte deux valeurs : True ou False (False par défaut).
Si ce paramètre n’est pas fourni et que le tag est attribué à des clients, vous recevrez la réponse suivante : "Impossible de supprimer la liste, la liste n’est pas vide"
Si le tag n’est attribué à aucun client, il sera supprimé sans problème. Cependant, si clear_list est défini sur True, le tag sera supprimé qu’il soit attribué à des clients ou non.
Vider la liste de clients
clear_list()
clear_list(list_id) - vide la liste de clients
Paramètres :
! list_id - ID de la liste. Après utilisation, tous les clients seront retirés de la liste spécifiée.
Obtenir le nombre de clients dans la liste
list_size()
list_size(list_id) – compte le nombre total de clients dans la liste
Paramètres :
! list_id- ID de la liste
Compter le nombre d’entrées client uniques dans plusieurs listes
lists_joint_count()
lists_joint_count(massive_list) – compte le nombre total d’entrées client uniques dans plusieurs listes. La fonction prend en entrée un tableau d’ID de listes et renvoie un nombre.
Paramètres :
! massive_list - un tableau contenant les ID des listes dans lesquelles les entrées client uniques seront comptées. Le format est : ['list_id1', 'list_id2', ..., 'list_idN']
Vérifier si un client est dans la liste
inlist()
inlist(list_id,client_id) - vérifie si un client est dans la liste. Le résultat est une valeur booléenne (True ou False).
Paramètres :
! list_id - ID de la liste
client_id - ID client de MaviBot. Si non fourni, l’ID du client actuel est utilisé.
Vérifier si un participant au chat est dans une liste spécifique
some_client_in_list()
some_client_in_list(list_id, recepient)
Paramètres :
! list_id - ID de la liste ;
! recepient - ID utilisateur du messager vérifié (platform_id). Pour les chats, la valeur de la variable est chat_member_id.
Elle renvoie les valeurs :
True - le client est dans la liste ;
False - le client n’est pas dans la liste spécifiée.
Récupération d’éléments à partir d’une liste
count_occurrences()
count_occurrences(array, element) - renvoie le nombre d’éléments spécifiés contenus dans la liste.
Paramètres :
tableau - paramètre requis ; liste d’éléments
element - paramètre requis ; élément à compter
Obtenir un ID client aléatoire de la liste
random_list_member(list_id)
random_list_member(list_id) - renvoie un ID client aléatoire dans la liste spécifiée.
list_id - paramètre requis, ID de la liste.
L’ID de la liste contenant vos clients peut être trouvé dans « Listes » :
Exemple de travail avec des listes dans le Calculateur
exemple
Voyons un exemple d’utilisation des fonctions dans le « Calculatrice » pour travailler avec des listes.
Important ! Vous devez enregistrer un nouvel ID de liste afin de pouvoir l’utiliser plus tard. Pour ce faire, affectez le résultat de la fonction à une variable, c.-à-d. list_id = ...
Vous pouvez maintenant facilement effectuer d’autres opérations avec la liste — vérifier si un client est dans la liste, ajouter, déplacer ou supprimer un client.
Par exemple, vérifions si un client est dans la liste avec l’ID 12333 :
Il est très pratique d’utiliser des listes lors de l’affichage de données statistiques :
Il est souvent nécessaire d’obtenir le nombre total d’entrées uniques dans un ensemble de listes — cela peut être facilement fait en utilisant lists_joint_count() fonction.
а
Mis à jour