انتقل إلى المحتوى الرئيسي

getTemplateByType

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

الوصف

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

Templates.getTemplateByType(

type*, langCode

);

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

المخطط

type(required): الأنواع
نوع القوالب التي يجب استرجاعها. يحدد هذا المعامل الفئة أو التصنيف للقوالب المطلوبة
مثال: "product"

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

أمثلة

مثال بسيط

const response = await Templates.getTemplateByType('forCatalogProducts');

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

const response = await Templates.getTemplateByType('forCatalogProducts', 'en_US');

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

[
{
"id": 4,
"attributeSetIdentifier": null,
"title": "قالب",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}
]

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

المخطط: ITemplateEntity[]

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

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

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

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

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

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

generalTypeName: الأنواع
اسم النوع العام.
مثال: "product"

attributeValues: نوع السمة
قيم السمات من الفهرس (ممثلة كزوج من معرف سمة المستخدم: قيمة السمة).
مثال:

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

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