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

---