Class SceneQueryEngineFilterAttribute

This is a QueryEngineFilterAttribute use for query in a scene provider.

Inheritance
object
Attribute
QueryEngineFilterAttribute
SceneQueryEngineFilterAttribute
Implements
Inherited Members
Namespace: UnityEditor.Search.Providers
Assembly: com.unity.quicksearch.dll
Syntax
[AttributeUsage(AttributeTargets.Method)]
public class SceneQueryEngineFilterAttribute : QueryEngineFilterAttribute, _Attribute

Constructors

SceneQueryEngineFilterAttribute(string, string, StringComparison, string[])

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

Declaration
public SceneQueryEngineFilterAttribute(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.

SceneQueryEngineFilterAttribute(string, string, string[])

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

Declaration
public SceneQueryEngineFilterAttribute(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.

SceneQueryEngineFilterAttribute(string, StringComparison, string[])

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

Declaration
public SceneQueryEngineFilterAttribute(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.

SceneQueryEngineFilterAttribute(string, string[])

Create a filter with the corresponding token and supported operators.

Declaration
public SceneQueryEngineFilterAttribute(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.

Implements