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
  }
]

---