Class QueryEngineFilterAttribute

Base attribute class used to define a custom filter on a QueryEngine. All filter types supported by QueryEngine.AddFilter are supported by this attribute.

Inheritance

Object

Attribute

QueryEngineFilterAttribute

SceneQueryEngineFilterAttribute

Namespace: Unity.QuickSearch

Syntax

public class QueryEngineFilterAttribute : Attribute, _Attribute

Constructors

QueryEngineFilterAttribute(String, String, String[])

Create a filter with the corresponding token, parameter transformer function and supported operators.

Declaration

public QueryEngineFilterAttribute(string token, string paramTransformerFunction, string[] supportedOperators = null)

Parameters

Type	Name	Description
String	token	The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").
String	paramTransformerFunction	Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.
String[]	supportedOperators	List of supported operator tokens. Null for all operators.

Remarks

Sets the flag useParamTransformer to true.

QueryEngineFilterAttribute(String, String, StringComparison, String[])

Create a filter with the corresponding token, parameter transformer function, string comparison options and supported operators.

Declaration

public QueryEngineFilterAttribute(string token, string paramTransformerFunction, StringComparison options, string[] supportedOperators = null)

Parameters

Type	Name	Description
String	token	The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").
String	paramTransformerFunction	Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.
StringComparison	options	String comparison options.
String[]	supportedOperators	List of supported operator tokens. Null for all operators.

Remarks

Sets both overridesStringComparison and useParamTransformer flags to true.

QueryEngineFilterAttribute(String, String[])

Create a filter with the corresponding token and supported operators.

Declaration

public QueryEngineFilterAttribute(string token, string[] supportedOperators = null)

Parameters

Type	Name	Description
String	token	The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").
String[]	supportedOperators	List of supported operator tokens. Null for all operators.

QueryEngineFilterAttribute(String, StringComparison, String[])

Create a filter with the corresponding token, string comparison options and supported operators.

Declaration

public QueryEngineFilterAttribute(string token, StringComparison options, string[] supportedOperators = null)

Parameters

Type	Name	Description
String	token	The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").
StringComparison	options	String comparison options.
String[]	supportedOperators	List of supported operator tokens. Null for all operators.

Remarks

This sets the flag overridesStringComparison to true.

Fields

comparisonOptions

String comparison options.

Declaration

public StringComparison comparisonOptions

Field Value

Type	Description
StringComparison

overridesStringComparison

Flag indicating if the filter overrides the global string comparison options. Set to true when the comparisonOptions are used.

Declaration

public bool overridesStringComparison

Field Value

Type	Description
Boolean

paramTransformerFunction

Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

Declaration

public string paramTransformerFunction

Field Value

Type	Description
String

supportedOperators

List of supported operator tokens. Null for all operators.

Declaration

public string[] supportedOperators

Field Value

Type	Description
String[]

token

The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

Declaration

public string token

Field Value

Type	Description
String

useParamTransformer

Flag indicating if this filter uses a parameter transformer function. Set to true when paramTransformerFunction is used.

Declaration

public bool useParamTransformer

Field Value

Type	Description
Boolean