blocks/starredcourses/amd/src/repository.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/>.
  16. /**
  17.  * A javascript module to retrieve user's starred courses.
  18.  *
  19.  * @module block_starredcourses/repository
  20.  * @copyright  2018 Simey Lameze <simey@moodle.com>
  21.  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  23. define(['jquery', 'core/ajax', 'core/notification'], function($, Ajax, Notification) {
  25.     /**
  26.      * Retrieve a list of starred courses.
  27.      *
  28.      * Valid args are:
  29.      * int limit    number of records to retrieve
  30.      * int offset   the offset of records to retrieve
  31.      *
  32.      * @method getStarredCourses
  33.      * @param {object} args The request arguments
  34.      * @return {promise} Resolved with an array of courses
  35.      */
  36.     var getStarredCourses = function(args) {
  38.         var request = {
  39.             methodname: 'block_starredcourses_get_starred_courses',
  40.             args: args
  41.         };
  43.         var promise = Ajax.call([request])[0];
  45.         promise.fail(Notification.exception);
  47.         return promise;
  48.     };
  50.     return {
  51.         getStarredCourses: getStarredCourses
  52.     };
  53. });