mirror of
https://github.com/nextcloud/server.git
synced 2026-02-09 22:05:33 -05:00
831aebf4f6
This make sure that apps don't implement this interfaces and gives us more liberty to add new methods to them (as long as it is compatible from an usage point of view) Signed-off-by: Carl Schwan <carl@carlschwan.eu> Co-authored-by: Vincent Petry <vincent@nextcloud.com>
81 lines
3 KiB
PHP
81 lines
3 KiB
PHP
<?php
|
|
|
|
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/>.
|
|
*
|
|
*/
|
|
namespace OCP\UserStatus;
|
|
|
|
/**
|
|
* This interface allows to manage the user status.
|
|
*
|
|
* This interface must not be implemented in your application but
|
|
* instead should be used as a service and injected in your code with
|
|
* dependency injection.
|
|
*
|
|
* @since 20.0.0
|
|
*/
|
|
interface IManager {
|
|
|
|
/**
|
|
* Gets the statuses for all users in $users
|
|
*
|
|
* @param string[] $userIds
|
|
* @return IUserStatus[]
|
|
* @since 20.0.0
|
|
*/
|
|
public function getUserStatuses(array $userIds): array;
|
|
|
|
|
|
/**
|
|
* Set a new status for the selected user.
|
|
*
|
|
* @param string $userId The user for which we want to update the status.
|
|
* @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).
|
|
* @since 23.0.0
|
|
*/
|
|
public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void;
|
|
|
|
/**
|
|
* Revert an automatically set user status. For example after leaving a call,
|
|
* change back to the previously set status.
|
|
*
|
|
* @param string $userId The user for which we want to update the status.
|
|
* @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
|
|
* @param string $status The expected current status. If the user has already updated their status, this method does nothing.
|
|
* @since 23.0.0
|
|
*/
|
|
public function revertUserStatus(string $userId, string $messageId, string $status): void;
|
|
|
|
/**
|
|
* Revert an automatically set user status. For example after leaving a call,
|
|
* change back to the previously set status.
|
|
*
|
|
* @param string[] $userIds The user for which we want to update the status.
|
|
* @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
|
|
* @param string $status The expected current status. If the user has already updated their status, this method does nothing.
|
|
* @since 23.0.0
|
|
*/
|
|
public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void;
|
|
}
|