communication/classes/room_user_provider.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 namespace core_communication;
  18
  19 /**
  20  * Class communication_user_base to manage communication provider users.
  21  *
  22  * @package    core_communication
  23  * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
  24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26 interface room_user_provider {
  27     /**
  28      * Add members to communication room.
  29      *
  30      * @param array $userids The user ids to be added
  31      */
  32     public function add_members_to_room(array $userids): void;
  33
  34     /**
  35      * Update room membership for the communication room.
  36      *
  37      * @param array $userids The user ids to be updated
  38      */
  39     public function update_room_membership(array $userids): void;
  40
  41     /**
  42      * Remove members from room.
  43      *
  44      * @param array $userids The user ids to be removed
  45      */
  46     public function remove_members_from_room(array $userids): void;
  47 }