getTemplatePreviews

Lấy tất cả các đối tượng mẫu

TemplatePreviews.getTemplatePreviews(langCode)

const value = await TemplatePreviews.getTemplatePreviews()

Schema

langCode: string
Tham số tùy chọn mã ngôn ngữ
ví dụ: en_US

Phương thức này lấy tất cả các đối tượng mẫu từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng mẫu TemplatePreviewsEntity.

Ví dụ trả về:

[
  {
    "id": 1,
    "version": 0,
    "identifier": "preview-templates",
    "attributeValues": {
      "en_US": {
        "marker": {
          "value": "",
          "type": "string",
          "position": 1,
          "isProductPreview": false,
          "isIcon": false,
          "attributeFields": {
            "marker": {
              "type": "string",
              "value": "test"
            }
          }
        }
      }
    },
    "attributeSetIdentifier": "my-set",
    "proportion": {
      "vertical": {
        "width": "2",
        "height": "3",
        "alignmentType": "leftTop",
        "marker": "v"
      },
      "horizontal": {
        "width": "234",
        "height": "324",
        "alignmentType": "middleBottom",
        "marker": "h"
      },
      "square": {
        "side": "3",
        "alignmentType": "middleBottom",
        "marker": "s"
      }
    },
    "title": "Preview Templates",
    "position": 1
  }
]

Schema

id: number
định danh đối tượng
ví dụ: 1764

version number
số phiên bản của đối tượng đã được sửa đổi
ví dụ: 10

identifier: string
định danh văn bản cho một trường trong bản ghi
ví dụ: catalog

proportion ITemplateProportionType
các tham số tỷ lệ mẫu
ví dụ:

{
  "horizontal": {
    "height": 200,
    "weight": 10,
    "marker": "horizontal",
    "title": "Horizontal",
    "alignmentType": "left"
  },
  "vertical": {
    "height": 10,
    "weight": 200,
    "marker": "vertical",
    "title": "Vertical",
    "alignmentType": "left"
  },
  "square": {
    "marker": "square",
    "title": "Square",
    "slide": 3,
    "alignmentType": "center"
  }
}

title: string
tên mẫu
ví dụ: mẫu trang

position object
số thứ tự vị trí
ví dụ: 0

positionId: number
định danh đối tượng vị trí
ví dụ: 12