SearchQueryError

Description

Represents a query parsing error.

This class is only used in the context of SearchProviders, when performing a search. It allows a SearchProvider to report error during the parsing of the search query. Here is an example of a SearchProvider that uses a QueryEngine and reports parsing errors:

var query = m_QueryEngine.ParseQuery(context.searchQuery);
if (!query.valid)
{
    context.AddSearchQueryErrors(query.errors.Select(e => new SearchQueryError(e, context, this)));
    return Array.Empty<SearchItem>();
}

In the previous example, the function "Search" would be called by the provider's fetchItem.

In the Search window, the errors are shown when there is no result available. [Example_SearchQueryError.png].

Properties

Constructors