getAllTemplates

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

الوصف

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

Templates.getAllTemplates(

langCode

);

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

المخطط

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

أمثلة

مثال بسيط

const response = await Templates.getAllTemplates();

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

const response = await Templates.getAllTemplates('en_US');

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

{
  "frequently_ordered_block": [
    {
      "id": 7,
      "attributeSetIdentifier": null,
      "title": "Default frequently ordered block template",
      "generalTypeId": 24,
      "identifier": "frequently_ordered_block_default",
      "version": 0,
      "generalTypeName": "frequently_ordered_block",
      "attributeValues": {},
      "position": 12
    }
  ],
  "recently_viewed_block": [
    {
      "id": 10,
      "attributeSetIdentifier": null,
      "title": "Default recently viewed block template",
      "generalTypeId": 27,
      "identifier": "recently_viewed_block_default",
      "version": 0,
      "generalTypeName": "recently_viewed_block",
      "attributeValues": {},
      "position": 9
    }
  ],
  "trending_block": [
    {
      "id": 9,
      "attributeSetIdentifier": null,
      "title": "Default trending block template",
      "generalTypeId": 26,
      "identifier": "trending_block_default",
      "version": 0,
      "generalTypeName": "trending_block",
      "attributeValues": {},
      "position": 10
    }
  ],
  "slider_block": [
    {
      "id": 8,
      "attributeSetIdentifier": null,
      "title": "Default slider block template",
      "generalTypeId": 25,
      "identifier": "slider_block_default",
      "version": 0,
      "generalTypeName": "slider_block",
      "attributeValues": {},
      "position": 11
    }
  ],
  "wishlist_similar_block": [
    {
      "id": 15,
      "attributeSetIdentifier": null,
      "title": "Default wishlist similar block template",
      "generalTypeId": 32,
      "identifier": "wishlist_similar_block_default",
      "version": 0,
      "generalTypeName": "wishlist_similar_block",
      "attributeValues": {},
      "position": 4
    }
  ],
  "cart_similar_block": [
    {
      "id": 14,
      "attributeSetIdentifier": null,
      "title": "Default cart similar block template",
      "generalTypeId": 31,
      "identifier": "cart_similar_block_default",
      "version": 0,
      "generalTypeName": "cart_similar_block",
      "attributeValues": {},
      "position": 5
    }
  ],
  "cart_complement_block": [
    {
      "id": 13,
      "attributeSetIdentifier": null,
      "title": "Default cart complement block template",
      "generalTypeId": 30,
      "identifier": "cart_complement_block_default",
      "version": 0,
      "generalTypeName": "cart_complement_block",
      "attributeValues": {},
      "position": 6
    }
  ],
  "personal_recommendations_block": [
    {
      "id": 12,
      "attributeSetIdentifier": null,
      "title": "Default personal recommendations block template",
      "generalTypeId": 29,
      "identifier": "personal_recommendations_block_default",
      "version": 0,
      "generalTypeName": "personal_recommendations_block",
      "attributeValues": {},
      "position": 7
    }
  ],
  "repeat_purchase_block": [
    {
      "id": 11,
      "attributeSetIdentifier": null,
      "title": "Default repeat purchase block template",
      "generalTypeId": 28,
      "identifier": "repeat_purchase_block_default",
      "version": 0,
      "generalTypeName": "repeat_purchase_block",
      "attributeValues": {},
      "position": 8
    }
  ],
  "catalog_page": [
    {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Template",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  ]
}

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

المخطط: Record<Types, ITemplateEntity[]>

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

attributeSetIdentifier: string | null
مجموعة معرفات السمات.
مثال: "attribute_set_1"

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

generalTypeId: number
معرف الكيان العام.
مثال: 67890

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

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

generalTypeName: BlockType
اسم النوع العام.
مثال: "منتج"

attributeValues: IAttributeValues
خريطة لقيم السمات مفاتيحها بواسطة العلامة؛ كائن فارغ عند عدم وجودها.
مثال:

{
  "id": 1,
  "value": "some"
}

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

---