getRootPages

Tüm üst düzey sayfa nesnelerini almak (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Şema

langCode: string
dil kodu
örnek: en_US

Bu yöntem, API'den tüm üst düzey sayfa nesnelerini alır. Bir Promise döner ve bu Promise, üst düzey sayfa nesnelerinin bir dizisine veya veri yoksa boş bir dizi [] döner.

Örnek dönüş:

[
  {
    "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
      }
    }
  }
]

Şema

id: number
n nesne tanımlayıcısı
örnek: 1764

parentId number
üst sayfa tanımlayıcısı, eğer null ise, bu bir üst düzey sayfadır
örnek: null

config Record<string, number>
katalog sayfaları için çıktı ayarları
örnek:

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

pageUrl string
benzersiz sayfa URL'si

depth number
parentId'ye göre sayfa iç içe geçme derinliği
örnek: 3

localizeInfos: Record<string, any>
dilin "en_US" olduğu göz önüne alındığında ana sayfa veri nesnesinin json tanımı (örneğin)
örnek:

{
  "en_US": {
    "title": "Katalog",
    "plainContent": "Katalog için içerik",
    "htmlContent": "<b>Katalog için içerik</b>",
    "menuTitle": "Katalog"
  }
}

isVisible: boolean
Sayfa görünürlük bayrağı
örnek: true

products number
Sayfaya bağlı ürün sayısı
örnek: 0

attributeSetId: number
özellik seti tanımlayıcısı
örnek: 7

forms
Sayfaya bağlı FormEntity nesne tanımlayıcı değerlerinin dizisi (isteğe bağlı)

blocks
Sayfaya bağlı BlockEntity nesne tanımlayıcı değerlerinin dizisi (isteğe bağlı)

isSync: boolean
sayfa dizinleme göstergesi (true veya false)
örnek: false

templateIdentifier: string
bağlı şablonun özel tanımlayıcısı
örnek: my-template

attributeValues: Record<string, string>
indeksten gelen özellik değerlerinin dizisi (özel özellik tanımlayıcı: özellik değeri çifti olarak sunulur)
örnek:

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

position: number
sıralama için pozisyon numarası (isteğe bağlı)
örnek: 192

type: string
Sayfa türü
örnek: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: number
iç içe geçmiş sayfa sayısı
örnek: 0