Saltar al contenido principal

getMenusByMarker

El módulo 'Menus' define la estructura y navegación de su sitio.

Descripción

Proporciona a los visitantes una forma fácil de moverse a través de las secciones de su aplicación y encontrar la información que necesitan.

Este método recupera un único objeto de menú basado en su marcador (marker) desde la API. Devuelve una Promesa que se resuelve en un único objeto de menú IMenusEntity como un objeto con páginas incluidas.

Menus.getMenusByMarker(

marker, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del menú
ejemplo: "main_menu"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: IMenusEntity

id: number
El identificador único del menú.
ejemplo: 1

identifier: string
El identificador del menú.
ejemplo: "main_menu"

localizeInfos: ILocalizeInfo
Los datos del menú, teniendo en cuenta la localización.
ejemplo:

{
"title": "menu"
}

pages: IMenusPages[]
Array de páginas del menú.
ejemplo:

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