getBlocks

الحصول على جميع كائنات الكتل

Blocks.getBlocks(type, langCode, offset, limit)

const value = await Blocks.getBlocks('forTextBlock')

المخطط

type:* BlockType
القيم المتاحة: forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service
مثال: forTextBlock

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

offset: number
معامل للتصفح. القيمة الافتراضية 0
مثال: 0

limit: number
معامل للتصفح. القيمة الافتراضية 30
مثال: 30

تُرجع هذه الطريقة مصفوفة من جميع كائنات الكتل والإجمالي.

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

{
  "total": 100,
  "items": [
    {
      "id": 1,
      "localizeInfos": {
        "title": "Block"
      },
      "version": 0,
      "position": 1,
      "identifier": "block",
      "type": "forTextBlock",
      "templateIdentifier": null,
      "isVisible": true,
      "attributeValues": {}
    }
  ]
}

المخطط

total: number
إجمالي عدد السجلات الموجودة
مثال: 100

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

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

localizeInfos: CommonLocalizeInfos
اسم الكتلة مع الترجمة
مثال:

{
  "en_US": {
    "title": "My block"
  }
}

customSettings: BlockCustomSettings
إعدادات مخصصة لأنواع الكتل المختلفة
مثال:

{
  "sliderDelay": 0,
  "sliderDelayType": "",
  "productQuantity": 4,
  "productSortType": "By_ID",
  "productSortOrder": "Descending",
  "productCountElementsPerRow": 10,
  "similarProductRules": [
    {
      "property": "Descending",
      "includes": "",
      "keywords": "",
      "strict": ""
    }
  ]
}

version: number
رقم إصدار الكائن
مثال: 10

identifier: string
معرف نصي لسجل الحقل
مثال: catalog
القيمة الافتراضية: marker

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

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

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

type: string
نوع الكتلة
مثال: forNewsPage

templateIdentifier: string
معرف القالب المستخدم بواسطة الكتلة (يمكن أن يكون null)
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
مثال: null

---