aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Collaborators/ISearchResult.php
blob: bcc5a91ce9934c744c4cddc9bc2cdd6a44ab60c2 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?php

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

/**
 * Interface ISearchResult
 *
 * @since 13.0.0
 */
interface ISearchResult {
	/**
	 * @param SearchResultType $type
	 * @param array $matches
	 * @param array|null $exactMatches
	 * @since 13.0.0
	 */
	public function addResultSet(SearchResultType $type, array $matches, ?array $exactMatches = null);

	/**
	 * @param SearchResultType $type
	 * @param string $collaboratorId
	 * @return bool
	 * @since 13.0.0
	 */
	public function hasResult(SearchResultType $type, $collaboratorId);

	/**
	 * Removes all result where $collaborationId exactly matches shareWith of
	 * any of wide and exact result matches of the given type.
	 *
	 * @since 22.0.0
	 */
	public function removeCollaboratorResult(SearchResultType $type, string $collaboratorId): bool;

	/**
	 * @param SearchResultType $type
	 * @since 13.0.0
	 */
	public function unsetResult(SearchResultType $type);

	/**
	 * @param SearchResultType $type
	 * @since 13.0.0
	 */
	public function markExactIdMatch(SearchResultType $type);

	/**
	 * @param SearchResultType $type
	 * @return bool
	 * @since 13.0.0
	 */
	public function hasExactIdMatch(SearchResultType $type);

	/**
	 * @return array
	 * @since 13.0.0
	 */
	public function asArray();
}