UserGroups

Lisez les groupes d'utilisateurs de votre projet : la liste plate, le premier niveau, un groupe précis ou les enfants d'un groupe.

Plus d'informations sur les groupes d'utilisateurs dans le panneau d'administration OneEntry : https://doc.oneentry.cloud/docs/category/users (ouvre dans un nouvel onglet)

---

Le module UserGroups lit les groupes auxquels appartiennent vos visiteurs. Un groupe détermine ce qu'un visiteur peut voir. Les groupes forment un arbre : un groupe peut avoir un parent et des enfants.

Vous créez et imbriquez les groupes dans le panneau d'administration OneEntry ; le SDK se contente de les lire. Chaque projet comporte au moins le groupe invité, auquel appartiennent les visiteurs non authentifiés.

Démarrage rapide

Initialisez le module depuis defineOneEntry :

const {  } = defineOneEntry(
  , {
    
  }
);

Récupérez la liste complète, ou partez du sommet de l'arbre :

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

Parcourir l'arbre

Récupérez les enfants d'un groupe par le marqueur du parent au lieu de comparer parentId :

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

Pour un groupe sans enfants, la méthode renvoie [].

childrenCount est une chaîne

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

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

Convertissez-le avant de comparer :

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

Méthodes

Méthode	Ce qu'elle renvoie
getUserGroups()	Tous les groupes sous forme de tableau plat
getRootUserGroups()	Groupes sans parent
getUserGroupById()	Un groupe par son ID numérique
getUserGroupByMarker()	Un groupe par son marqueur
getChildUserGroupsByMarker()	Enfants du groupe indiqué

Voir aussi

• Module Users : groups d'un utilisateur liste les ID de ses groupes

---