getMenusByMarker

Le module 'Menus' définit la structure et la navigation de votre site.

Description

Il offre aux visiteurs un moyen facile de naviguer à travers les sections de votre application et de trouver les informations dont ils ont besoin.

Cette méthode récupère un seul objet de menu basé sur son marqueur (marker) depuis l'API. Elle renvoie une Promesse qui se résout en un seul objet de menu IMenusEntity sous forme d'objet avec des pages incluses.

Menus.getMenusByMarker(

marker, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
Marqueur de menu
exemple : "main_menu"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples

Exemple minimal

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

Exemple de réponse

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

Schéma de réponse

Schéma : IMenusEntity

id: number
L'identifiant unique du menu.
exemple : 1

identifier: string
L'identifiant du menu.
exemple : "main_menu"

localizeInfos: ILocalizeInfo
Les données du menu, en tenant compte de la localisation.
exemple :

{
  "title": "menu"
}

pages: IMenusPages[]
Tableau des pages de menu.
exemple :

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

---