Crear una nueva lista

create_list()

Descripción

Ingrese la función en el campo "Calculadora" en la configuración del bloque:

create_list(name) - crea una nueva lista. El resultado es el ID de la lista.

Parámetros:

! name - nombre de la lista. El nombre se especifica entre comillas simples.

Ejemplo

list_id = create_list("registered")

Crear una lista desde el bloque sin duplicados

create_list_if_not_exist()

Descripción

create_list_if_not_exist('list_name') - crea una nueva lista si aún no existe una con el nombre dado y devuelve su identificador, o devuelve el identificador de la lista existente.

Parámetro requerido:

list_name - nombre para la nueva lista a crear.

Ejemplo

new_list = create_list_if_not_exist('Lista de participantes')

Agregar un cliente a la lista

add_to_list()

Descripción

add_to_list(list_id, client_id) - agrega un cliente a una lista. La función no devuelve nada.

Parámetros:

! list_id - ID de la lista

client_id - ID del cliente de MaviBot. Si no se proporciona, se utiliza el ID del cliente actual.

Mover un cliente a la lista

move_to_list()

Descripción

move_to_list(list_id, client_id) - mueve un cliente a la lista (¡Importante! El cliente se elimina de todas las demás listas y se mueve a la especificada). El resultado es un valor booleano (True o False).

Parámetros:

! list_id - ID de la lista

client_id - ID del cliente de MaviBot. Si no se proporciona, se utiliza el ID del cliente actual.

Eliminar un cliente de la lista

remove_from_list()

Descripción

remove_from_list(list_id, client_id) - elimina un cliente con el client_id especificado de la lista.

Parámetros:

! list_id - ID de la lista

client_id - ID del cliente de MaviBot. Si no se proporciona, se utiliza el ID del cliente actual.

Eliminar listas

remove_list_from_project(list_id, clear_list)

Descripción
! list_id - parámetro requerido; el ID de la lista a eliminar.

clear_list — parámetro opcional; acepta dos valores: True o False (por defecto es False).

Si no proporciona este parámetro y la lista contiene clientes, recibirá la siguiente respuesta:
"Can't delete list, list not empty"

Si la lista está vacía, se eliminará sin problemas. Sin embargo, si establece clear_list en True, la lista se eliminará independientemente de si contiene clientes o no.

Eliminar etiquetas

remove_label_from_project(list_id, clear_list)

Descripción
! list_id - parámetro requerido; el ID de la etiqueta a eliminar.

clear_list - parámetro opcional; acepta dos valores: True o False (por defecto es False).

Si no se proporciona este parámetro y la etiqueta está asignada a clientes, recibirá la siguiente respuesta:
"Can't delete list, list not empty"

Si la etiqueta no está asignada a ningún cliente, se eliminará sin problemas. Sin embargo, si clear_list se establece en True, la etiqueta se eliminará independientemente de si está asignada a clientes o no.

Limpiar la lista de clientes

clear_list()

Descripción

clear_list(list_id) - limpia la lista de clientes

Parámetros:

! list_id - ID de la lista. Después de su uso, todos los clientes serán eliminados de la lista especificada.

Obtener el número de clientes en la lista

list_size()

Descripción

list_size(list_id) – cuenta el número total de clientes en la lista

Parámetros:

! list_id- ID de la lista

Contar el número de entradas únicas de clientes en múltiples listas

lists_joint_count()

Descripción

lists_joint_count(massive_list) – cuenta el número total de entradas únicas de clientes en múltiples listas. La función toma un array de IDs de listas como entrada y devuelve un número.

Parámetros:

! massive_list - un array que contiene los IDs de las listas en las que se contarán las entradas únicas de clientes. El formato es: ['list_id1', 'list_id2', ..., 'list_idN']

Ejemplo de código para copiar

/*Crear una lista*/
list_id = create_list('Nueva lista')

/*Verificar si el cliente está en la lista*/
k=inlist(list_id, client_id)

/*Obtener el tamaño de la lista — número total de clientes en la lista*/
razm=list_size(1)

/*Obtener el número total de entradas únicas de clientes en múltiples listas*/
k=lists_joint_count('[144636,144634]')

Verificar si un cliente está en la lista

inlist()

Descripción

inlist(list_id,client_id) - verifica si un cliente está en la lista. El resultado es un valor booleano (True o False).

Parámetros:

! list_id - ID de la lista

client_id - ID del cliente de MaviBot. Si no se proporciona, se utiliza el ID del cliente actual.

Verificar si un participante del chat está en una lista específica

some_client_in_list()

Descripción

some_client_in_list(list_id, recepient)

Parámetros:

! list_id - ID de la lista;

! recepient - ID del usuario del mensajero que se está verificando (platform_id). Para chats, el valor de la variable es chat_member_id.

Devuelve valores:

True - el cliente está en la lista;

False - el cliente no está en la lista especificada.

Ejemplo

Ejemplo de código para copiar

/*Ejemplo de verificación si un participante del chat está en la lista, donde el primer parámetro es el ID de la lista y el segundo es el ID del chat del usuario*/

r = some_client_in_list(123456, chat_member_id)

Recuperar elementos de una lista

count_occurrences()

Descripción

count_occurrences(array, element) - devuelve el número de elementos especificados contenidos en la lista.

Parámetros:

array - parámetro requerido; lista de elementos

element - parámetro requerido; elemento a contar

Obtener un ID de cliente aleatorio de la lista

random_list_member(list_id)

Descripción

random_list_member(list_id) - devuelve un ID de cliente aleatorio en la lista especificada.

list_id - parámetro requerido, ID de la lista.

El ID de la lista, que contiene sus clientes, se puede encontrar en la sección "Listas":

Ejemplo de trabajo con listas en la Calculadora

Veamos un ejemplo de uso de funciones en la "Calculadora" para trabajar con listas.

¡Importante! Debe guardar el ID de la nueva lista para poder usarlo más tarde. Para hacer esto, asigne el resultado de la función a una variable, es decir, list_id = ...

Ahora puede realizar fácilmente otras operaciones con la lista: verificar si un cliente está en la lista, agregar, mover o eliminar un cliente.

Por ejemplo, verifiquemos si un cliente está en la lista con ID 12333:

Es muy conveniente usar listas al mostrar datos estadísticos:

A menudo es necesario obtener el número total de entradas únicas en un conjunto de listas; esto se puede hacer fácilmente usando la función lists_joint_count().

а

Obtener todos los IDs de listas de clientes

get_all_client_label_ids(client_id)

Descripción

get_all_client_list_ids(client_id) — devuelve un array que contiene los IDs de todas las listas a las que pertenece el cliente.

Si el cliente no pertenece a ninguna lista, la función devuelve un array vacío: [].

Parámetros:

  • client_id — el ID del cliente de Mavibot. Si se omite, se utiliza el ID del cliente actual.