Current Path : C:/xampp/htdocs/moodle/blocks/myoverview/amd/src/ |
Current File : C:/xampp/htdocs/moodle/blocks/myoverview/amd/src/repository.js |
// This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. /** * A javascript module to retrieve enrolled coruses from the server. * * @package block_myoverview * @copyright 2018 Bas Brands <base@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define(['core/ajax', 'core/notification'], function(Ajax, Notification) { /** * Retrieve a list of enrolled courses. * * Valid args are: * string classification future, inprogress, past * int limit number of records to retreive * int Offset offset for pagination * int sort sort by lastaccess or name * * @method getEnrolledCoursesByTimeline * @param {object} args The request arguments * @return {promise} Resolved with an array of courses */ var getEnrolledCoursesByTimeline = function(args) { var request = { methodname: 'core_course_get_enrolled_courses_by_timeline_classification', args: args }; var promise = Ajax.call([request])[0]; return promise; }; /** * Set the favourite state on a list of courses. * * Valid args are: * Array courses list of course id numbers. * * @param {Object} args Arguments send to the webservice. * @return {Promise} Resolve with warnings. */ var setFavouriteCourses = function(args) { var request = { methodname: 'core_course_set_favourite_courses', args: args }; var promise = Ajax.call([request])[0]; return promise; }; /** * Update the user preferences. * * @param {Object} args Arguments send to the webservice. * * Sample args: * { * preferences: [ * { * type: 'block_example_user_sort_preference' * value: 'title' * } * ] * } */ var updateUserPreferences = function(args) { var request = { methodname: 'core_user_update_user_preferences', args: args }; Ajax.call([request])[0] .fail(Notification.exception); }; return { getEnrolledCoursesByTimeline: getEnrolledCoursesByTimeline, setFavouriteCourses: setFavouriteCourses, updateUserPreferences: updateUserPreferences }; });