ISearchQuery

interface OCP\Search\ISearchQuery
The query objected passed into \OCP\Search\IProvider::search
This mainly wraps the search term, but will ensure that Nextcloud can add new
optional properties to a search request without having break the interface of
\OCP\Search\IProvider::search.
Implemented by:OC\Search\SearchQuery
Source:lib/public/Search/ISearchQuery.php#41

Constants

SORT_DATE_DESC = 1
Source:lib/public/Search/ISearchQuery.php#46
Since:20.0.0

Methods

public OCP\Search\ISearchQuery::getTerm()
Get the user-entered search term to find matches for
Source:lib/public/Search/ISearchQuery.php#54
Returns:string the search term
Since:20.0.0
public OCP\Search\ISearchQuery::getSortOrder()
Get the sort order of results as defined as SORT_* constants on this interface
Source:lib/public/Search/ISearchQuery.php#62
Returns:int
Since:20.0.0
public OCP\Search\ISearchQuery::getLimit()
Get the number of items to return for a paginated result
Source:lib/public/Search/ISearchQuery.php#71
Returns:int
See:\OCP\Search\IProvider for details
Since:20.0.0
public OCP\Search\ISearchQuery::getCursor()
Get the app-specific cursor of the tail of the previous result entries
Source:lib/public/Search/ISearchQuery.php#80
Returns:int | string | null
See:\OCP\Search\IProvider for details
Since:20.0.0
public OCP\Search\ISearchQuery::getRoute()
Source:lib/public/Search/ISearchQuery.php#86
Returns:string
Since:20.0.0
public OCP\Search\ISearchQuery::getRouteParameters()
Source:lib/public/Search/ISearchQuery.php#92
Returns:array
Since:20.0.0