Saltar al contenido principal

searchPage

Búsqueda rápida de objetos de página con salida limitada.

Descripción​

Este método realiza una búsqueda rápida de objetos de página basada en una consulta de texto (nombre). Devuelve una Promesa que se resuelve en un array de objetos IPagesEntity o un array vacío [].

Pages.searchPage(

name*, url, langCode

);

Esquema de parámetros​

Esquema

name(required): string
Texto para buscar objetos de página (la búsqueda se realiza en el campo título del objeto localizeInfos teniendo en cuenta el idioma)
ejemplo: "Sobre nosotros"

url: string
URL de la página
ejemplo: "catalog"

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

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

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

Ejemplo de respuesta​

[
  {
    "id": 10,
    "parentId": null,
    "pageUrl": "catalog",
    "depth": 0,
    "localizeInfos": {
      "title": "Catalog",
      "menuTitle": "Catalog",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "blocks": [
      "product_block",
      "test"
    ],
    "type": "catalog_page",
    "templateIdentifier": "template",
    "attributeSetIdentifier": "page",
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "catalog text",
        "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 respuesta​

Esquema: IPagesEntity[]

id: number
El identificador del objeto.
ejemplo: 8

parentId: number | null
El id de la página padre, si contiene null, entonces es la página de nivel superior.
ejemplo: 10

pageUrl: string
URL única de la página.
ejemplo: "blog"

depth: number
Profundidad de anidación de la página en relación con parentId.
ejemplo: 10

localizeInfos: ILocalizeInfo
El nombre de la página, teniendo en cuenta la localización.
ejemplo:

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

isVisible: boolean
Un signo de la visibilidad de la página.
ejemplo: true

type: Types
Tipo de página.
ejemplo: "common_page"

templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: "template"

attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "page"

attributeValues: AttributeType
Array de valores de atributos del índice (representado como un par de id de atributo de usuario: valor de atributo).
ejemplo:

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

isSync: boolean
Indicación de la indexación de la página.
ejemplo: true

template: object
Objeto de plantilla.
ejemplo:

position: number
Número del ítem (para ordenar).
ejemplo: 2

config: Record<string, number>
Configuraciones de salida para páginas de catálogo.
ejemplo:

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

products: number
El número de productos vinculados a la página.
ejemplo: 0

childrenCount: string
Conteo de hijos.
ejemplo: 1

blocks: IBlockEntity[] | string[]
bloques.
ejemplo:

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Template",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}

moduleFormConfigs: Array<IFormConfig>
Configuraciones de formularios de módulo vinculadas a la página.

total: string
Número total de productos vinculados a la página.
ejemplo: "10"

categoryPath: string
Cadena de ruta de categoría.
ejemplo: "catalog"