getRootPages

Lấy tất cả các đối tượng trang cấp cao nhất (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Schema

langCode: chuỗi
mã ngôn ngữ
ví dụ: en_US

Phương thức này lấy tất cả các đối tượng trang cấp cao nhất từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng trang cấp cao nhất hoặc một mảng rỗng [] nếu không có dữ liệu.

Ví dụ trả về:

[
  {
    "id": 1,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Blog",
      "menuTitle": "Blog",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "forUsualPage",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "some text",
        "position": 0
      }
    }
  }
]

Schema

id: số
định danh đối tượng
ví dụ: 1764

parentId số
định danh trang cha, nếu null, đây là trang cấp cao nhất
ví dụ: null

config Record<string, number>
cài đặt đầu ra cho các trang danh mục
ví dụ:

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

pageUrl chuỗi
URL trang duy nhất

depth số
độ sâu lồng ghép của trang so với parentId
ví dụ: 3

localizeInfos: Record<string, any>
mô tả json của đối tượng dữ liệu trang chính với ngôn ngữ "en_US" (ví dụ)
ví dụ:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Nội dung cho danh mục",
    "htmlContent": "<b>Nội dung cho danh mục</b>",
    "menuTitle": "Danh mục"
  }
}

isVisible: boolean
cờ hiển thị trang
ví dụ: true

products số
Số lượng sản phẩm liên kết với trang
ví dụ: 0

attributeSetId: số
định danh bộ thuộc tính
ví dụ: 7

forms
Mảng các giá trị định danh đối tượng FormEntity liên kết với trang (tùy chọn)

blocks
Mảng các giá trị định danh đối tượng BlockEntity liên kết với trang (tùy chọn)

isSync: boolean
cờ chỉ thị việc lập chỉ mục trang (true hoặc false)
ví dụ: false

templateIdentifier: chuỗi
Định danh tùy chỉnh của mẫu liên kết
ví dụ: my-template

attributeValues: Record<string, string>
Mảng các giá trị thuộc tính từ chỉ mục (được trình bày dưới dạng cặp định danh thuộc tính tùy chỉnh: giá trị thuộc tính)
ví dụ:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

position: số
số thứ tự để sắp xếp (tùy chọn)
ví dụ: 192

type: chuỗi
Loại trang
ví dụ: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: số
số lượng trang lồng ghép
ví dụ: 0