getFilterByMarker

احصل على فلتر بواسطة علامته (شجرة العناصر).

الوصف

تسترجع هذه الطريقة فلتر محتوى واحد بواسطة علامته، محليًا إلى اللغة المطلوبة. تعيد Promise التي تحل إلى كائن IContentFilter يحتوي على معلومات الفلتر المحلية وشجرة عناصره.

Filters.getFilterByMarker(

marker*, langCode

);

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

المخطط

marker(required): string
علامة الفلتر
مثال: "main"

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

أمثلة

مثال بسيط

const response = await Filters.getFilterByMarker('main');

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

const response = await Filters.getFilterByMarker('main', 'en_US');

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

{
  "localizeInfos": {
    "title": "Main filter"
  },
  "items": [
    {
      "type": "page",
      "marker": null,
      "url": "about",
      "localizeInfos": {
        "title": "About"
      },
      "value": null,
      "position": 1,
      "children": []
    },
    {
      "type": "attribute",
      "marker": "color",
      "url": null,
      "localizeInfos": {
        "title": "Color"
      },
      "value": null,
      "position": 2,
      "children": [
        {
          "type": "custom",
          "marker": "color_red",
          "url": null,
          "localizeInfos": {
            "title": "Red"
          },
          "value": "red",
          "position": 1,
          "children": []
        }
      ]
    }
  ]
}

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

المخطط: IContentFilter

localizeInfos: ILocalizeInfo
معلومات محلية عن الفلتر في اللغة المطلوبة.
مثال: { "title": "Main filter" }

items: IContentFilterItem[]
شجرة عناصر الفلتر (عناصر عادية + عناصر مخصصة في مصفوفة واحدة).

items.type: TContentFilterItemType
نوع عقدة الشجرة. واحد من: "page"، "product"، "admin"، "attribute"، "discount"، "personal-discount"، "bonus"، "payment-method"، "custom".
مثال: "page"

items.marker: string | null
علامة الكيان المرتبط، أو null لنوع=page.
مثال: "about"

items.url: string | null
رابط الصفحة (فقط لنوع=page؛ null خلاف ذلك).
مثال: "about"

items.localizeInfos: ILocalizeInfo
معلومات محلية عن الكيان المرتبط في اللغة المطلوبة.
مثال: { "title": "About" }

items.value: string | null
قيمة العقدة الموحدة (مثل قيمة الخصم، عنوان السمة)؛ null خلاف ذلك.
مثال: "10"

items.position: number
الموقع العددي (لكل مستوى).
مثال: 1

items.children: IContentFilterItem[]
عقد شجرة متداخلة (عناصر عادية ومخصصة في مصفوفة واحدة).

---