getPageByUrl

Obtendo um único objeto de página com informações sobre formulários, blocos e menus anexados à página pela URL.

Descrição

Este método recupera um único objeto de página com base em sua URL (url) da API. Ele retorna uma Promise que resolve para o objeto da página, com o objeto específico dependendo do tipo de página que está sendo retornada.

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

Esquema de parâmetros

Esquema

url(obrigatório): string
URL da página
exemplo: "sobre"

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

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

{
  "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 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 consideração a localização.
exemplo:

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

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

type: Types
Tipo de 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 de 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

---