getChildUserGroupsByMarker

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

الوصف

تجلب المجموعات الفرعية للمجموعة ذات العلامة المُعطاة وتُعيد مصفوفة من كائنات IUserGroupEntity، أو [] إذا لم يكن للمجموعة مجموعات فرعية. استخدمها للتنقل في الشجرة بدلًا من مطابقة parentId. إذا لم توجد مجموعة بهذه العلامة، تُعيد IError مع statusCode: 404 ("Group not found").

.getChildUserGroupsByMarker(

,

);

مخطط المعلمات

Schema

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

langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"

أمثلة

مثال بسيط

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

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

[]

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

المخطط: IUserGroupEntity[]

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

depth: number
مستوى المجموعة في الشجرة: 0 للمجموعة في المستوى الأعلى، وdepth للمجموعة الأم زائد 1 للمجموعة الفرعية.
مثال: 0

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

localizeInfos: ILocalizeInfo
العنوان المترجم للمجموعة.

isVisible: boolean
هل المجموعة ظاهرة.
مثال: true

childrenCount: string
عدد المجموعات الفرعية. تُرسله واجهة API كسلسلة نصية وليس كرقم.
مثال: "0"

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

isSync: boolean
ما إذا كان فهرس سمات المجموعة مبنيًا للغة المطلوبة. عندما تكون القيمة false، فإن attributeValues الفارغة تعني أن القيم لم تُفهرس بعد، لا أنها غير موجودة.
مثال: false

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

version: number
رقم إصدار المجموعة. تُرجعه فقط getUserGroupById() وgetUserGroupByMarker()؛ وتُغفله طرق القوائم (getUserGroups() وgetRootUserGroups() وgetChildUserGroupsByMarker()).

---