Merge branch 'MDL-44484-master' of https://github.com/Chocolate-lightning/moodle
[moodle.git] / mod / forum / amd / src / repository.js
CommitLineData
2646e9d6
RW
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/**
c475fe41 17 * Forum repository class to encapsulate all of the AJAX requests that subscribe or unsubscribe
2646e9d6
RW
18 * can be sent for forum.
19 *
20 * @module mod_forum/repository
21 * @package mod_forum
22 * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25define(['core/ajax'], function(Ajax) {
26 /**
27 * Set the subscription state for a discussion in a forum.
28 *
29 * @param {number} forumId ID of the forum the discussion belongs to
30 * @param {number} discussionId ID of the discussion with the subscription state
31 * @param {boolean} targetState Set the subscribed state. True == subscribed; false == unsubscribed.
32 * @return {object} jQuery promise
33 */
34 var setDiscussionSubscriptionState = function(forumId, discussionId, targetState) {
35 var request = {
36 methodname: 'mod_forum_set_subscription_state',
37 args: {
38 forumid: forumId,
39 discussionid: discussionId,
40 targetstate: targetState
41 }
42 };
43 return Ajax.call([request])[0];
44 };
45
9b4f09ba
P
46 var addDiscussionPost = function(postid, subject, message) {
47 var request = {
48 methodname: 'mod_forum_add_discussion_post',
49 args: {
50 postid: postid,
51 message: message,
52 subject: subject
53 }
54 };
99bda8a7
P
55 return Ajax.call([request])[0];
56 };
9b4f09ba 57
99bda8a7
P
58 /**
59 * Set the favourite state for a discussion in a forum.
60 *
61 * @param {number} forumId ID of the forum the discussion belongs to
62 * @param {number} discussionId ID of the discussion with the subscription state
8885cd57 63 * @param {null|date} targetState Set the favourite state. True == favourited; false == unfavourited.
99bda8a7
P
64 * @return {object} jQuery promise
65 */
8885cd57 66 var setFavouriteDiscussionState = function(forumId, discussionId, targetState) {
99bda8a7
P
67 var request = {
68 methodname: 'mod_forum_toggle_favourite_state',
69 args: {
99bda8a7
P
70 discussionid: discussionId,
71 targetstate: targetState
72 }
73 };
9b4f09ba
P
74 return Ajax.call([request])[0];
75 };
76
2893812e
P
77 var setDiscussionLockState = function(forumId, discussionId, targetState) {
78 var request = {
79 methodname: 'mod_forum_set_lock_state',
80 args: {
81 forumid: forumId,
82 discussionid: discussionId,
25a97f99 83 targetstate: targetState}
84 };
85 return Ajax.call([request])[0];
86 };
87
8885cd57
P
88 /**
89 * Set the pinned state for the discussion provided.
90 *
91 * @param {number} forumid
92 * @param {number} discussionid
93 * @param {boolean} targetstate
8885cd57
P
94 * @return {*|Promise}
95 */
96 var setPinDiscussionState = function(forumid, discussionid, targetstate) {
25a97f99 97 var request = {
98 methodname: 'mod_forum_set_pin_state',
99 args: {
25a97f99 100 discussionid: discussionid,
8885cd57 101 targetstate: targetstate
2893812e
P
102 }
103 };
104 return Ajax.call([request])[0];
105 };
106
2646e9d6
RW
107 return {
108 setDiscussionSubscriptionState: setDiscussionSubscriptionState,
2893812e 109 addDiscussionPost: addDiscussionPost,
99bda8a7 110 setDiscussionLockState: setDiscussionLockState,
8885cd57
P
111 setFavouriteDiscussionState: setFavouriteDiscussionState,
112 setPinDiscussionState: setPinDiscussionState
2646e9d6
RW
113 };
114});