UserGroups

Leia os grupos de usuários do seu projeto: a lista plana, o nível superior, um único grupo ou os filhos de um deles.

Mais informações sobre grupos de usuários no painel de administração do OneEntry: https://doc.oneentry.cloud/docs/category/users (abre em uma nova aba)

---

O módulo UserGroups lê os grupos aos quais seus visitantes pertencem. Um grupo determina o que um visitante pode ver. Os grupos formam uma árvore: um grupo pode ter um pai e filhos.

Você cria e aninha os grupos no painel de administração do OneEntry; o SDK apenas os lê. Todo projeto tem pelo menos o grupo de convidados, ao qual pertencem os visitantes não autenticados.

Início rápido

Inicialize o módulo a partir de defineOneEntry:

const {  } = defineOneEntry(
  , {
    
  }
);

Obtenha a lista inteira ou comece pelo topo da árvore:

// 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);
});

Percorrendo a árvore

Obtenha os filhos de um grupo pelo marcador do pai em vez de comparar parentId:

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

Para um grupo sem filhos, o método resolve para [].

childrenCount é uma string

A API envia childrenCount como string, não como número:

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

Converta-o antes de comparar:

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

Métodos

Método	O que retorna
getUserGroups()	Todos os grupos como um array plano
getRootUserGroups()	Grupos sem pai
getUserGroupById()	Um grupo pelo ID numérico
getUserGroupByMarker()	Um grupo pelo marcador
getChildUserGroupsByMarker()	Filhos do grupo informado

Relacionados

• Módulo Users: groups de um usuário lista os IDs dos seus grupos

---