getBlockByMarker

الحصول على كائن كتلة واحد بواسطة العلامة.

الوصف

ترجع هذه الطريقة كائن كتلة واحد بواسطة العلامة. إنها ترجع وعدًا يتم حله إلى كائن IBlockEntity.

Blocks.getBlockByMarker(
marker,
langCode,
offset,
limit
);

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

المخطط

marker(مطلوب): string
علامة الكتلة
مثال: "product_block"

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

offset: number
معامل للتصفح. الافتراضي: 0
مثال: 0

limit: number
معامل للتصفح. الافتراضي: 30
مثال: 30

أمثلة

مثال بسيط

const response = await Blocks.getBlockByMarker('my-marker');

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

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

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

{
  "id": 3,
  "localizeInfos": {
    "title": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

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

المخطط: IBlockEntity

attributeValues: AttributeType
نوع السمات المستخدمة في الكتلة.
مثال:

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

id: number
معرف فريد للكتلة.
مثال: 1234

localizeInfos: ILocalizeInfo
معلومات التوطين للكتلة.
مثال:

{
  "key": "value"
}

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

identifier: string
معرف سلسلة فريد للكتلة.
مثال: "block1"

type: string
نوع الكتلة، مثل 'product'، 'error_page'، إلخ.
مثال: "product"

templateIdentifier: string | null
معرف القالب المستخدم بواسطة الكتلة، أو null إذا لم يكن ذلك مناسبًا.
مثال: "template1"

isVisible: boolean
تشير إلى ما إذا كانت الكتلة مرئية.
مثال: true

countElementsPerRow: number
عدد العناصر المعروضة في كل صف في الكتلة، إذا كان ذلك مناسبًا.
مثال: 3

quantity: number
كمية العناصر في الكتلة، إذا كان ذلك مناسبًا.
مثال: 5

similarProducts: IProductsResponse
استجابة تحتوي على منتجات مشابهة مرتبطة بالكتلة.
مثال:

{
  "total": 10,
  "items": []
}

products: IProductsEntity[]
مصفوفة من كائنات المنتجات المرتبطة بالكتلة.
مثال:

[
  {
    "id": 1,
    "name": "Product 1"
  },
  {
    "id": 2,
    "name": "Product 2"
  }
]

getBlockByMarker

الوصف​

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

أمثلة​

مثال بسيط​

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

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

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