getChildUserGroupsByMarker
Récupérer les groupes enfants d'un groupe d'utilisateurs.
Description
Récupère les groupes enfants du groupe ayant le marqueur donné et se résout en un tableau d'objets IUserGroupEntity, ou [] si le groupe n'a pas d'enfants. Utilisez-la pour parcourir l'arborescence au lieu de comparer parentId. Si aucun groupe n'a ce marqueur, se résout en un IError avec statusCode: 404 ("Group not found").
.getChildUserGroupsByMarker(
,
);
Schéma des paramètres
Schema
marker(required): string
Identifiant textuel du groupe d'utilisateurs parent.
exemple : "guest"
langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"
Exemples
Exemple minimal
const response = await UserGroups.getChildUserGroupsByMarker('guest');
Exemple de réponse
[]
Schéma de réponse
Schéma : IUserGroupEntity[]
id: number
ID du groupe d'utilisateurs.
exemple : 1
depth: number
Niveau du groupe dans l'arborescence : 0 pour un groupe de premier niveau, la depth du parent plus 1 pour un enfant.
exemple : 0
parentId: number | null
Identifiant du groupe parent, null pour un groupe de premier niveau.
exemple : null
localizeInfos: ILocalizeInfo
Titre localisé du groupe.
isVisible: boolean
Indique si le groupe est visible.
exemple : true
childrenCount: string
Nombre de groupes enfants. L'API l'envoie sous forme de chaîne, et non de nombre.
exemple : "0"
identifier: string
Identifiant textuel (marqueur) du groupe.
exemple : "guest"
isSync: boolean
Indique si l'index des attributs du groupe est construit pour la langue demandée. Lorsqu'il vaut false, un attributeValues vide signifie que les valeurs ne sont pas encore indexées, et non qu'il n'y en a aucune.
exemple : false
attributeValues: IAttributeValues
Valeurs d'attributs du groupe.
version: number
Numéro de version du groupe. Renvoyé uniquement par getUserGroupById() et getUserGroupByMarker() ; les méthodes de liste (getUserGroups(), getRootUserGroups(), getChildUserGroupsByMarker()) l'omettent.