blob: 4c5b4d1ba51cf8556929180283cfa204c2629643 (
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
64
65
66
67
68
69
70
71
72
73
74
|
<?php
/**
* ownCloud
*
* @author Bart Visscher
* @author Bernhard Posselt
* @copyright 2013 Bart Visscher bartv@thisnet.nl
* @copyright 2014 Bernhard Posselt <dev@bernhard-posselt.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* User session interface
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* User session
*/
interface IUserSession {
/**
* Do a user login
* @param string $user the username
* @param string $password the password
* @return bool true if successful
*/
public function login($user, $password);
/**
* Logs the user out including all the session data
* Logout, destroys session
* @return void
*/
public function logout();
/**
* set the currently active user
*
* @param \OCP\IUser|null $user
*/
public function setUser($user);
/**
* get the current active user
*
* @return \OCP\IUser
*/
public function getUser();
/**
* Checks wether the user is logged in
*
* @return bool if logged in
*/
public function isLoggedIn();
}
|
