Package com.bytedesk.core.topic

Class TopicRestController

java.lang.Object

com.bytedesk.core.base.BaseRestController<TopicRequest,TopicRestService>

com.bytedesk.core.topic.TopicRestController

@RestController
@RequestMapping("/api/v1/topic")
public class TopicRestController
extends BaseRestController<TopicRequest,TopicRestService>

主题管理接口

Since:

2024-04-13

Author:

Jackning

Field Summary

Fields

Modifier and Type	Field	Description
private final TopicRestService	topicRestService

Constructor Summary

Constructors

Constructor	Description
TopicRestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	create(TopicRequest request)	创建主题
org.springframework.http.ResponseEntity<?>	delete(TopicRequest request)	删除主题
Object	export(TopicRequest request, jakarta.servlet.http.HttpServletResponse response)	导出主题列表
org.springframework.http.ResponseEntity<?>	isSubscribed(TopicRequest request)
org.springframework.http.ResponseEntity<?>	queryByOrg(TopicRequest request)	根据组织查询主题
org.springframework.http.ResponseEntity<?>	queryByUid(TopicRequest request)	根据UID查询主题
org.springframework.http.ResponseEntity<?>	queryByUser(TopicRequest request)	根据用户查询主题
org.springframework.http.ResponseEntity<?>	subscribe(TopicRequest request)	订阅主题
org.springframework.http.ResponseEntity<?>	unsubscribe(TopicRequest request)	取消订阅主题
org.springframework.http.ResponseEntity<?>	update(TopicRequest request)	更新主题

Methods inherited from class com.bytedesk.core.base.BaseRestController

deleteByOrgUid, exportTemplate, getService

Methods inherited from class java.lang.Object

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

Field Details

topicRestService

private final TopicRestService topicRestService

Constructor Details

TopicRestController

public TopicRestController()

Method Details

queryByOrg

public org.springframework.http.ResponseEntity<?> queryByOrg(TopicRequest request)

根据组织查询主题

Overrides:

queryByOrg in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 查询请求

Returns:

分页主题列表

queryByUser

public org.springframework.http.ResponseEntity<?> queryByUser(TopicRequest request)

根据用户查询主题

Overrides:

queryByUser in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 查询请求

Returns:

分页主题列表

queryByUid

public org.springframework.http.ResponseEntity<?> queryByUid(TopicRequest request)

根据UID查询主题

Overrides:

queryByUid in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 查询请求

Returns:

主题信息

create

@ActionAnnotation(title="\u4e3b\u9898",
                  action="\u65b0\u5efa",
                  description="create topic")
public org.springframework.http.ResponseEntity<?> create(@RequestBody
 TopicRequest request)

创建主题

Overrides:

create in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 创建主题请求

Returns:

创建的主题

update

@ActionAnnotation(title="\u4e3b\u9898",
                  action="\u66f4\u65b0",
                  description="update topic")
public org.springframework.http.ResponseEntity<?> update(@RequestBody
 TopicRequest request)

更新主题

Overrides:

update in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 更新主题请求

Returns:

更新后的主题

isSubscribed

@GetMapping("/is/subscribed")
public org.springframework.http.ResponseEntity<?> isSubscribed(TopicRequest request)

subscribe

@PostMapping("/subscribe")
public org.springframework.http.ResponseEntity<?> subscribe(@RequestBody
 TopicRequest request)

订阅主题

Parameters:

request - 订阅请求

Returns:

订阅结果

unsubscribe

@PostMapping("/unsubscribe")
public org.springframework.http.ResponseEntity<?> unsubscribe(@RequestBody
 TopicRequest request)

取消订阅主题

Parameters:

request - 取消订阅请求

Returns:

取消订阅结果

delete

@ActionAnnotation(title="\u4e3b\u9898",
                  action="\u5220\u9664",
                  description="delete topic")
public org.springframework.http.ResponseEntity<?> delete(@RequestBody
 TopicRequest request)

删除主题

Overrides:

delete in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 删除请求

Returns:

删除结果

export

@ActionAnnotation(title="\u4e3b\u9898",
                  action="\u5bfc\u51fa",
                  description="export topic")
public Object export(TopicRequest request,
 jakarta.servlet.http.HttpServletResponse response)

导出主题列表

Overrides:

export in class BaseRestController<TopicRequest,TopicRestService>

Parameters:

request - 导出请求

response - HTTP响应

Returns:

导出结果