[Summary view]

   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_room_base to manage the room operations of communication providers.
  21   *
  22   * Every plugin that supports room operation must implement/extend this class in the plugin.
  23   *
  24   * @package    core_communication
  25   * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  interface room_chat_provider {
  29      /**
  30       * Create a provider room when a instance is created.
  31       */
  32      public function create_chat_room(): bool;
  33  
  34      /**
  35       * Update a provider room when a instance is updated.
  36       */
  37      public function update_chat_room(): bool;
  38  
  39      /**
  40       * Delete a provider room when a instance is deleted.
  41       */
  42      public function delete_chat_room(): bool;
  43  
  44      /**
  45       * Generate a room url if there is a room.
  46       *
  47       * @return string|null
  48       */
  49      public function get_chat_room_url(): ?string;
  50  }