getFilterByMarker

Lấy một bộ lọc theo dấu hiệu của nó (cây các mục).

Mô tả

Phương thức này truy xuất một bộ lọc nội dung đơn lẻ theo dấu hiệu của nó, được địa phương hóa theo ngôn ngữ yêu cầu. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IContentFilter chứa thông tin địa phương hóa của bộ lọc và cây các mục của nó.

Filters.getFilterByMarker(

marker*, langCode

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Dấu hiệu bộ lọc
ví dụ: "main"

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ

Ví dụ tối thiểu

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

Ví dụ với các thuộc tính

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

Ví dụ phản hồi

{
  "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": []
        }
      ]
    }
  ]
}

Sơ đồ phản hồi

Sơ đồ: IContentFilter

localizeInfos: ILocalizeInfo
Thông tin địa phương hóa của bộ lọc trong ngôn ngữ yêu cầu.
ví dụ: { "title": "Bộ lọc chính" }

items: IContentFilterItem[]
Cây các mục bộ lọc (các mục thông thường + các mục tùy chỉnh trong một mảng duy nhất).

items.type: TContentFilterItemType
Loại nút cây. Một trong các loại: "page", "product", "admin", "attribute", "discount", "personal-discount", "bonus", "payment-method", "custom".
ví dụ: "page"

items.marker: string | null
Dấu hiệu của thực thể liên kết, hoặc null cho type=page.
ví dụ: "about"

items.url: string | null
URL trang (chỉ cho type=page; null nếu không).
ví dụ: "about"

items.localizeInfos: ILocalizeInfo
Thông tin địa phương hóa của thực thể liên kết trong ngôn ngữ yêu cầu.
ví dụ: { "title": "Về chúng tôi" }

items.value: string | null
Giá trị nút thống nhất (ví dụ: giá trị giảm giá, tiêu đề thuộc tính); null nếu không.
ví dụ: "10"

items.position: number
Vị trí số (theo cấp độ).
ví dụ: 1

items.children: IContentFilterItem[]
Các nút cây lồng nhau (các mục thông thường và tùy chỉnh trong một mảng duy nhất).

---