net.sohelp.boot.engine.web.controller

类 NoticeController

java.lang.Object

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

net.sohelp.boot.engine.web.controller.NoticeController

@RestController(value="engine-web-notice")
 @RequestMapping(value="/engine/web/notice")
 @ConditionalOnExpression(value="${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.service.enabled:true} && ${sohelp-boot.engine.notice.enabled:true}")
public class NoticeController
extends BaseController

消息提醒

从以下版本开始:

2024/8/25 15:32

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
NoticeController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	batchDelete(Map<String,Object> dataMap) 批量删除通知接口 该接口用于根据传入的ID列表和类型，批量删除指定用户的通知
ApiResult<String>	batchRead(Map<String,Object> dataMap) 批量读取通知接口 该接口用于批量更新通知的读取状态，根据传入的通知ID列表和状态进行更新。
ApiResult<Map<String,List<Map<String,Object>>>>	getUnreadNotice() 获取未读通知列表 该接口用于获取当前登录用户的未读系统通知、私信和待办事项，每种类型最多返回6条数据。
ApiResult<Map<String,Integer>>	getUnreadNoticeNum() 获取未读通知数量 该接口用于获取当前登录用户的未读系统通知、私信和待办事项的数量
ApiResult<Pager<Map<String,Object>>>	pageLetter() 分页查询用户信件 根据用户ID和是否已读状态分页查询用户信件，并返回结果
ApiResult<Pager<Map<String,Object>>>	pageNotice() 获取我的通知 该接口用于分页查询当前登录用户的系统通知，包括通知标题、是否已读等信息，并按ID降序排列。
ApiResult<Pager<Map<String,Object>>>	pageTodo() 分页查询待办事项 该接口用于分页查询当前登录用户的待办事项，通过构建SQL查询语句，从数据库中获取待办事项列表，并进行格式化处理后返回。
ApiResult<String>	readAll(Map<String,Object> dataMap) 标记所有指定类型的通知为已读 该接口接收一个包含通知类型的请求体，并将该类型且未删除的通知标记为已读状态

从类继承的方法 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

构造器详细资料

NoticeController

public NoticeController()

方法详细资料

pageNotice

@GetMapping(value="/pageNotice")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> pageNotice()
                                                                                                          throws TokenAuthenticationException,
                                                                                                                 BusiException,
                                                                                                                 SQLException

获取我的通知 该接口用于分页查询当前登录用户的系统通知，包括通知标题、是否已读等信息，并按ID降序排列。

返回:

ApiResult>> 分页查询结果，包含通知信息的Map列表

抛出:

TokenAuthenticationException - 如果令牌认证失败，则抛出此异常

BusiException - 如果业务处理过程中出现异常，则抛出此异常

SQLException - 如果数据库查询过程中出现异常，则抛出此异常

pageLetter

@GetMapping(value="/pageLetter")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> pageLetter()
                                                                                                          throws TokenAuthenticationException,
                                                                                                                 BusiException,
                                                                                                                 SQLException

分页查询用户信件 根据用户ID和是否已读状态分页查询用户信件，并返回结果

返回:

分页查询结果，包含信件的Pager对象

抛出:

TokenAuthenticationException - 如果token验证失败，则抛出TokenAuthenticationException异常

BusiException - 如果业务逻辑出错，则抛出BusiException异常

SQLException - 如果数据库查询出错，则抛出SQLException异常

pageTodo

@GetMapping(value="/pageTodo")
 @Permission(value="")
public ApiResult<Pager<Map<String,Object>>> pageTodo()
                                                                                                      throws TokenAuthenticationException,
                                                                                                             BusiException,
                                                                                                             SQLException

分页查询待办事项 该接口用于分页查询当前登录用户的待办事项，通过构建SQL查询语句，从数据库中获取待办事项列表，并进行格式化处理后返回。

返回:

ApiResult>> 包含待办事项分页结果的ApiResult对象

抛出:

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

BusiException - 如果业务处理过程中发生异常，则抛出BusiException异常

SQLException - 如果数据库查询过程中发生异常，则抛出SQLException异常

readAll

@PostMapping(value="/readAll")
 @Permission(value="")
public ApiResult<String> readAll(@RequestBody
                                                                                         Map<String,Object> dataMap)
                                                                                  throws TokenAuthenticationException

标记所有指定类型的通知为已读 该接口接收一个包含通知类型的请求体，并将该类型且未删除的通知标记为已读状态

参数:

dataMap - 请求体，包含需要标记为已读的通知类型 - type: 通知的类型

返回:

操作成功的ApiResult对象

抛出:

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

batchRead

@PostMapping(value="/batchRead")
 @Permission(value="")
public ApiResult<String> batchRead(@RequestBody
                                                                                             Map<String,Object> dataMap)
                                                                                      throws TokenAuthenticationException

批量读取通知接口 该接口用于批量更新通知的读取状态，根据传入的通知ID列表和状态进行更新。

参数:

dataMap - 包含通知ID列表和状态的Map对象 - ids: 需要更新读取状态的通知ID列表 - is_read: 通知的读取状态，1表示已读，其他值表示未读

返回:

返回操作结果的ApiResult对象，包含操作成功的信息

抛出:

TokenAuthenticationException - 如果用户未认证或认证失败，则抛出TokenAuthenticationException异常

batchDelete

@PostMapping(value="/batchDelete")
 @Permission(value="")
public ApiResult<String> batchDelete(@RequestBody
                                                                                                 Map<String,Object> dataMap)
                                                                                          throws TokenAuthenticationException

批量删除通知接口 该接口用于根据传入的ID列表和类型，批量删除指定用户的通知

参数:

dataMap - 包含删除通知所需数据的Map，其中必须包含"ids"和"type"两个键 - "ids"：要删除的通知ID列表，类型为List - "type"：通知的类型，类型为String，对应NoticeTypeEnum的枚举值

返回:

操作结果，成功返回ok，失败返回错误信息

抛出:

TokenAuthenticationException - 如果验证令牌失败，则抛出该异常

getUnreadNotice

@GetMapping(value="/getUnreadNotice")
 @Permission(value="")
public ApiResult<Map<String,List<Map<String,Object>>>> getUnreadNotice()
                                                                                                                               throws TokenAuthenticationException

获取未读通知列表 该接口用于获取当前登录用户的未读系统通知、私信和待办事项，每种类型最多返回6条数据。

返回:

ApiResult 包含未读通知的Map，键为"notice"（系统通知）、"letter"（私信）和"todo"（待办事项），值为对应的通知列表

抛出:

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

getUnreadNoticeNum

@GetMapping(value="/getUnreadNoticeNum")
 @Permission(value="")
public ApiResult<Map<String,Integer>> getUnreadNoticeNum()
                                                                                                                    throws TokenAuthenticationException

获取未读通知数量 该接口用于获取当前登录用户的未读系统通知、私信和待办事项的数量

返回:

ApiResult> 包含未读通知数量的结果，键包括"notice"（系统通知）、"letter"（私信）和"todo"（待办事项）

抛出:

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常