net.sohelp.boot.dev.web.system.notice

类 AppNoticeController

java.lang.Object

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

net.sohelp.boot.dev.web.system.notice.AppNoticeController

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

消息通知控制器，用于处理系统内各种类型的消息发送、查询与管理操作。

从以下版本开始:

2023/5/16

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
AppNoticeController()

方法概要

限定符和类型	方法和说明
ApiResult	deleteMsg(Map<String,Object> paramMap) 删除多个消息记录（软删除）
ApiResult	getUnRead(AppNoticeTypeEnum type) 获取指定类型的未读消息列表（分页）
ApiResult	getUnReadMsgNum() 获取当前登录用户的各类未读消息数量统计
ApiResult	list(AppNoticeTypeEnum type) 获取指定类型的所有消息列表（不分页）
ApiResult	markRead(AppNoticeTypeEnum type) 标记某类消息全部已读
ApiResult	page(AppNoticeTypeEnum type) 分页获取指定类型的通知消息列表
ApiResult	read(Map<String,Object> paramMap) 设置多个消息为已读状态
ApiResult	sendDingDing(Map<String,Object> paramMap) 发送钉钉用户消息
ApiResult<Object>	sendEmail(Map<String,Object> paramMap) 发送邮件消息给用户
ApiResult<Object>	sendPhone(Map<String,Object> paramMap) 发送短信消息给用户
ApiResult<Object>	sendQq(Map<String,Object> paramMap) 发送QQ用户消息（暂无实际实现）
ApiResult<Object>	sendQywx(Map<String,Object> paramMap) 发送企业微信用户消息
ApiResult	sendSystem(Map<String,Object> paramMap) 发送系统消息
ApiResult	sendTodo(Map<String,Object> paramMap) 发送待办事项消息
ApiResult	sendUser(Map<String,Object> paramMap) 发送用户自定义消息
ApiResult	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="ADMIN")
public ApiResult page(@RequestParam
                                                                               AppNoticeTypeEnum type)
                                                                        throws Exception

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

参数:

type - 消息类型枚举值

返回:

返回分页结果集

抛出:

Exception - 数据库访问异常或其他业务逻辑错误时抛出

getUnReadMsgNum

@GetMapping(value="/getUnReadMsgNum")
 @Permission(value="ADMIN")
public ApiResult getUnReadMsgNum()
                                                                                              throws Exception

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

返回:

包含各类型未读数目的Map对象

抛出:

Exception - 数据库访问异常或其他业务逻辑错误时抛出

getUnRead

@GetMapping(value="/getUnRead")
 @Permission(value="ADMIN")
public ApiResult getUnRead(@RequestParam
                                                                                         AppNoticeTypeEnum type)
                                                                                  throws Exception

获取指定类型的未读消息列表（分页）

参数:

type - 消息类型枚举值

返回:

返回分页后的未读消息列表

抛出:

Exception - 数据库访问异常或其他业务逻辑错误时抛出

list

@GetMapping(value="/list")
 @Permission(value="ADMIN")
public ApiResult list(@RequestParam
                                                                               AppNoticeTypeEnum type)
                                                                        throws Exception

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

参数:

type - 消息类型枚举值

返回:

返回所有符合条件的消息列表

抛出:

Exception - 数据库访问异常或其他业务逻辑错误时抛出

markRead

@PostMapping(value="/markRead")
 @Permission(value="ADMIN")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult markRead(@RequestParam
                                                                                                                                                AppNoticeTypeEnum type)
                                                                                                                                         throws Exception

标记某类消息全部已读

参数:

type - 消息类型枚举值

返回:

成功或失败信息

抛出:

Exception - 数据库更新异常或其他业务逻辑错误时抛出

deleteMsg

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

删除多个消息记录（软删除）

参数:

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

返回:

成功或失败信息

抛出:

Exception - 数据库更新异常或其他业务逻辑错误时抛出

read

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

设置多个消息为已读状态

参数:

paramMap - 请求参数，包含要标记为已读的消息ID列表

返回:

成功或失败信息

抛出:

Exception - 数据库更新异常或其他业务逻辑错误时抛出

sendSystem

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

发送系统消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendTodo

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

发送待办事项消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendUser

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

发送用户自定义消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendWx

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

发送微信公众号消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendDingDing

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

发送钉钉用户消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendQywx

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

发送企业微信用户消息

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出

sendQq

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

发送QQ用户消息（暂无实际实现）

参数:

paramMap - 请求参数

返回:

固定返回“发送成功”

抛出:

Exception - 异常情况

sendPhone

@PostMapping(value="/sendPhone")
 @Permission(value="ADMIN")
 @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="ADMIN")
 @Transactional(rollbackFor=java.lang.Exception.class)
public ApiResult<Object> sendEmail(@RequestBody
                                                                                                                                                          Map<String,Object> paramMap)
                                                                                                                                                   throws Exception

发送邮件消息给用户

参数:

paramMap - 请求参数，包括接收人ID、消息内容等字段

返回:

成功或失败信息

抛出:

Exception - 数据库插入异常或其他业务逻辑错误时抛出