reportbuilder/amd/src/local/repository/schedules.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.  * Module to handle schedule AJAX requests
  18.  *
  19.  * @module      core_reportbuilder/local/repository/schedules
  20.  * @copyright   2021 Paul Holden <paulh@moodle.com>
  21.  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  24. import Ajax from 'core/ajax';
  26. /**
  27.  * Delete schedule
  28.  *
  29.  * @method
  30.  * @param {Number} reportId
  31.  * @param {Number} scheduleId
  32.  * @return {Promise}
  33.  */
  34. export const deleteSchedule = (reportId, scheduleId) => {
  35.     const request = {
  36.         methodname: 'core_reportbuilder_schedules_delete',
  37.         args: {reportid: reportId, scheduleid: scheduleId}
  38.     };
  40.     return Ajax.call([request])[0];
  41. };
  43. /**
  44.  * Send schedule
  45.  *
  46.  * @method
  47.  * @param {Number} reportId
  48.  * @param {Number} scheduleId
  49.  * @return {Promise}
  50.  */
  51. export const sendSchedule = (reportId, scheduleId) => {
  52.     const request = {
  53.         methodname: 'core_reportbuilder_schedules_send',
  54.         args: {reportid: reportId, scheduleid: scheduleId}
  55.     };
  57.     return Ajax.call([request])[0];
  58. };
  60. /**
  61.  * Toggle schedule enabled
  62.  *
  63.  * @method
  64.  * @param {Number} reportId
  65.  * @param {Number} scheduleId
  66.  * @param {Boolean} scheduleEnabled
  67.  * @return {Promise}
  68.  */
  69. export const toggleSchedule = (reportId, scheduleId, scheduleEnabled) => {
  70.     const request = {
  71.         methodname: 'core_reportbuilder_schedules_toggle',
  72.         args: {reportid: reportId, scheduleid: scheduleId, enabled: scheduleEnabled}
  73.     };
  75.     return Ajax.call([request])[0];
  76. };