getPageByUrl

Obteniendo un único objeto de página con información sobre formularios, bloques y menús adjuntos a la página por URL.

Descripción

Este método recupera un único objeto de página basado en su URL (url) desde la API. Devuelve una Promesa que se resuelve en el objeto de página, siendo el objeto específico dependiendo del tipo de página que se esté devolviendo.

Páginas.getPageByUrl( url*, langCode );

Esquema de parámetros

Esquema

url(required): string
URL de la página
ejemplo: "about"

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

Ejemplos

Ejemplo mínimo

const response = await Pages.getPageByUrl('shop');

Ejemplo con atributos

const response = await Pages.getPageByUrl('shop', 'en_US');

Ejemplo de respuesta

{
  "id": 9,
  "parentId": 8,
  "pageUrl": "blog1",
  "depth": 1,
  "localizeInfos": {
    "title": "Blog 1",
    "menuTitle": "Blog 1",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": null,
  "attributeSetIdentifier": null,
  "attributeValues": {},
  "isSync": false
}

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 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: any
Objeto de plantilla.

position: number
Número de ítem (para ordenamiento).
ejemplo: 2

config: any
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: number
Conteo de hijos.
ejemplo: 1

---