You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
108 lines
2.7 KiB
108 lines
2.7 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* This program 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, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
/** |
|
* Public interface of ownCloud for apps to use. |
|
* User 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; |
|
|
|
/** |
|
* TODO actually this is a IUserBackend |
|
* |
|
* @package OCP |
|
* @since 4.5.0 |
|
*/ |
|
interface UserInterface { |
|
|
|
/** |
|
* Check if backend implements actions |
|
* @param int $actions bitwise-or'ed actions |
|
* @return boolean |
|
* |
|
* Returns the supported actions as int to be |
|
* compared with \OC\User\Backend::CREATE_USER etc. |
|
* @since 4.5.0 |
|
* @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend |
|
*/ |
|
public function implementsActions($actions); |
|
|
|
/** |
|
* delete a user |
|
* @param string $uid The username of the user to delete |
|
* @return bool |
|
* @since 4.5.0 |
|
*/ |
|
public function deleteUser($uid); |
|
|
|
/** |
|
* Get a list of all users |
|
* |
|
* @param string $search |
|
* @param null|int $limit |
|
* @param null|int $offset |
|
* @return string[] an array of all uids |
|
* @since 4.5.0 |
|
*/ |
|
public function getUsers($search = '', $limit = null, $offset = null); |
|
|
|
/** |
|
* check if a user exists |
|
* @param string $uid the username |
|
* @return boolean |
|
* @since 4.5.0 |
|
*/ |
|
public function userExists($uid); |
|
|
|
/** |
|
* get display name of the user |
|
* @param string $uid user ID of the user |
|
* @return string display name |
|
* @since 4.5.0 |
|
*/ |
|
public function getDisplayName($uid); |
|
|
|
/** |
|
* Get a list of all display names and user ids. |
|
* |
|
* @param string $search |
|
* @param string|null $limit |
|
* @param string|null $offset |
|
* @return array an array of all displayNames (value) and the corresponding uids (key) |
|
* @since 4.5.0 |
|
*/ |
|
public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
|
|
/** |
|
* Check if a user list is available or not |
|
* @return boolean if users can be listed or not |
|
* @since 4.5.0 |
|
*/ |
|
public function hasUserListings(); |
|
|
|
}
|
|
|