getRootPages

الحصول على جميع كائنات الصفحات من المستوى الأعلى (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Schema

langCode: string
رمز اللغة
مثال: en_US

تسترجع هذه الطريقة جميع كائنات الصفحات من المستوى الأعلى من واجهة برمجة التطبيقات. تعيد Promise التي تحل إلى مصفوفة من كائنات الصفحات من المستوى الأعلى أو مصفوفة فارغة [] إذا لم يكن هناك بيانات.

مثال على الإرجاع:

[
  {
    "id": 1,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "مدونة",
      "menuTitle": "مدونة",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "forUsualPage",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "بعض النص",
        "position": 0
      }
    }
  }
]

Schema

id: number
معرف الكائن
مثال: 1764

parentId number
معرف الصفحة الأم، إذا كان null، فهي صفحة من المستوى الأعلى
مثال: null

config Record<string, number>
إعدادات الإخراج لصفحات الكتالوج
مثال:

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

pageUrl string
رابط الصفحة الفريد

depth number
عمق تعشيش الصفحة بالنسبة إلى parentId
مثال: 3

localizeInfos: Record<string, any>
وصف json لكائن بيانات الصفحة الرئيسية مع الأخذ في الاعتبار اللغة "en_US" (على سبيل المثال)
مثال:

{
  "en_US": {
    "title": "كتالوج",
    "plainContent": "محتوى للكتالوج",
    "htmlContent": "<b>محتوى للكتالوج</b>",
    "menuTitle": "كتالوج"
  }
}

isVisible: boolean
علامة رؤية الصفحة
مثال: true

products number
عدد المنتجات المرتبطة بالصفحة
مثال: 0

attributeSetId: number
معرف مجموعة السمات
مثال: 7

forms
مصفوفة من قيم معرف كائن FormEntity المرتبطة بالصفحة (اختياري)

blocks
مصفوفة من قيم معرف كائن BlockEntity المرتبطة بالصفحة (اختياري)

isSync: boolean
مؤشر فهرسة الصفحة (true أو false)
مثال: false

templateIdentifier: string
معرف مخصص للقالب المرتبط
مثال: my-template

attributeValues: Record<string, string>
مصفوفة من قيم السمات من الفهرس (مقدمة كزوج من معرف السمة المخصص: قيمة السمة)
مثال:

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

position: number
رقم الموضع للفرز (اختياري)
مثال: 192

type: string
نوع الصفحة
مثال: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

childrenCount: number
عدد الصفحات المتداخلة
مثال: 0