getTemplatePreviews

Получение всех объектов шаблонов

TemplatePreviews.getTemplatePreviews(langCode)

const value = await TemplatePreviews.getTemplatePreviews()

Схема

langCode: строка
Код языка. По умолчанию: "en_US"
пример: "en_US"

Этот метод извлекает все объекты шаблонов из API. Он возвращает Promise, который разрешается в массив объектов шаблонов TemplatePreviewsEntity.

Пример возвращаемого значения:

[
  {
    "id": 3,
    "title": "Предварительные шаблоны",
    "proportions": {
      "default": {
        "horizontal": {
          "width": 234,
          "height": 324,
          "alignmentType": "middleBottom"
        },
        "vertical": {
          "width": 2,
          "height": 3,
          "alignmentType": "leftTop"
        },
        "square": {
          "side": 3,
          "alignmentType": "leftTop"
        }
      }
    },
    "identifier": "preview-templates",
    "version": 0,
    "attributeValues": {},
    "position": 1,
    "isUsed": false
  }
]

Схема

id: число
Уникальный идентификатор позиции.
пример: 3

version: число
Номер версии объекта.
пример: 1

identifier: строка
Текстовый идентификатор для поля записи.
пример: "preview-templates"

attributeValues: AttributeType
Значения атрибутов из индекса.
пример:

{}

attributeSetIdentifier: строка
Текстовый идентификатор, используемый для набора атрибутов.
пример: "attribute_set_1"

title: строка
Название предварительного шаблона.
пример: "Шаблон продукта"

position: число
Позиция объекта.
пример: 1

proportions: объект
Объект содержит информацию о пропорциях предварительного шаблона.
пример:

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "middleBottom"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "leftTop"
    },
    "square": {
      "side": 3,
      "alignmentType": "leftTop"
    }
  }
}

---