Blame view

sources/lib/public/iuser.php 1.9 KB
6d9380f96   Cédric Dupont   Update sources OC...
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  <?php
  
  /**
   * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   */
  
  namespace OCP;
  
  interface IUser {
  	/**
  	 * get the user id
  	 *
  	 * @return string
  	 */
  	public function getUID();
  
  	/**
  	 * get the display name for the user, if no specific display name is set it will fallback to the user id
  	 *
  	 * @return string
  	 */
  	public function getDisplayName();
  
  	/**
  	 * set the display name for the user
  	 *
  	 * @param string $displayName
  	 * @return bool
  	 */
  	public function setDisplayName($displayName);
  
  	/**
  	 * returns the timestamp of the user's last login or 0 if the user did never
  	 * login
  	 *
  	 * @return int
  	 */
  	public function getLastLogin();
  
  	/**
  	 * updates the timestamp of the most recent login of this user
  	 */
  	public function updateLastLoginTimestamp();
  
  	/**
  	 * Delete the user
  	 *
  	 * @return bool
  	 */
  	public function delete();
  
  	/**
  	 * Set the password of the user
  	 *
  	 * @param string $password
  	 * @param string $recoveryPassword for the encryption app to reset encryption keys
  	 * @return bool
  	 */
  	public function setPassword($password, $recoveryPassword = null);
  
  	/**
  	 * get the users home folder to mount
  	 *
  	 * @return string
  	 */
  	public function getHome();
  
  	/**
  	 * check if the backend allows the user to change his avatar on Personal page
  	 *
  	 * @return bool
  	 */
  	public function canChangeAvatar();
  
  	/**
  	 * check if the backend supports changing passwords
  	 *
  	 * @return bool
  	 */
  	public function canChangePassword();
  
  	/**
  	 * check if the backend supports changing display names
  	 *
  	 * @return bool
  	 */
  	public function canChangeDisplayName();
  
  	/**
  	 * check if the user is enabled
  	 *
  	 * @return bool
  	 */
  	public function isEnabled();
  
  	/**
  	 * set the enabled status for the user
  	 *
  	 * @param bool $enabled
  	 */
  	public function setEnabled($enabled);
  }