searchPage

Busca rápida por objetos de página com saída limitada.

Descrição

Este método realiza uma busca rápida por objetos de página com base em uma consulta de texto (nome). Ele retorna uma Promise que se resolve em um array de objetos IPagesEntity ou um array vazio [].

Pages.searchPage(

name*, url, langCode

);

Esquema de parâmetros

Esquema

name(obrigatório): string
Texto para buscar objetos de página (a busca é realizada no campo título do objeto localizeInfos, levando em conta o idioma)
exemplo: "Sobre Nós"

url: string
URL da página
exemplo: "catalog"

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

Exemplos

Exemplo mínimo

const response = await Pages.searchPage('cup');

Exemplo com atributos

const response = await Pages.searchPage('cup', 'en_US');

Exemplo de resposta

[
  {
    "id": 10,
    "parentId": null,
    "pageUrl": "catalog",
    "depth": 0,
    "localizeInfos": {
      "title": "Catálogo",
      "menuTitle": "Catálogo",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "blocks": [
      "product_block",
      "test"
    ],
    "type": "catalog_page",
    "templateIdentifier": "template",
    "attributeSetIdentifier": "page",
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "texto do catálogo",
        "position": 0,
        "additionalFields": []
      },
      "number": {
        "type": "integer",
        "value": 0,
        "position": 1,
        "additionalFields": []
      },
      "real": {
        "type": "real",
        "value": "",
        "position": 2,
        "additionalFields": []
      },
      "float": {
        "type": "float",
        "value": 0,
        "position": 3,
        "additionalFields": []
      }
    },
    "moduleFormConfigs": [],
    "isSync": true,
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Template",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  }
]

Esquema de resposta

Esquema: IPagesEntity[]

id: number
O identificador do objeto.
exemplo: 8

parentId: number | null
O id da página pai, se contiver null, então é a página de nível superior.
exemplo: 10

pageUrl: string
URL única da página.
exemplo: "blog"

depth: number
Profundidade de aninhamento da página em relação ao parentId.
exemplo: 10

localizeInfos: ILocalizeInfo
O nome da página, levando em conta a localização.
exemplo:

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

type: Types
Tipo da página.
exemplo:

"common_page"

templateIdentifier: string | null
Id do usuário do template vinculado.
exemplo: "template"

attributeSetIdentifier: string | null
Id do conjunto de atributos.
exemplo: "page"

attributeValues: AttributeType
Array de valores de atributos do índice (representado como um par de id de atributo do usuário: valor do atributo).
exemplo:

{
  "text": {
    "type": "string",
    "value": "algum texto",
    "position": 0,
    "additionalFields": []
  }
}

isSync: boolean
Indicação de indexação da página.
exemplo: true

template: any
Objeto template.

position: number
Número do item (para ordenação).
exemplo: 2

config: any
Configurações de saída para páginas de catálogo.
exemplo:

{
  "rowsPerPage": 1,
  "productsPerRow": 1
}

products: number
O número de produtos vinculados à página.
exemplo: 0

childrenCount: number
Contagem de filhos.
exemplo: 1

---