Pular para o conteúdo principal

getFilterByMarker

Obtenha um filtro pelo seu marcador (árvore de itens).

Descrição​

Este método recupera um único filtro de conteúdo pelo seu marcador, localizado para o idioma solicitado. Ele retorna uma Promise que resolve para um objeto IContentFilter contendo as informações localizadas do filtro e sua árvore de itens.

Filtros.getFilterByMarker(

marker*, langCode

);

Esquema de parâmetros​

Esquema

marker(obrigatório): string
Marcador do filtro
exemplo: "main"

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

Exemplos​

Exemplo mínimo​

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

Exemplo com atributos​

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

Exemplo de resposta​

{
  "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 resposta​

Esquema: IContentFilter

localizeInfos: ILocalizeInfo
Informações localizadas do filtro no local solicitado.

items: IContentFilterItem[]
Árvore de itens do filtro (itens regulares + itens personalizados em um único array).

items.type: TContentFilterItemType
Tipo do nó da árvore.
exemplo: "page"

items.marker: string | null
Marcador da entidade vinculada, ou null para type=page.
exemplo: "about"

items.url: string | null
URL da página (apenas para type=page; null caso contrário).
exemplo: "about"

items.localizeInfos: ILocalizeInfo
Informações localizadas da entidade vinculada no local solicitado.

items.value: string | null
Valor do nó unificado (por exemplo, valor de desconto, título do atributo); null caso contrário.
exemplo: "10"

items.position: number
Posição numérica (por nível).
exemplo: 1

items.children: IContentFilterItem[]
Nós da árvore aninhados (itens regulares e personalizados em um único array).