* @author Bart Visscher * @author Jakob Sack * @author Jörn Friedrich Dreyer * @author Morris Jobke * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OCP; /** * Small Interface for Search * @since 7.0.0 */ interface ISearch { /** * Search all providers for $query * @param string $query * @param string[] $inApps optionally limit results to the given apps * @return array An array of OCP\Search\Result's * @deprecated 8.0.0 use searchPaged() with page and size * @since 7.0.0 - parameter $inApps was added in 8.0.0 */ public function search($query, array $inApps = array()); /** * Search all providers for $query * @param string $query * @param string[] $inApps optionally limit results to the given apps * @param int $page pages start at page 1 * @param int $size * @return array An array of OCP\Search\Result's * @since 8.0.0 */ public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30); /** * Register a new search provider to search with * @param string $class class name of a OCP\Search\Provider * @param array $options optional * @since 7.0.0 */ public function registerProvider($class, array $options = array()); /** * Remove one existing search provider * @param string $provider class name of a OCP\Search\Provider * @since 7.0.0 */ public function removeProvider($provider); /** * Remove all registered search providers * @since 7.0.0 */ public function clearProviders(); } listeners Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
summaryrefslogtreecommitdiffstats
blob: 78e6255c8782544a59644d066e5602b7f7a17af5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49