ISearchService¶

interface OCP\FullTextSearch\Service\ISearchService¶

Interface ISearchService

Source:	lib/public/FullTextSearch/Service/ISearchService.php#38

Methods¶

public OCP\FullTextSearch\Service\ISearchService::generateSearchRequest($request)¶

generate a search request, based on an array:

$request =

[

‘providers’ =>    (string/array) ‘all’
‘author’ =>       (string) owner of the document.
‘search’ =>       (string) search string,
‘size’ =>         (int) number of items to be return
‘page’ =>         (int) page
‘parts’ =>        (array) parts of document to search within,
‘options’ =       (array) search options,
‘tags’     =>     (array) tags,
‘metatags’ =>     (array) metatags,
‘subtags’  =>     (array) subtags

]

‘providers’ can be an array of providerIds

Source:	lib/public/FullTextSearch/Service/ISearchService.php#66
Parameters:	$request (array)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchRequest`

public OCP\FullTextSearch\Service\ISearchService::search($userId, $searchRequest)¶

Search documents

Source:	lib/public/FullTextSearch/Service/ISearchService.php#79
Parameters:	$userId (string) $searchRequest (`OCP\FullTextSearch\Model\ISearchRequest`)
Since:	15.0.0
Returns:	`\OCP\FullTextSearch\Model\ISearchResult[]`