summaryrefslogtreecommitdiffstats
path: root/lib/public/Authentication/TwoFactorAuth/IProvidesPersonalSettings.php
blob: 3668e60cd50c86791cc60bb9633a6513715ab5be (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
<?php

declare(strict_types=1);

/**
 *
 *
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCP\Authentication\TwoFactorAuth;

use OCP\IUser;

/**
 * Interface for admins that have personal settings. These settings will be shown in the
 * security sections. Some information like the display name of the provider is read
 * from the provider directly.
 *
 * @since 15.0.0
 */
interface IProvidesPersonalSettings extends IProvider {

	/**
	 * @param IUser $user
	 *
	 * @return IPersonalProviderSettings
	 *
	 * @since 15.0.0
	 */
	public function getPersonalSettings(IUser $user): IPersonalProviderSettings;
}