blob: 108809a8df98049c663dd45b8bd57fc587548a08 (
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
75
76
77
78
79
80
81
82
83
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal Nextcloud classes
namespace OCP;
/**
* User session
* @since 6.0.0
*/
interface IUserSession {
/**
* Do a user login
*
* @param string $uid the username
* @param string $password the password
* @return bool true if successful
* @since 6.0.0
*/
public function login($uid, $password);
/**
* Logs the user out including all the session data
* Logout, destroys session
*
* @return void
* @since 6.0.0
*/
public function logout();
/**
* set the currently active user
*
* @param \OCP\IUser|null $user
* @since 8.0.0
*/
public function setUser($user);
/**
* Temporarily set the currently active user without persisting in the session
*
* @param IUser|null $user
* @since 29.0.0
*/
public function setVolatileActiveUser(?IUser $user): void;
/**
* get the current active user
*
* @return \OCP\IUser|null Current user, otherwise null
* @since 8.0.0
*/
public function getUser();
/**
* Checks whether the user is logged in
*
* @return bool if logged in
* @since 8.0.0
*/
public function isLoggedIn();
/**
* get getImpersonatingUserID
*
* @return string|null
* @since 18.0.0
*/
public function getImpersonatingUserID(): ?string;
/**
* set setImpersonatingUserID
*
* @since 18.0.0
*/
public function setImpersonatingUserID(bool $useCurrentUser = true): void;
}
|
