getMenusByMarker

تحدد وحدة "Menus" هيكل وتنقل موقعك.

الوصف

توفر للزوار وسيلة سهلة للتنقل عبر أقسام تطبيقك والعثور على المعلومات التي يحتاجونها.

تسترجع هذه الطريقة كائن قائمة واحد بناءً على علامته (marker) من واجهة برمجة التطبيقات (API). تعيد Promise التي تحل إلى كائن قائمة واحد IMenusEntity ككائن مع الصفحات المضمنة.

Menus.getMenusByMarker(

marker*, langCode

);

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

المخطط

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

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

أمثلة

مثال بسيط

const response = await Menus.getMenusByMarker('my-marker')

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

{
  "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
المعرف الفريد للقائمة.
مثال: 1

pages.pageUrl: string | null
سلسلة عنوان URL للصفحة.
مثال: "about"

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

{
  "title": "menu"
}

pages.attributeValues: IAttributeValues
مجموعة السمات.
مثال:

{
  "color": "red",
  "size": "large"
}

pages.position: number
موضع القائمة.
مثال: 1

pages.parentId: number | null
معرف الوالد للقائمة.
مثال: null

pages.parentType: 'page' | 'custom' | null
نوع العنصر الأب: page لصفحة قائمة، custom لعنصر مخصص؛ null مع parentId يعني المستوى الأعلى. تتداخل معرفات الصفحات ومعرفات العناصر المخصصة، لذا فإن الوالد غير واضح بدون ذلك.
مثال: null

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

---