getTemplatePreviews

Tüm şablon nesnelerini alma.

Açıklama

Bu yöntem, API'den tüm şablon nesnelerini alır. Bir Promise döndürür ve bu Promise, ITemplatesPreviewEntity şablon nesnelerinin bir dizisi ile çözülür.

TemplatePreviews.getTemplatePreviews(

langCode

);

Parametreler şeması

Şema

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

Örnekler

Minimal örnek

const response = await TemplatePreviews.getTemplatePreviews();

Özelliklerle örnek

const response = await TemplatePreviews.getTemplatePreviews('en_US');

Örnek yanıt

[
  {
    "id": 3,
    "title": "Önizleme Şablonları",
    "proportions": {
      "default": {
        "horizontal": {
          "width": 234,
          "height": 324,
          "alignmentType": "ortaAlt"
        },
        "vertical": {
          "width": 2,
          "height": 3,
          "alignmentType": "solÜst"
        },
        "square": {
          "side": 3,
          "alignmentType": "solÜst"
        }
      }
    },
    "identifier": "preview-templates",
    "version": 0,
    "attributeValues": {},
    "position": 1,
    "isUsed": false
  }
]

Yanıt şeması

Şema: ITemplatesPreviewEntity[]

id: number
Pozisyonun benzersiz tanımlayıcısı.
örnek: 3

title: string
Şablon önizlemesinin adı.
örnek: "Ürün Şablonu"

proportions: object
Nesne, şablon önizlemesi için oran bilgilerini içerir.
örnek:

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "ortaAlt"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "solÜst"
    },
    "square": {
      "side": 3,
      "alignmentType": "solÜst"
    }
  }
}

proportions.horizontal: IProportion | null
Şablon önizlemesinin yatay oranı.
örnek:

{
  "width": 234,
  "height": 324,
  "alignmentType": "ortaAlt"
}

proportions.horizontal.width: string | number | null
Şablon önizlemesinin genişliği.
örnek: 100

proportions.horizontal.height: string | number | null
Şablon önizlemesinin yüksekliği.
örnek: 200

proportions.horizontal.alignmentType: string
Şablon önizlemesinin hizalama türü.
örnek: "orta"

proportions.vertical: IProportion | null
Şablon önizlemesinin dikey oranı.
örnek:

{
  "width": 2,
  "height": 3,
  "alignmentType": "solÜst"
}

proportions.vertical.width: string | number | null
Şablon önizlemesinin genişliği.
örnek: 100

proportions.vertical.height: string | number | null
Şablon önizlemesinin yüksekliği.
örnek: 200

proportions.vertical.alignmentType: string
Şablon önizlemesinin hizalama türü.
örnek: "orta"

proportions.square: ISquare
Şablon önizlemesinin kare oranı.
örnek:

{
  "side": 3,
  "alignmentType": "solÜst"
}

proportions.square.side: number | string
Kare şablon önizlemesinin kenar uzunluğu, sayı veya dize olabilir.
örnek: 100

proportions.square.alignmentType: string
Kare şablon önizlemesinin hizalama türü.
örnek: "orta"

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "preview-templates"

version: number
Nesnenin sürüm numarası.
örnek: 1

attributeValues: AttributeType
İndeksten alınan özellik değerleri.
örnek:

position: number
Nesnenin pozisyonu.
örnek: 1

attributeSetIdentifier: string | null
Bir dizi özellik için kullanılan metin tanımlayıcı.
örnek: "attribute_set_1"

---