getTemplatePreviews

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

الوصف

تسترجع هذه الطريقة جميع كائنات القالب من واجهة برمجة التطبيقات (API). تعيد Promise التي تحل إلى مصفوفة من كائنات ITemplatesPreviewEntity.

.getTemplatePreviews(

);

مخطط المعلمات

المخطط

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

أمثلة

مثال بسيط

const response = await TemplatePreviews.getTemplatePreviews();

مثال مع السمات

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

مثال على الاستجابة

[
  {
    "id": 3,
    "title": "Preview Templates",
    "proportions": {
      "default": {
        "horizontal": {
          "width": 234,
          "height": 324,
          "alignmentType": "middleBottom",
          "weight": 234
        },
        "vertical": {
          "width": 2,
          "height": 3,
          "alignmentType": "leftTop",
          "weight": 2
        },
        "square": {
          "side": 360,
          "alignmentType": "middleMiddle"
        },
        "default": true
      }
    },
    "identifier": "preview-templates",
    "version": 1,
    "position": 1,
    "isUsed": true
  }
]

مخطط الاستجابة

المخطط: ITemplatesPreviewEntity[]

id: number
المعرف الفريد للموقع.
مثال: 3

title: string
اسم معاينة القالب.
مثال: "قالب المنتج"

proportions: object
كائن يحتوي على معلومات حول نسب معاينة القالب.
مثال:

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

proportions.horizontal: IProportion | null
النسبة الأفقية لمعاينة القالب.
مثال:

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

proportions.horizontal.width: string | number | null
عرض معاينة القالب.
مثال: 100

proportions.horizontal.height: string | number | null
ارتفاع معاينة القالب.
مثال: 200

proportions.horizontal.alignmentType: string
نوع المحاذاة لمعاينة القالب.
مثال: "مركز"

proportions.vertical: IProportion | null
النسبة الرأسية لمعاينة القالب.
مثال:

{
  "width": 2,
  "height": 3,
  "alignmentType": "leftTop"
}

proportions.square: ISquare
النسبة المربعة لمعاينة القالب.
مثال:

{
  "side": 3,
  "alignmentType": "leftTop"
}

proportions.square.side: number | string
طول جانب معاينة القالب المربع، يمكن أن يكون رقمًا أو سلسلة.
مثال: 100

proportions.square.alignmentType: string
نوع المحاذاة لمعاينة القالب المربع.
مثال: "مركز"

identifier: string
المعرف النصي لحقل السجل.
مثال: "preview-templates"

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

position: number
موضع الكائن.
مثال: 1

isUsed: boolean
تشير إلى ما إذا كانت معاينة القالب مستخدمة.
مثال: true

---