ISearchQuery
in
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.
Tags
Table of Contents
- SORT_DATE_DESC = 1
- getCursor() : int|string|null
- Get the app-specific cursor of the tail of the previous result entries
- getLimit() : int
- Get the number of items to return for a paginated result
- getRoute() : string
- getRouteParameters() : array
- getSortOrder() : int
- Get the sort order of results as defined as SORT_* constants on this interface
- getTerm() : string
- Get the user-entered search term to find matches for
Constants
SORT_DATE_DESC
public
mixed
SORT_DATE_DESC
= 1
Tags
Methods
getCursor()
Get the app-specific cursor of the tail of the previous result entries
public
getCursor() : int|string|null
Tags
Return values
int|string|null —getLimit()
Get the number of items to return for a paginated result
public
getLimit() : int
Tags
Return values
int —getRoute()
public
getRoute() : string
Tags
Return values
string —getRouteParameters()
public
getRouteParameters() : array
Tags
Return values
array —getSortOrder()
Get the sort order of results as defined as SORT_* constants on this interface
public
getSortOrder() : int
Tags
Return values
int —getTerm()
Get the user-entered search term to find matches for
public
getTerm() : string
Tags
Return values
string —the search term