Nextcloud PHP API (stable18)

ISearchQuery

Tags
since
12.0.0

Table of Contents

getLimit()  : int
Get the maximum number of results to return
getOffset()  : int
Get the offset for returned results
getOrder()  : \OCP\Files\Search\ISearchOrder[]
The fields and directions to order by
getSearchOperation()  : ISearchOperator
getUser()  : IUser
The user that issued the search
limitToHome()  : bool
Whether or not the search should be limited to the users home storage

Methods

getLimit()

Get the maximum number of results to return

public getLimit() : int
Tags
since
12.0.0
Return values
int

getOffset()

Get the offset for returned results

public getOffset() : int
Tags
since
12.0.0
Return values
int

getOrder()

The fields and directions to order by

public getOrder() : \OCP\Files\Search\ISearchOrder[]
Tags
since
12.0.0
Return values
\OCP\Files\Search\ISearchOrder[]

getUser()

The user that issued the search

public getUser() : IUser
Tags
since
12.0.0
Return values
IUser

limitToHome()

Whether or not the search should be limited to the users home storage

public limitToHome() : bool
Tags
since
18.0.0
Return values
bool

Search results