Saltar al contenido principal

getFilterByMarker

Obtén un filtro por su marcador (árbol de elementos).

Descripción​

Este método recupera un único filtro de contenido por su marcador, localizado al idioma solicitado. Devuelve una Promesa que se resuelve en un objeto IContentFilter que contiene la información localizada del filtro y su árbol de elementos.

Filtros.getFilterByMarker(

marker*, langCode

);

Esquema de parámetros​

Esquema

marker(requerido): string
Marcador del filtro
ejemplo: "main"

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

Ejemplos​

Ejemplo mínimo​

const response = await Filters.getFilterByMarker('main');

Ejemplo con atributos​

const response = await Filters.getFilterByMarker('main', 'en_US');

Ejemplo de respuesta​

{
  "localizeInfos": {
    "title": "Filter"
  },
  "items": [
    {
      "type": "page",
      "marker": null,
      "url": "blog",
      "localizeInfos": {
        "title": "Blog",
        "menuTitle": "Blog"
      },
      "value": null,
      "position": 1,
      "children": []
    },
    {
      "type": "page",
      "marker": null,
      "url": "blog1",
      "localizeInfos": {
        "title": "Blog 1",
        "menuTitle": "Blog 1"
      },
      "value": null,
      "position": 2,
      "children": []
    },
    {
      "type": "page",
      "marker": null,
      "url": "catalog",
      "localizeInfos": {
        "title": "Catalog",
        "menuTitle": "Catalog"
      },
      "value": null,
      "position": 3,
      "children": []
    },
    "..."
  ]
}

Esquema de respuesta​

Esquema: IContentFilter

localizeInfos: ILocalizeInfo
Información localizada del filtro en la localidad solicitada.

items: IContentFilterItem[]
Árbol de elementos del filtro (elementos regulares + elementos personalizados en un solo array).

items.type: TContentFilterItemType
Tipo de nodo del árbol.
ejemplo: "page"

items.marker: string | null
Marcador de la entidad vinculada, o null para tipo=page.
ejemplo: "about"

items.url: string | null
URL de la página (solo para tipo=page; null de lo contrario).
ejemplo: "about"

items.localizeInfos: ILocalizeInfo
Información localizada de la entidad vinculada en la localidad solicitada.

items.value: string | string[] | null
Valor unificado del nodo: un array de valores en rango para un atributo de rango, un título resuelto para un atributo de checkbox legado, el valor de descuento para descuento/descuento-personal/bono, el id del objeto para producto/admin/método-de-pago, y null para una página.
ejemplo: ["25", "50", "75"]

items.position: number
Posición numérica (por nivel).
ejemplo: 1

items.children: IContentFilterItem[]
Nodos del árbol anidados (elementos regulares y personalizados en un solo array).