mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-16 14:17:22 +01:00
51 lines
2.1 KiB
JavaScript
51 lines
2.1 KiB
JavaScript
import { authWithHeaders } from '../../middlewares/auth';
|
|
import { chatReporterFactory } from '../../libs/chatReporting/chatReporterFactory';
|
|
|
|
const api = {};
|
|
|
|
/**
|
|
* @api {post} /api/v4/members/flag-private-message/:messageId Flag a private message
|
|
* @apiDescription Moderators are notified about every flagged message,
|
|
* including the sender, recipient, and full content of the message.
|
|
* This is for API v4 which must not be used in third-party tools as it can change without notice.
|
|
* There is no equivalent route in API v3.
|
|
* @apiName FlagPrivateMessage
|
|
* @apiGroup Member
|
|
*
|
|
* @apiParam (Path) {UUID} messageId The private message id
|
|
*
|
|
* @apiSuccess {Object} data The flagged private message
|
|
* @apiSuccess {UUID} data.id The id of the message
|
|
* @apiSuccess {String} data.text The text of the message
|
|
* @apiSuccess {Number} data.timestamp The timestamp of the message in milliseconds
|
|
* @apiSuccess {Object} data.likes The likes of the message (always an empty object)
|
|
* @apiSuccess {Object} data.flags The flags of the message
|
|
* @apiSuccess {Number} data.flagCount The number of flags the message has
|
|
* @apiSuccess {UUID} data.uuid The User ID of the author of the message,
|
|
* or of the recipient if `sent` is true
|
|
* @apiSuccess {String} data.user The Display Name of the author of the message,
|
|
* or of the recipient if `sent` is true
|
|
* @apiSuccess {String} data.username The Username of the author of the message,
|
|
* or of the recipient if `sent` is true
|
|
*
|
|
* @apiUse MessageNotFound
|
|
* @apiUse MessageIdRequired
|
|
* @apiError (400) {BadRequest} messageGroupChatFlagAlreadyReported You have already
|
|
* reported this message
|
|
*/
|
|
api.flagPrivateMessage = {
|
|
method: 'POST',
|
|
url: '/members/flag-private-message/:messageId',
|
|
middlewares: [authWithHeaders()],
|
|
async handler (req, res) {
|
|
const chatReporter = chatReporterFactory('Inbox', req, res);
|
|
const message = await chatReporter.flag();
|
|
res.respond(200, {
|
|
ok: true,
|
|
message,
|
|
});
|
|
},
|
|
};
|
|
|
|
export default api;
|