1 files changed, 83 insertions, 0 deletions
diff --git a/lib/public/UserInterface.php b/lib/public/UserInterface.php
new file mode 100644
index 00000000000..34e7a09feb7
--- /dev/null
+++ b/lib/public/UserInterface.php
@@ -0,0 +1,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;
+
+/**
+ * TODO actually this is a IUserBackend
+ *
+ * @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 int|null $limit
+	 * @param int|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();
+}