getUserGroupByMarker

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

الوصف

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

UserGroups.getUserGroupByMarker(marker, langCode);

المعلمات

marker: string
المعرف النصي لمجموعة المستخدم.
مثال: "guest"

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

أمثلة

مثال بسيط

const response = await UserGroups.getUserGroupByMarker('guest');

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

{
  "id": 1,
  "depth": 0,
  "parentId": null,
  "localizeInfos": {
    "title": "Guest"
  },
  "isVisible": true,
  "childrenCount": "0",
  "identifier": "guest",
  "isSync": false,
  "attributeValues": {},
  "version": 0
}

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

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

---