1. @sitecore-cloudsdk/search/browser

ListFilter

Version:

Type

Class

Extends

BaseFilter

Import path

@sitecore-cloudsdk/search/browser

A filter that returns search results if all or any of a set of values are included in a certain attribute.

For example, return only those search results where the type attribute matches all or any of the following values: "video", "film", "audio".

Constructor

ListFilter(
  attributeName: string,
  operator: ListOperators,
  value: unknown[]
)

Parameters

Name

Type

Description

attributeName

string

The entity's attribute to be compared with the value.

operator

ListOperators

The operator to check if any or all of a set of values is included in a certain attribute.

Accepted values:

  • "anyOf"

  • "allOf"

value

unknown

The value to compare the entity's attribute with.

Properties

Name

Type

Description

_attributeName

string

Required.

The entity's attribute to be compared with the value.

Methods

toDTO

Maps the ListFilter instance to its DTO (data transfer object) format.

Signature

toDTO(): ListFilterDTO

Return value

Returns the ListFilter instance in a standardized DTO format.

If you have suggestions for improving this article, let us know!