Travailler avec des listes

Créer une nouvelle liste

create_list()

Description

Saisissez la fonction dans le champ "Calculatrice" des 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 spécifié entre guillemets simples.

Exemple

list_id = create_list("registered")

Créer une liste à partir du bloc sans doublons

create_list_if_not_exist()

Description

create_list_if_not_exist('list_name') - crée une nouvelle liste si une liste portant ce nom n'existe pas encore et retourne son identifiant, ou retourne l'identifiant de la liste existante.

Paramètre obligatoire :

list_name - nom de la nouvelle liste à créer.

Exemple

new_list = create_list_if_not_exist('Liste des participants')

Ajouter un client à la liste

add_to_list()

Description

add_to_list(list_id, client_id) - ajoute un client à une liste. La fonction ne retourne rien.

Paramètres :

! list_id - ID de la liste

client_id - ID client MaviBot. S'il n'est pas fourni, l'ID du client actuel est utilisé.

Déplacer un client vers la liste

move_to_list()

Description

move_to_list(list_id, client_id) - déplace un client vers la liste (Important ! Le client est retiré 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 MaviBot. S'il n'est pas fourni, l'ID du client actuel est utilisé.

Supprimer un client de la liste

remove_from_list()

Description

remove_from_list(list_id, client_id) - supprime un client avec le client_id spécifié de la liste.

Paramètres :

! list_id - ID de la liste

client_id - ID client MaviBot. S'il n'est pas fourni, l'ID du client actuel est utilisé.

Supprimer des listes

remove_list_from_project(list_id, clear_list)

Description
! list_id - paramètre obligatoire ; l'ID de la liste à supprimer.

clear_list — paramètre optionnel ; accepte deux valeurs : True ou False (par défaut False).

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.

Supprimer des tags

remove_label_from_project(list_id, clear_list)

Description
! list_id - paramètre obligatoire ; l'ID du tag à supprimer.

clear_list - paramètre optionnel ; accepte deux valeurs : True ou False (par défaut False).

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()

Description

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()

Description

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 clients uniques dans plusieurs listes

lists_joint_count()

Description

lists_joint_count(massive_list) – compte le nombre total d'entrées clients uniques dans plusieurs listes. La fonction prend en entrée un tableau d'IDs de listes et retourne un nombre.

Paramètres :

! massive_list - un tableau contenant les IDs des listes dans lesquelles les entrées clients uniques seront comptées. Le format est : ['list_id1', 'list_id2', ..., 'list_idN']

Exemple de code à copier

/*Création d'une liste*/
list_id = create_list('Nouvelle liste')

/*Vérifier si le client est dans la liste*/
k=inlist(list_id, client_id)

/*Obtenir la taille de la liste — nombre total de clients dans la liste*/
razm=list_size(1)

/*Obtenir le nombre total d'entrées clients uniques dans plusieurs listes*/
k=lists_joint_count('[144636,144634]')

Vérifier si un client est dans la liste

inlist()

Description

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 MaviBot. S'il n'est pas fourni, l'ID du client actuel est utilisé.

Vérifier si un participant de chat est dans une liste spécifique

some_client_in_list()

Description

some_client_in_list(list_id, recepient)

Paramètres :

! list_id - ID de la liste ;

! recepient - ID de l'utilisateur du messagerie vérifié (platform_id). Pour les chats, la valeur de la variable est chat_member_id.

Retourne les valeurs :

True - le client est dans la liste ;

False - le client n'est pas dans la liste spécifiée.

Exemple

Exemple de code à copier

/*Exemple de vérification si un participant de chat est dans la liste, où le premier paramètre est l'ID de la liste, et le second est l'ID de chat de l'utilisateur*/

r = some_client_in_list(123456, chat_member_id)

Récupérer des éléments d'une liste

count_occurrences()

Description

count_occurrences(array, element) - retourne le nombre d'éléments spécifiés contenus dans la liste.

Paramètres :

array - paramètre obligatoire ; liste d'éléments

element - paramètre obligatoire ; élément à compter

Obtenir un ID client aléatoire de la liste

random_list_member(list_id)

Description

random_list_member(list_id) - retourne un ID client aléatoire dans la liste spécifiée.

list_id - paramètre obligatoire, ID de la liste.

L'ID de la liste, qui contient vos clients, se trouve dans la section "Listes" :

Exemple de travail avec des listes dans la Calculatrice

Examinons un exemple d'utilisation des fonctions dans la "Calculatrice" pour travailler avec des listes.

Important ! Vous devez enregistrer un nouvel ID de liste pour pouvoir l'utiliser ultérieurement. Pour ce faire, assignez le résultat de la fonction à une variable, c'est-à-dire 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 la fonction lists_joint_count().

Obtenir tous les IDs de listes d'un client

get_all_client_label_ids(client_id)

Description

get_all_client_list_ids(client_id) — retourne un tableau contenant les IDs de toutes les listes auxquelles le client appartient.

Si le client n'appartient à aucune liste, la fonction retourne un tableau vide : [].

Paramètres :

client_id — l'ID client Mavibot. S'il est omis, l'ID du client actuel est utilisé.