getMenusByMarker

الحصول على قائمة بواسطة علامتها.

الوصف

يجلب قائمة وصفحاتها حسب علامة القائمة. يُعيد IMenusEntity.

.getMenusByMarker(

,

);

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

المخطط

marker(required): string
علامة القائمة.
مثال: "main_menu"

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

أمثلة

مثال بسيط

const response = await Menus.getMenusByMarker('main_menu');

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

{
  "id": 1,
  "identifier": "main_menu",
  "localizeInfos": {
    "title": "menu"
  },
  "pages": [
    {
      "id": 8,
      "pageUrl": "blog",
      "localizeInfos": {
        "title": "Blog",
        "menuTitle": "Blog",
        "htmlContent": "",
        "plainContent": ""
      },
      "attributeValues": {},
      "parentId": null,
      "parentType": null,
      "position": 1,
      "itemType": "page",
      "children": [
        {
          "id": 9,
          "pageUrl": "blog1",
          "localizeInfos": {
            "title": "Blog 1",
            "menuTitle": "Blog 1",
            "htmlContent": "",
            "plainContent": ""
          },
          "attributeValues": {},
          "parentId": 8,
          "parentType": "page",
          "position": 1,
          "itemType": "page",
          "children": []
        }
      ]
    },
    {
      "id": 10,
      "pageUrl": "catalog",
      "localizeInfos": {
        "title": "Catalog",
        "menuTitle": "Catalog",
        "htmlContent": "",
        "plainContent": ""
      },
      "attributeValues": {},
      "parentId": null,
      "parentType": null,
      "position": 2,
      "itemType": "page",
      "children": []
    }
  ]
}

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

المخطط: IMenusEntity

id: number
معرّف القائمة.
مثال: 1

identifier: string
علامة القائمة.
مثال: "main_menu"

localizeInfos: ILocalizeInfo
بيانات القائمة المترجمة.
مثال:

{
  "title": "menu"
}

pages: IMenusPages[]
الصفحات في القائمة.
مثال:

[
  {
    "id": null,
    "pageUrl": null,
    "localizeInfos": {},
    "attributeValues": {},
    "parentId": null,
    "position": 1
  }
]

pages.children: IMenusPages[]
عناصر القائمة المتداخلة (الصفحات الفرعية).
مثال:

[
  {
    "id": null,
    "pageUrl": null,
    "localizeInfos": {},
    "attributeValues": {},
    "parentId": null,
    "position": 1
  }
]

pages.id: number | null
معرّف الصفحة، أو العنصر المخصّص عندما تكون قيمة itemType هي custom.
مثال: 1

pages.pageUrl: string | null
عنوان URL (العلامة) للصفحة؛ وللعنصر المخصّص (itemType: "custom") القيمة المُعيَّنة للعنصر، مثل رابط خارجي.
مثال: "about"

pages.localizeInfos: ILocalizeInfo
البيانات المترجمة للعنصر: العنوان وعنوان القائمة والمحتوى.
مثال:

{
  "title": "menu"
}

pages.attributeValues: IAttributeValues
قيم سمات الصفحة، مفهرسة حسب علامة السمة.
مثال:

{
  "color": {
    "type": "string",
    "value": "red",
    "isIcon": false,
    "position": 0,
    "additionalFields": {}
  }
}

pages.position: number
الموضع المستخدم للفرز.
مثال: 1

pages.parentId: number | null
معرّف عنصر القائمة الأصل؛ null للعنصر في المستوى الأعلى.
مثال: null

pages.parentType: 'page' | 'custom' | null
نوع العنصر الأب: page أو custom؛ null (مع parentId: null) للعنصر في المستوى الأعلى. تتداخل معرّفات الصفحات ومعرّفات العناصر المخصّصة، لذا تحتاج إلى هذا الحقل لتحديد العنصر الأب.
مثال: null

pages.itemType: 'page' | 'custom'
نوع هذا العنصر: page أو custom. تحمل العناصر الفرعية لهذا العنصر هذه القيمة في parentType.
مثال: "page"

---