calendar/amd/src/calendar_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/>.
  15
  16 /**
  17  * A javascript module to handle calendar ajax actions.
  18  *
  19  * @module     core_calendar/calendar_repository
  20  * @class      repository
  21  * @package    core_calendar
  22  * @copyright  2017 Simey Lameze <lameze@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25 define(['jquery', 'core/ajax'], function($, Ajax) {
  26
  27     /**
  28      * Delete a calendar event.
  29      *
  30      * @method deleteEvent
  31      * @param {int} eventId The event id.
  32      * @return {promise} Resolved with requested calendar event
  33      */
  34     var deleteEvent = function(eventId) {
  35
  36         var request = {
  37             methodname: 'core_calendar_delete_calendar_events',
  38             args: {
  39                 events: [{
  40                     eventid: eventId,
  41                     repeat: 1
  42                 }]
  43             }
  44         };
  45
  46         return Ajax.call([request])[0];
  47     };
  48
  49     /**
  50      * Get a calendar event by id.
  51      *
  52      * @method getEventById
  53      * @param {int} eventId The event id.
  54      * @return {promise} Resolved with requested calendar event
  55      */
  56     var getEventById = function(eventId) {
  57
  58         var request = {
  59             methodname: 'core_calendar_get_calendar_event_by_id',
  60             args: {
  61                 eventid: eventId
  62             }
  63         };
  64
  65         return Ajax.call([request])[0];
  66     };
  67
  68     return {
  69         getEventById: getEventById,
  70         deleteEvent: deleteEvent
  71     };
  72 });