Aller au contenu principal

Introduction

Lisez les groupes d'utilisateurs de votre projet : la liste plate, le niveau supérieur, un seul groupe ou les enfants d'un groupe.

Plus d'informations sur l'interface utilisateur du module https://doc.oneentry.cloud/docs/category/users

🎯 Que fait ce module ?​

Le module UserGroups vous permet de lire les groupes auxquels appartiennent vos visiteurs. Un groupe détermine ce qu'un visiteur peut voir, et les groupes forment un arbre — un groupe peut avoir un parent et des enfants.

Les groupes sont créés et imbriqués dans le panneau d'administration OneEntry ; le SDK est en lecture seule et ne récupère que ces groupes. Chaque projet a au moins le groupe invité, qui est l'endroit où un visiteur non authentifié atterrit.

🚀 Démarrage rapide​

Initialisez le module à partir de defineOneEntry :


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

Lisez toute la liste, ou commencez par le sommet de l'arbre :

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

🌳 Parcourir l'arbre​

Lisez les enfants d'un groupe par le marqueur du parent, et non par parentId :

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

Un groupe sans enfants renvoie un tableau vide.

⚠️ childrenCount est une chaîne​

L'API envoie childrenCount sous forme de chaîne, et non de nombre :

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

Comparez-le comme une chaîne, ou convertissez-le vous-même :

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

📋 Méthodes​

MéthodeCe qu'elle renvoie
getUserGroups()Chaque groupe sous forme de tableau plat
getRootUserGroups()Groupes sans parent
getUserGroupById(id)Un groupe par son identifiant
getUserGroupByMarker(marker)Un groupe par son marqueur
getChildUserGroupsByMarker(marker)Enfants du groupe donné