message/amd/src/message_drawer_view_overview_section_favourites.js

   1 // This file is part of Moodle - http://moodle.org/
   2 //
   3 // Moodle is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // Moodle is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 /**
  17  * Controls the favourites section of the overview page in the message drawer.
  18  *
  19  * @module     core_message/message_drawer_view_overview_section_favourites
  20  * @copyright  2018 Ryan Wyllie <ryan@moodle.com>
  21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  */
  23 define(
  24 [
  25     'jquery',
  26     'core_message/message_drawer_view_overview_section'
  27 ],
  28 function(
  29     $,
  30     Section
  31 ) {
  32     // All conversation types.
  33     var CONVERSATION_TYPE = null;
  34     var INCLUDE_FAVOURITES = true;
  35
  36     /**
  37      * Show the overview page conversations.
  38      *
  39      * @param {Object} root Overview messages container element.
  40      */
  41     var show = function(root) {
  42         Section.show($(root), CONVERSATION_TYPE, INCLUDE_FAVOURITES);
  43     };
  44
  45     return {
  46         show: show,
  47     };
  48 });