Saltar al contenido principal

Introducción

Lee los grupos de usuarios de tu proyecto: la lista plana, el nivel superior, un solo grupo o los hijos de uno.

Más información sobre la interfaz de usuario del módulo https://doc.oneentry.cloud/docs/category/users

🎯 ¿Qué hace este módulo?​

El módulo UserGroups te permite leer los grupos a los que pertenecen tus visitantes. Un grupo decide qué puede ver un visitante, y los grupos forman un árbol: un grupo puede tener un padre y niños.

Los grupos se crean y anidan en el panel de administración de OneEntry; el SDK es de solo lectura y solo los obtiene. Cada proyecto tiene al menos el grupo de invitados, que es donde aterriza un visitante no autenticado.

🚀 Inicio rápido​

Inicializa el módulo desde defineOneEntry:


const { UserGroups } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Lee toda la lista o comienza desde la parte superior del árbol:

// Every group, flat, regardless of nesting.
const groups = await UserGroups.getUserGroups();

// Only the groups without a parent.
const roots = await UserGroups.getRootUserGroups();

roots.forEach((group) => {
  console.log(group.identifier, group.localizeInfos.title);
});

🌳 Navegando por el árbol​

Lee los hijos de un grupo por el marcador del padre, no por parentId:

const children = await UserGroups.getChildUserGroupsByMarker('guest');

Un grupo sin hijos devuelve un array vacío.

⚠️ childrenCount es una cadena​

La API envía childrenCount como una cadena, no como un número:

{ "identifier": "guest", "childrenCount": "0" }

Compáralo como una cadena o conviértelo tú mismo:

if (Number(group.childrenCount) > 0) {
  const children = await UserGroups.getChildUserGroupsByMarker(group.identifier);
}

📋 Métodos​

MétodoLo que devuelve
getUserGroups()Cada grupo como un array plano
getRootUserGroups()Grupos sin un padre
getUserGroupById(id)Un grupo por su identificador
getUserGroupByMarker(marker)Un grupo por su marcador
getChildUserGroupsByMarker(marker)Hijos del grupo dado