aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Authentication/LoginCredentials/ICredentials.php
blob: 9848bbbe821fe913e1a1ee13be3b85e0f79072a9 (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
<?php

/**
 * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Authentication\LoginCredentials;

use OCP\Authentication\Exceptions\PasswordUnavailableException;

/**
 * @since 12
 */
interface ICredentials {
	/**
	 * Get the user UID
	 *
	 * @since 12
	 *
	 * @return string
	 */
	public function getUID();

	/**
	 * Get the login name the users used to login
	 *
	 * @since 12
	 *
	 * @return string
	 */
	public function getLoginName();

	/**
	 * Get the password
	 *
	 * @since 12
	 *
	 * @return string|null
	 * @throws PasswordUnavailableException
	 */
	public function getPassword();
}