UserGroups

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

Más información sobre los grupos de usuarios en el panel de administración de OneEntry: https://doc.oneentry.cloud/docs/category/users (abre en una nueva pestaña)

---

El módulo UserGroups lee los grupos a los que pertenecen tus visitantes. Un grupo determina lo que un visitante puede ver. Los grupos forman un árbol: un grupo puede tener un padre e hijos.

Creas y anidas los grupos en el panel de administración de OneEntry; el SDK solo los lee. Todo proyecto tiene al menos el grupo de invitados, al que pertenecen los visitantes no autenticados.

Inicio rápido

Inicializa el módulo desde defineOneEntry:

const {  } = defineOneEntry(
  , {
    
  }
);

Obtén la lista completa o empieza por la parte superior del árbol:

// Every group, flat, regardless of nesting.
const groups = await UserGroups.getUserGroups();
if ('statusCode' in groups) throw new Error(groups.message);
console.log(groups.length);

// Only the groups without a parent.
const roots = await UserGroups.getRootUserGroups();
if ('statusCode' in roots) throw new Error(roots.message);

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

Recorrer el árbol

Obtén los hijos de un grupo por el marcador del padre en lugar de comparar parentId:

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

Para un grupo sin hijos, el método se resuelve en [].

childrenCount es una cadena

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

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

Conviértelo antes de comparar:

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

Métodos

Método	Qué devuelve
getUserGroups()	Todos los grupos como un array plano
getRootUserGroups()	Grupos sin padre
getUserGroupById()	Un grupo por su ID numérico
getUserGroupByMarker()	Un grupo por su marcador
getChildUserGroupsByMarker()	Hijos del grupo indicado

Relacionado

• Módulo Users: groups en un usuario enumera los IDs de sus grupos

---