Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 2.88 KB

Query.md

File metadata and controls

34 lines (27 loc) · 2.88 KB

Query class

Represents a query that is sent to a plugin.

public class Query

Public Members

name description
Query() The default constructor.
ActionKeyword { get; set; } The action keyword part of this query. For global plugins this value will be empty.
FirstSearch { get; } Splits SearchTerms by spaces and returns the first item.
IsHomeQuery { get; } Determines whether the query is a home query.
IsReQuery { get; } Determines whether the query was forced to execute again. For example, the value will be true when the user presses Ctrl + R. When this property is true, plugins handling this query should avoid serving cached results.
OriginalQuery { get; } Original query, exactly how the user has typed into the search box. We don't recommend using this property directly. You should always use Search property.
Search { get; } Search part of a query. This will not include action keyword if exclusive plugin gets it, otherwise it should be same as TrimmedQuery. Since we allow user to switch a exclusive plugin to generic plugin, so this property will always give you the "real" query part of the query
SearchTerms { get; set; } The search string split into a string array. Does not include the ActionKeyword.
SecondSearch { get; } Splits SearchTerms by spaces and returns the second item.
SecondToEndSearch { get; } strings from second search (including) to last search
ThirdSearch { get; } Splits SearchTerms by spaces and returns the third item.
TrimmedQuery { get; } Original query but with trimmed whitespace. Includes action keyword. It has handled built-in custom query hotkeys and build-in shortcuts. If you need the exact original query from the search box, use OriginalQuery property instead. We don't recommend using this property directly. You should always use Search property.
override ToString()
const ActionKeywordSeparator User can set multiple action keywords seperated by whitespace
const GlobalPluginWildcardSign Wildcard action keyword. Plugins using this value will be queried on every search.
const TermSeparator Query can be splited into multiple terms by whitespace

See Also