aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/UserStatus/IManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/UserStatus/IManager.php')
-rw-r--r--lib/public/UserStatus/IManager.php28
1 files changed, 6 insertions, 22 deletions
diff --git a/lib/public/UserStatus/IManager.php b/lib/public/UserStatus/IManager.php
index 354a1e19ee9..d291ee0a540 100644
--- a/lib/public/UserStatus/IManager.php
+++ b/lib/public/UserStatus/IManager.php
@@ -3,25 +3,8 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2020, Georg Ehrke
- *
- * @author Georg Ehrke <oc.list@georgehrke.com>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * 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
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\UserStatus;
@@ -35,12 +18,11 @@ namespace OCP\UserStatus;
* @since 20.0.0
*/
interface IManager {
-
/**
* Gets the statuses for all users in $users
*
* @param string[] $userIds
- * @return IUserStatus[]
+ * @return array<string, IUserStatus> array key being the userid, users without a status will not be in the returned array
* @since 20.0.0
*/
public function getUserStatuses(array $userIds): array;
@@ -53,9 +35,11 @@ interface IManager {
* @param string $messageId The id of the predefined message.
* @param string $status The status to assign
* @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
+ * @param string|null $customMessage
* @since 23.0.0
+ * @since 28.0.0 Optional parameter $customMessage was added
*/
- public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void;
+ public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false, ?string $customMessage = null): void;
/**
* Revert an automatically set user status. For example after leaving a call,