getMenusByMarker

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

الوصف

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

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

Menus.getMenusByMarker(

marker, langCode

);

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

المخطط

marker(مطلوب): string
علامة القائمة
مثال: "main_menu"

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

أمثلة

مثال بسيط

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

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

{
  "id": 1,
  "identifier": "menu",
  "localizeInfos": {
    "title": "menu"
  },
  "pages": [
    {
      "id": null,
      "pageUrl": null,
      "localizeInfos": {},
      "attributeValues": {},
      "parentId": null,
      "position": 1
    }
  ]
}

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

المخطط: IMenusEntity

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

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

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

{
  "title": "menu"
}

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

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

---