aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Collaborators/ISearch.php
blob: d2c5c85c07fb68eef31a3c64c20abf64a1860f24 (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
<?php

/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Collaboration\Collaborators;

/**
 * Interface ISearch
 *
 * @since 13.0.0
 */
interface ISearch {
	/**
	 * @param string $search
	 * @param array $shareTypes
	 * @param bool $lookup
	 * @param int $limit
	 * @param int $offset
	 * @return array with two elements, 1st ISearchResult as array, 2nd a bool indicating whether more result are available
	 * @since 13.0.0
	 */
	public function search($search, array $shareTypes, $lookup, $limit, $offset);

	/**
	 * @param array $pluginInfo with keys 'shareType' containing the name of a corresponding constant in \OCP\Share and
	 *                          'class' with the class name of the plugin
	 * @since 13.0.0
	 */
	public function registerPlugin(array $pluginInfo);
}