aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Group/Backend/IGroupDetailsBackend.php
blob: a2830849f6c765d9809906ab83c68c52832c7995 (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Group\Backend;

/**
 * @brief Optional interface for group backends
 * @since 14.0.0
 */
interface IGroupDetailsBackend {
	/**
	 * @brief Get additional details for a group, for example the display name.
	 *
	 * The array returned can be empty when no additional information is available
	 * for the group.
	 *
	 * @return array{displayName?: string}
	 * @since 14.0.0
	 */
	public function getGroupDetails(string $gid): array;
}