scratchfoundation/scratch-www
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-www.git synced 2024-11-23 07:38:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

add comments to redux methods

Browse source
This commit is contained in:
Matthew Taylor 2017-09-05 10:03:48 -04:00
parent 23c40c8f5e
commit 74400b0599
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
src/redux/messages.js
View file

@ -112,6 +112,10 @@ module.exports.setStatus = function (type, status){
};
};
/**
* Sends a request to mark one's unread messages count as cleared.
* @return {null} returns nothing
*/
module.exports.clearMessageCount = function () {
return function (dispatch) {
dispatch(module.exports.setStatus('CLEAR_STATUS', module.exports.Status.FETCHING));
@ -136,6 +140,14 @@ module.exports.clearMessageCount = function () {
};
};
/**
* Marks an admin message as read, dismissing it from the page
* @param {string} messageType type of message to delete (invite or notification)
* @param {number} messageId id of the message to delete
* @param {number} messageCount current number of unread notifications
* @param {object[]} adminMessages current list of admin messages retrieved
* @return {null} returns nothing
*/
module.exports.clearAdminMessage = function (messageType, messageId, messageCount, adminMessages) {
return function (dispatch) {
dispatch(module.exports.setStatus('CLEAR_STATUS', module.exports.Status.FETCHING));
@ -181,6 +193,14 @@ module.exports.clearAdminMessage = function (messageType, messageId, messageCoun
};
};
/**
* Gets a user's messages to be displayed on the /messages page
* @param {string} username username of the user for whom the messages should be gotten
* @param {string} token the user's unique token for auth
* @param {object[]} messages an array of existing messages on the page, if there are any
* @param {number} offset offset of messages to get, based on the number retrieved already
* @return {null} returns nothing
*/
module.exports.getMessages = function (username, token, messages, offset) {
return function (dispatch) {
dispatch(module.exports.setStatus('MESSAGE_STATUS', module.exports.Status.FETCHING));
@ -206,6 +226,12 @@ module.exports.getMessages = function (username, token, messages, offset) {
};
};
/**
* Gets the messages from the Scratch Team for a user
* @param {string} username user's username for whom to get the admin messages
* @param {string} token the user's unique token for auth
* @return {null} returns nothing
*/
module.exports.getAdminMessages = function (username, token) {
return function (dispatch) {
dispatch(module.exports.setStatus('ADMIN_STATUS', module.exports.Status.FETCHING));
@ -231,6 +257,12 @@ module.exports.getAdminMessages = function (username, token) {
};
};
/**
* Gets the invitation to become a Scratcher for a user, if one exists
* @param {string} username user's username for whom to get the invite
* @param {string} token the user's unique token for auth
* @return {null} returns nothing
*/
module.exports.getScratcherInvite = function (username, token) {
return function (dispatch) {
api({