Pular para o conteúdo principal

Introdução

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

Mais informações sobre a interface do usuário do módulo https://doc.oneentry.cloud/docs/category/users

🎯 O que este módulo faz?​

O módulo UserGroups permite que você leia os grupos aos quais seus visitantes pertencem. Um grupo decide o que um visitante pode ver, e os grupos formam uma árvore — um grupo pode ter um pai e filhos.

Os grupos são criados e aninhados no painel de administração do OneEntry; o SDK é somente leitura e apenas busca esses grupos. Todo projeto tem pelo menos o grupo de convidados, que é onde um visitante não autenticado aterrissa.

🚀 Início Rápido​

Inicialize o módulo a partir de defineOneEntry:


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

Leia toda a lista ou comece no topo da árvore:

// 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 pela árvore​

Leia os filhos de um grupo pelo marcador do pai, não pelo parentId:

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

Um grupo sem filhos retorna um array vazio.

⚠️ childrenCount é uma string​

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

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

Compare como uma string ou converta você mesmo:

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

📋 Métodos​

MétodoO que retorna
getUserGroups()Cada grupo como um array plano
getRootUserGroups()Grupos sem um pai
getUserGroupById(id)Um grupo pelo seu identificador
getUserGroupByMarker(marker)Um grupo pelo seu marcador
getChildUserGroupsByMarker(marker)Filhos do grupo dado