getMenusByMarker

O módulo 'Menus' define a estrutura e a navegação do seu site.

Descrição

Ele fornece aos visitantes uma maneira fácil de navegar pelas seções da sua aplicação e encontrar as informações de que precisam.

Este método recupera um único objeto de menu com base em seu marcador (marker) da API. Ele retorna uma Promise que resolve para um único objeto de menu IMenusEntity como um objeto com páginas incluídas.

Menus.getMenusByMarker(

marker, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do menu
exemplo: "main_menu"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IMenusEntity

id: number
O identificador único do menu.
exemplo: 1

identifier: string
O identificador do menu.
exemplo: "main_menu"

localizeInfos: ILocalizeInfo
Os dados do menu, levando em conta a localização.
exemplo:

{
  "title": "menu"
}

pages: IMenusPages[]
Array de páginas do menu.
exemplo:

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

---