Aller au contenu principal

getRootPages

Récupérer tous les objets de page de niveau supérieur (parentId = null).

Description​

Cette méthode récupère tous les objets de page de niveau supérieur depuis l'API. Elle renvoie une promesse qui se résout en un tableau d'objets de page de niveau supérieur IPagesEntity ou un tableau vide [] s'il n'y a pas de données.

Pages.getRootPages(langCode);

Schéma des paramètres​

Schéma

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await Pages.getRootPages();

Exemple de réponse​

[
  {
    "id": 10,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "catalog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Catalogue",
      "menuTitle": "Catalogue",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 3,
    "childrenCount": 0,
    "type": "catalog_page",
    "position": 5,
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "texte du catalogue",
        "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": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Modèle",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  },
  {
    "id": 8,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Blog",
      "menuTitle": "Blog",
      "htmlContent": "",
      "plainContent": ""
    },
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "common_page",
    "position": 3,
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "quelques textes",
        "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": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Modèle",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  }
]

Schéma de réponse​

Schéma : IPagesEntity[]

id: number
L'identifiant de l'objet.
exemple : 8

parentId: number | null
L'id de la page parente, s'il contient null, alors c'est la page de niveau supérieur.
exemple : 10

pageUrl: string
Url unique de la page.
exemple : "blog"

depth: number
Profondeur de la page par rapport à parentId.
exemple : 10

localizeInfos: ILocalizeInfo
Le nom de la page, en tenant compte de la localisation.
exemple :

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

isVisible: boolean
Un signe de visibilité de la page.
exemple : true

type: Types
Type de page.
exemple :

"common_page"

templateIdentifier: string | null
Id utilisateur du modèle lié.
exemple : "template"

attributeSetIdentifier: string | null
Id de l'ensemble d'attributs.
exemple : "page"

attributeValues: AttributeType
Tableau des valeurs d'attributs de l'index (représenté comme une paire d'id d'attribut utilisateur : valeur d'attribut).
exemple :

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

isSync: boolean
Indication de l'indexation de la page.
exemple : true

template: any
Objet modèle.

position: number
Numéro de l'élément (pour le tri).
exemple : 2

config: any
Paramètres de sortie pour les pages de catalogue.
exemple :

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

products: number
Le nombre de produits liés à la page.
exemple : 0

childrenCount: number
Nombre d'enfants.
exemple : 1