getRootUserGroups

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

الوصف

تسترجع هذه الطريقة مجموعات المستخدمين على المستوى الأعلى - تلك التي ليس لها والد. تعيد Promise يتم حلها إلى مصفوفة من كائنات IUserGroupEntity.

UserGroups.getRootUserGroups(langCode);

المعلمات

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

أمثلة

مثال بسيط

const response = await UserGroups.getRootUserGroups();

استجابة المثال

[
  {
    "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": {}
  }
]

مخطط الاستجابة

المخطط: 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

---