diff options
author | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2015-04-16 17:00:08 +0200 |
commit | 7644950b48b094bfe5675348aefb7cf5747d325b (patch) | |
tree | a1792e21239a86f471da99b454134a5d8533ef77 /lib/public/iuser.php | |
parent | 8653da6c16597959c7bd0f0b202747ff96204575 (diff) | |
download | nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip |
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the
method introduction right inside the code without searching
via git blame
* easier to write apps for multiple versions
Diffstat (limited to 'lib/public/iuser.php')
-rw-r--r-- | lib/public/iuser.php | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/public/iuser.php b/lib/public/iuser.php index 9f75b8145f0..393ab90d260 100644 --- a/lib/public/iuser.php +++ b/lib/public/iuser.php @@ -24,11 +24,18 @@ namespace OCP; +/** + * Interface IUser + * + * @package OCP + * @since 8.0.0 + */ interface IUser { /** * get the user id * * @return string + * @since 8.0.0 */ public function getUID(); @@ -36,6 +43,7 @@ interface IUser { * get the display name for the user, if no specific display name is set it will fallback to the user id * * @return string + * @since 8.0.0 */ public function getDisplayName(); @@ -44,6 +52,7 @@ interface IUser { * * @param string $displayName * @return bool + * @since 8.0.0 */ public function setDisplayName($displayName); @@ -52,11 +61,13 @@ interface IUser { * login * * @return int + * @since 8.0.0 */ public function getLastLogin(); /** * updates the timestamp of the most recent login of this user + * @since 8.0.0 */ public function updateLastLoginTimestamp(); @@ -64,6 +75,7 @@ interface IUser { * Delete the user * * @return bool + * @since 8.0.0 */ public function delete(); @@ -73,6 +85,7 @@ interface IUser { * @param string $password * @param string $recoveryPassword for the encryption app to reset encryption keys * @return bool + * @since 8.0.0 */ public function setPassword($password, $recoveryPassword = null); @@ -87,6 +100,7 @@ interface IUser { * Get the name of the backend class the user is connected with * * @return string + * @since 8.0.0 */ public function getBackendClassName(); @@ -94,6 +108,7 @@ interface IUser { * check if the backend allows the user to change his avatar on Personal page * * @return bool + * @since 8.0.0 */ public function canChangeAvatar(); @@ -108,6 +123,7 @@ interface IUser { * check if the backend supports changing display names * * @return bool + * @since 8.0.0 */ public function canChangeDisplayName(); @@ -115,6 +131,7 @@ interface IUser { * check if the user is enabled * * @return bool + * @since 8.0.0 */ public function isEnabled(); @@ -122,6 +139,7 @@ interface IUser { * set the enabled status for the user * * @param bool $enabled + * @since 8.0.0 */ public function setEnabled($enabled); } |