Package com.bytedesk.core.thread
Class ThreadRestController
java.lang.Object
com.bytedesk.core.base.BaseRestController<ThreadRequest,ThreadRestService>
com.bytedesk.core.thread.ThreadRestController
@RestController
@RequestMapping("/api/v1/thread")
public class ThreadRestController
extends BaseRestController<ThreadRequest,ThreadRestService>
会话管理接口
- Since:
- 2024-01-29
- Author:
- Jackning
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<?>
close
(ThreadRequest request) 关闭会话org.springframework.http.ResponseEntity<?>
closeByTopic
(ThreadRequest request) org.springframework.http.ResponseEntity<?>
create
(ThreadRequest request) 创建会话org.springframework.http.ResponseEntity<?>
delete
(ThreadRequest request) 删除会话export
(ThreadRequest request, jakarta.servlet.http.HttpServletResponse response) 导出会话列表org.springframework.http.ResponseEntity<?>
queryByOrg
(ThreadRequest request) 根据组织查询会话org.springframework.http.ResponseEntity<?>
queryByThreadInvite
(ThreadRequest request) 查询邀请会话org.springframework.http.ResponseEntity<?>
queryByThreadTopic
(ThreadRequest request) 根据主题查询会话org.springframework.http.ResponseEntity<?>
queryByTopicAndOwner
(ThreadRequest request) 主要用于查询 某个成员 的 某个群组会话org.springframework.http.ResponseEntity<?>
queryByUid
(ThreadRequest request) 根据UID查询会话org.springframework.http.ResponseEntity<?>
queryByUser
(ThreadRequest request) 根据用户查询会话org.springframework.http.ResponseEntity<?>
queryByUserTopics
(ThreadRequest request) 根据用户UID查询所有会话org.springframework.http.ResponseEntity<?>
update
(ThreadRequest request) 更新会话org.springframework.http.ResponseEntity<?>
updateFold
(ThreadRequest request) org.springframework.http.ResponseEntity<?>
updateHide
(ThreadRequest request) org.springframework.http.ResponseEntity<?>
updateMute
(ThreadRequest request) 更新会话静音状态org.springframework.http.ResponseEntity<?>
updateNote
(ThreadRequest request) org.springframework.http.ResponseEntity<?>
updateStar
(ThreadRequest request) 更新会话标星状态org.springframework.http.ResponseEntity<?>
updateTagList
(ThreadRequest request) 更新会话标签列表org.springframework.http.ResponseEntity<?>
updateTop
(ThreadRequest request) 更新会话置顶状态org.springframework.http.ResponseEntity<?>
updateUnread
(ThreadRequest request) 更新会话未读状态org.springframework.http.ResponseEntity<?>
updateUser
(ThreadRequest request) 更新会话用户信息Methods inherited from class com.bytedesk.core.base.BaseRestController
deleteByOrgUid, exportTemplate, getService
-
Field Details
-
threadRestService
-
-
Constructor Details
-
ThreadRestController
public ThreadRestController()
-
-
Method Details
-
queryByOrg
根据组织查询会话- Overrides:
queryByOrg
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 查询请求- Returns:
- 分页会话列表
-
queryByUser
根据用户查询会话- Overrides:
queryByUser
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 查询请求- Returns:
- 分页会话列表
-
queryByThreadInvite
@GetMapping("/query/invite") public org.springframework.http.ResponseEntity<?> queryByThreadInvite(ThreadRequest request) 查询邀请会话- Parameters:
request
- 查询请求- Returns:
- 分页邀请会话列表
-
queryByThreadTopic
@GetMapping("/query/topic") public org.springframework.http.ResponseEntity<?> queryByThreadTopic(ThreadRequest request) 根据主题查询会话- Parameters:
request
- 查询请求- Returns:
- 会话信息
-
queryByTopicAndOwner
@GetMapping("/query/topic/owner") public org.springframework.http.ResponseEntity<?> queryByTopicAndOwner(ThreadRequest request) 主要用于查询 某个成员 的 某个群组会话- Parameters:
request
-- Returns:
-
queryByUid
根据UID查询会话- Overrides:
queryByUid
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 查询请求- Returns:
- 会话信息
-
create
@ActionAnnotation(title="\u4f1a\u8bdd", action="\u65b0\u5efa", description="create thread") public org.springframework.http.ResponseEntity<?> create(@RequestBody ThreadRequest request) 创建会话- Overrides:
create
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 创建会话请求- Returns:
- 创建的会话
-
update
@ActionAnnotation(title="\u4f1a\u8bdd", action="\u66f4\u65b0", description="update thread") public org.springframework.http.ResponseEntity<?> update(@RequestBody ThreadRequest request) 更新会话- Overrides:
update
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 更新会话请求- Returns:
- 更新后的会话
-
updateTop
@PostMapping("/update/top") public org.springframework.http.ResponseEntity<?> updateTop(@RequestBody ThreadRequest request) 更新会话置顶状态- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
updateStar
@PostMapping("/update/star") public org.springframework.http.ResponseEntity<?> updateStar(@RequestBody ThreadRequest request) 更新会话标星状态- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
updateMute
@PostMapping("/update/mute") public org.springframework.http.ResponseEntity<?> updateMute(@RequestBody ThreadRequest request) 更新会话静音状态- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
updateHide
@PostMapping("/update/hide") public org.springframework.http.ResponseEntity<?> updateHide(@RequestBody ThreadRequest request) -
updateFold
@PostMapping("/update/fold") public org.springframework.http.ResponseEntity<?> updateFold(@RequestBody ThreadRequest request) -
updateUser
@PostMapping("/update/user") public org.springframework.http.ResponseEntity<?> updateUser(@RequestBody ThreadRequest request) 更新会话用户信息- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
updateTagList
@PostMapping("/update/tagList") public org.springframework.http.ResponseEntity<?> updateTagList(@RequestBody ThreadRequest request) 更新会话标签列表- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
updateUnread
@PostMapping("/update/unread") public org.springframework.http.ResponseEntity<?> updateUnread(@RequestBody ThreadRequest request) 更新会话未读状态- Parameters:
request
- 更新请求- Returns:
- 更新后的会话
-
queryByUserTopics
@GetMapping("/query/by/user/topics") public org.springframework.http.ResponseEntity<?> queryByUserTopics(ThreadRequest request) 根据用户UID查询所有会话- Parameters:
request
- 包含userUid的请求- Returns:
- 用户所有会话列表
-
updateNote
@PostMapping("/update/note") public org.springframework.http.ResponseEntity<?> updateNote(@RequestBody ThreadRequest request) -
close
@ActionAnnotation(title="\u4f1a\u8bdd", action="close", description="close thread") @PostMapping("/close") public org.springframework.http.ResponseEntity<?> close(@RequestBody ThreadRequest request) 关闭会话- Parameters:
request
- 关闭请求- Returns:
- 关闭后的会话
-
closeByTopic
@PostMapping("/close/topic") public org.springframework.http.ResponseEntity<?> closeByTopic(@RequestBody ThreadRequest request) -
delete
删除会话- Overrides:
delete
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 删除请求- Returns:
- 删除结果
-
export
@ActionAnnotation(title="\u4f1a\u8bdd", action="\u5bfc\u51fa", description="export thread") @GetMapping("/export") public Object export(ThreadRequest request, jakarta.servlet.http.HttpServletResponse response) 导出会话列表- Overrides:
export
in classBaseRestController<ThreadRequest,
ThreadRestService> - Parameters:
request
- 导出请求response
- HTTP响应- Returns:
- 导出结果
-