getUserGroups

الحصول على جميع كائنات مجموعة المستخدمين.

Description

تسترجع هذه الطريقة كل مجموعة مستخدمين في المشروع كمصفوفة مسطحة، بغض النظر عن التعشيش. تعيد Promise التي تحل إلى مصفوفة من كائنات IUserGroupEntity.

UserGroups.getUserGroups(langCode);

Parameters

langCode: string (اختياري)
رمز اللغة. الافتراضي: "en_US".
مثال: "en_US"

Examples

Minimal example

const response = await UserGroups.getUserGroups();

With a language code

const response = await UserGroups.getUserGroups('en_US');

Example response

[
  {
    "id": 1,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "Guest"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "guest",
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 2,
    "depth": 0,
    "parentId": null,
    "localizeInfos": {
      "title": "sd"
    },
    "isVisible": true,
    "childrenCount": "0",
    "identifier": "wewe",
    "isSync": false,
    "attributeValues": {}
  }
]

Response schema

Schema: IUserGroupEntity[]

id: number
معرف مجموعة المستخدمين.
مثال: 1

depth: number
عمق التعشيش بالنسبة للأب.
مثال: 0

parentId: number | null
معرف المجموعة الأم، null لمجموعة على المستوى الأعلى.
مثال: null

localizeInfos: ILocalizeInfo
عنوان المجموعة، مع الأخذ في الاعتبار التوطين.

isVisible: boolean
علامة الرؤية.
مثال: true

childrenCount: string
عدد المجموعات الفرعية. ترسل واجهة برمجة التطبيقات ذلك كسلسلة، وليس كرقم.
مثال: "0"

identifier: string
معرف نصي (علامة) للمجموعة.
مثال: "guest"

isSync: boolean
علامة المزامنة.
مثال: false

attributeValues: IAttributeValues
قيم السمات للمجموعة.

version: number
إصدار الكائن. غير موجود في كل حالة.
مثال: NaN

---