UserGroups
اقرأ مجموعات المستخدمين في مشروعك: القائمة المسطّحة، أو المستوى الأعلى، أو مجموعة واحدة، أو أبناء مجموعة ما.
مزيد من المعلومات حول مجموعات المستخدمين في لوحة إدارة OneEntry: https://doc.oneentry.cloud/docs/category/users (يفتح في علامة تبويب جديدة)
تقرأ وحدة UserGroups المجموعات التي ينتمي إليها زوّارك. تحدد المجموعة ما يُسمح للزائر برؤيته. تشكّل المجموعات شجرة: يمكن أن يكون للمجموعة أصل وأبناء.
تنشئ المجموعات وتداخلها في لوحة إدارة OneEntry؛ ويقرؤها SDK فقط. يحتوي كل مشروع على مجموعة الضيوف على الأقل، والتي ينتمي إليها الزوار غير المصادَق عليهم.
بدء سريع
قم بتهيئة الوحدة من defineOneEntry:
const { } = defineOneEntry( , { });
اجلب القائمة كاملة، أو ابدأ من أعلى الشجرة:
// 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);
});
التنقل في الشجرة
اجلب المجموعات الفرعية لمجموعة حسب علامة الأصل بدلًا من مطابقة parentId:
const children = await UserGroups.getChildUserGroupsByMarker('guest');
بالنسبة لمجموعة بلا مجموعات فرعية، تُعيد الطريقة [].
childrenCount سلسلة نصية
ترسل API قيمة childrenCount كسلسلة نصية، وليس كرقم:
{ "identifier": "guest", "childrenCount": "0" }
حوّلها قبل المقارنة:
if (Number(group.childrenCount) > 0) {
const children = await UserGroups.getChildUserGroupsByMarker(group.identifier);
}
الطرق
| الطريقة | ما الذي تُرجعه |
|---|---|
| getUserGroups() | كل المجموعات في مصفوفة مسطّحة |
| getRootUserGroups() | المجموعات التي ليس لها أصل |
| getUserGroupById() | مجموعة واحدة بواسطة معرّفها الرقمي |
| getUserGroupByMarker() | مجموعة واحدة بواسطة علامتها |
| getChildUserGroupsByMarker() | المجموعات الفرعية للمجموعة المحددة |
ذات صلة
- وحدة Users: يحتوي الحقل
groupsفي المستخدم على معرّفات مجموعاته