net.sohelp.boot.demo.web.notice

类 AppNoticeController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.demo.web.notice.AppNoticeController

@RestController(value="admin-notice")
 @RequestMapping(value="/admin/notice")
public class AppNoticeController
extends BaseController

消息通知控制器 提供各类消息（如系统消息、待办事项等）的查询、发送及状态管理功能。

从以下版本开始:

2023/5/16

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器和说明
AppNoticeController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	deleteMsg(Map<String,Object> paramMap) 删除指定ID的消息（逻辑删除）
ApiResult<Pager<Map<String,Object>>>	getUnRead(NoticeTypeEnum type) 获取指定类型的未读消息列表并进行分页处理
ApiResult<Map<String,Object>>	getUnReadMsgNum() 获取当前登录用户的各类型未读消息数量统计
ApiResult<List<Map<String,Object>>>	list(NoticeTypeEnum type) 获取指定类型的所有消息列表（不分页）
ApiResult<String>	markRead(NoticeTypeEnum type) 将某类消息标记为已读
ApiResult<Pager<Map<String,Object>>>	page(NoticeTypeEnum type) 分页获取指定类型的消息列表
ApiResult<String>	read(Map<String,Object> paramMap) 标记指定ID的消息为已读
ApiResult<String>	sendDingDing(Map<String,Object> paramMap) 发送钉钉工作通知消息给指定用户
ApiResult<Object>	sendEmail(Map<String,Object> paramMap) 发送邮件消息给指定用户
ApiResult<Object>	sendPhone(Map<String,Object> paramMap) 发送短信消息给指定用户
ApiResult<String>	sendQq(Map<String,Object> paramMap) 发送QQ用户消息（预留方法）
ApiResult<String>	sendQywx(Map<String,Object> paramMap) 发送企业微信应用消息给指定用户
ApiResult<String>	sendSystem(Map<String,Object> paramMap) 发送系统消息给指定用户
ApiResult<String>	sendTodo(Map<String,Object> paramMap) 发送待办事项消息给指定用户
ApiResult<String>	sendUser(Map<String,Object> paramMap) 发送用户间私信消息
ApiResult<String>	sendWx(Map<String,Object> paramMap) 发送微信公众号模板消息给指定用户

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AppNoticeController

public AppNoticeController()

方法详细资料

page

@GetMapping(value="/page")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> page(@RequestParam
                                                                                                     NoticeTypeEnum type)
                                                                                              throws Exception

分页获取指定类型的消息列表

参数:

type - 消息类型枚举

返回:

返回分页数据结果集

抛出:

Exception - 数据库操作异常或其他错误

getUnReadMsgNum

@GetMapping(value="/getUnReadMsgNum")
 @Permission(value="")
public ApiResult<Map<String,Object>> getUnReadMsgNum()
                                                                                                             throws Exception

获取当前登录用户的各类型未读消息数量统计

返回:

各类型未读消息数映射表

抛出:

Exception - 数据库操作异常或其他错误

getUnRead

@GetMapping(value="/getUnRead")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> getUnRead(@RequestParam
                                                                                                               NoticeTypeEnum type)
                                                                                                        throws Exception

获取指定类型的未读消息列表并进行分页处理

参数:

type - 消息类型枚举

返回:

包含未读消息的分页对象

抛出:

Exception - 数据库操作异常或其他错误

list

@GetMapping(value="/list")
 @Permission(value="")
public ApiResult<List<Map<String,Object>>> list(@RequestParam
                                                                                                    NoticeTypeEnum type)
                                                                                             throws Exception

获取指定类型的所有消息列表（不分页）

参数:

type - 消息类型枚举

返回:

所有符合条件的消息列表

抛出:

Exception - 数据库操作异常或其他错误

markRead

@PostMapping(value="/markRead")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> markRead(@RequestParam
                                                                                                                                                   NoticeTypeEnum type)
                                                                                                                                            throws Exception

将某类消息标记为已读

参数:

type - 消息类型枚举

返回:

成功或失败信息

抛出:

Exception - 数据库更新异常或其他错误

deleteMsg

@PostMapping(value="/delete")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> deleteMsg(@RequestBody
                                                                                                                                                  Map<String,Object> paramMap)
                                                                                                                                           throws Exception

删除指定ID的消息（逻辑删除）

参数:

paramMap - 请求参数，包含要删除的消息ID数组

返回:

删除是否成功的提示信息

抛出:

Exception - 数据库更新异常或其他错误

read

@PostMapping(value="/read")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> read(@RequestBody
                                                                                                                                           Map<String,Object> paramMap)
                                                                                                                                    throws Exception

标记指定ID的消息为已读

参数:

paramMap - 请求参数，包含需要设为已读的消息ID数组

返回:

设置是否成功的提示信息

抛出:

Exception - 数据库更新异常或其他错误

sendSystem

@PostMapping(value="/sendSystem")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendSystem(@RequestBody
                                                                                                                                                       Map<String,Object> paramMap)
                                                                                                                                                throws Exception

发送系统消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入异常或其他错误

sendTodo

@PostMapping(value="/sendTodo")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendTodo(@RequestBody
                                                                                                                                                   Map<String,Object> paramMap)
                                                                                                                                            throws Exception

发送待办事项消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入异常或其他错误

sendUser

@PostMapping(value="/sendUser")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendUser(@RequestBody
                                                                                                                                                   Map<String,Object> paramMap)
                                                                                                                                            throws Exception

发送用户间私信消息

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入异常或其他错误

sendWx

@PostMapping(value="/sendWx")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendWx(@RequestBody
                                                                                                                                               Map<String,Object> paramMap)
                                                                                                                                        throws Exception

发送微信公众号模板消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入或第三方接口调用异常

sendDingDing

@PostMapping(value="/sendDingDing")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendDingDing(@RequestBody
                                                                                                                                                           Map<String,Object> paramMap)
                                                                                                                                                    throws Exception

发送钉钉工作通知消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入或第三方接口调用异常

sendQywx

@PostMapping(value="/sendQywx")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendQywx(@RequestBody
                                                                                                                                                   Map<String,Object> paramMap)
                                                                                                                                            throws Exception

发送企业微信应用消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入或第三方接口调用异常

sendQq

@PostMapping(value="/sendQq")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<String> sendQq(@RequestBody
                                                                                                                                               Map<String,Object> paramMap)
                                                                                                                                        throws Exception

发送QQ用户消息（预留方法）

参数:

paramMap - 请求参数

返回:

发送结果提示信息

抛出:

Exception - 异常情况

sendPhone

@PostMapping(value="/sendPhone")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<Object> sendPhone(@RequestBody
                                                                                                                                                     Map<String,Object> paramMap)
                                                                                                                                              throws Exception

发送短信消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入或第三方接口调用异常

sendEmail

@PostMapping(value="/sendEmail")
 @Permission(value="")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<Object> sendEmail(@RequestBody
                                                                                                                                                     Map<String,Object> paramMap)
                                                                                                                                              throws Exception

发送邮件消息给指定用户

参数:

paramMap - 请求参数，包括接收人ID和消息内容

返回:

发送结果提示信息

抛出:

Exception - 数据库插入或第三方接口调用异常