Package com.bytedesk.core.settings

Class SettingsRestController

java.lang.Object

com.bytedesk.core.base.BaseRestController<SettingsRequest,SettingsRestService>

com.bytedesk.core.settings.SettingsRestController

@RestController
@RequestMapping("/api/v1/settings")
@Description("Settings Management Controller - Content settings and categorization APIs")
public class SettingsRestController
extends BaseRestController<SettingsRequest,SettingsRestService>

Field Summary

Fields

Modifier and Type	Field	Description
private final SettingsRestService	settingsRestService

Constructor Summary

Constructors

Constructor	Description
SettingsRestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	create(SettingsRequest request)	通用的create实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法
org.springframework.http.ResponseEntity<?>	delete(SettingsRequest request)	通用的delete实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法
Object	export(SettingsRequest request, jakarta.servlet.http.HttpServletResponse response)	export
org.springframework.http.ResponseEntity<?>	queryByOrg(SettingsRequest request)	通用的queryByOrg实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法
org.springframework.http.ResponseEntity<?>	queryByUid(SettingsRequest request)	通用的queryByUid实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法
org.springframework.http.ResponseEntity<?>	queryByUser(SettingsRequest request)	通用的queryByUser实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法
org.springframework.http.ResponseEntity<?>	queryPlatformEmailSettings()	查询平台级别邮件配置
org.springframework.http.ResponseEntity<?>	queryPlatformSmsSettings()	查询平台级别短信配置
org.springframework.http.ResponseEntity<?>	queryPlatformTicketCenterSettings()	查询平台级别工单中心配置
org.springframework.http.ResponseEntity<?>	savePlatformEmailSettings(SettingsRequest request)	保存/更新平台级别邮件配置
org.springframework.http.ResponseEntity<?>	savePlatformSmsSettings(SettingsRequest request)	保存/更新平台级别短信配置
org.springframework.http.ResponseEntity<?>	savePlatformTicketCenterSettings(SettingsRequest request)	保存/更新平台级别工单中心配置
org.springframework.http.ResponseEntity<?>	testPlatformEmailSettings(String testEmail)	测试平台邮件配置
org.springframework.http.ResponseEntity<?>	testPlatformSmsSettings(String testMobile)	测试平台短信配置
org.springframework.http.ResponseEntity<?>	update(SettingsRequest request)	通用的update实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

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

settingsRestService

private final SettingsRestService settingsRestService

Constructor Details

SettingsRestController

public SettingsRestController()

Method Details

queryByOrg

@ActionAnnotation(title="Settings",
                  action="\u7ec4\u7ec7\u67e5\u8be2",
                  description="query settings by org")
public org.springframework.http.ResponseEntity<?> queryByOrg(SettingsRequest request)

Description copied from class: BaseRestController

通用的queryByOrg实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

queryByOrg in class BaseRestController<SettingsRequest,SettingsRestService>

queryByUser

@ActionAnnotation(title="Settings",
                  action="\u7528\u6237\u67e5\u8be2",
                  description="query settings by user")
public org.springframework.http.ResponseEntity<?> queryByUser(SettingsRequest request)

Description copied from class: BaseRestController

通用的queryByUser实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

queryByUser in class BaseRestController<SettingsRequest,SettingsRestService>

queryByUid

@ActionAnnotation(title="Settings",
                  action="\u67e5\u8be2\u8be6\u60c5",
                  description="query settings by uid")
public org.springframework.http.ResponseEntity<?> queryByUid(SettingsRequest request)

Description copied from class: BaseRestController

通用的queryByUid实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

queryByUid in class BaseRestController<SettingsRequest,SettingsRestService>

create

@ActionAnnotation(title="Settings",
                  action="\u65b0\u5efa",
                  description="create settings")
public org.springframework.http.ResponseEntity<?> create(SettingsRequest request)

Description copied from class: BaseRestController

通用的create实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

create in class BaseRestController<SettingsRequest,SettingsRestService>

update

@ActionAnnotation(title="Settings",
                  action="\u66f4\u65b0",
                  description="update settings")
public org.springframework.http.ResponseEntity<?> update(SettingsRequest request)

Description copied from class: BaseRestController

通用的update实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

update in class BaseRestController<SettingsRequest,SettingsRestService>

delete

@ActionAnnotation(title="Settings",
                  action="\u5220\u9664",
                  description="delete settings")
public org.springframework.http.ResponseEntity<?> delete(SettingsRequest request)

Description copied from class: BaseRestController

通用的delete实现 减少子类重复代码 注意：由于泛型擦除，需要使用PageableRequest.class来查找方法

Overrides:

delete in class BaseRestController<SettingsRequest,SettingsRestService>

export

@ActionAnnotation(title="Settings",
                  action="\u5bfc\u51fa",
                  description="export settings")
@GetMapping("/export")
public Object export(SettingsRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Description copied from class: BaseRestController

export

Overrides:

export in class BaseRestController<SettingsRequest,SettingsRestService>

Parameters:

request - role

Returns:

json

queryPlatformEmailSettings

@ActionAnnotation(title="Settings",
                  action="\u67e5\u8be2\u5e73\u53f0\u90ae\u4ef6\u914d\u7f6e",
                  description="query platform email settings")
@GetMapping("/platform/email")
public org.springframework.http.ResponseEntity<?> queryPlatformEmailSettings()

查询平台级别邮件配置

savePlatformEmailSettings

@ActionAnnotation(title="Settings",
                  action="\u4fdd\u5b58\u5e73\u53f0\u90ae\u4ef6\u914d\u7f6e",
                  description="save platform email settings")
@PostMapping("/platform/email")
public org.springframework.http.ResponseEntity<?> savePlatformEmailSettings(@RequestBody
 SettingsRequest request)

保存/更新平台级别邮件配置

queryPlatformSmsSettings

@ActionAnnotation(title="Settings",
                  action="\u67e5\u8be2\u5e73\u53f0\u77ed\u4fe1\u914d\u7f6e",
                  description="query platform sms settings")
@GetMapping("/platform/sms")
public org.springframework.http.ResponseEntity<?> queryPlatformSmsSettings()

查询平台级别短信配置

savePlatformSmsSettings

@ActionAnnotation(title="Settings",
                  action="\u4fdd\u5b58\u5e73\u53f0\u77ed\u4fe1\u914d\u7f6e",
                  description="save platform sms settings")
@PostMapping("/platform/sms")
public org.springframework.http.ResponseEntity<?> savePlatformSmsSettings(@RequestBody
 SettingsRequest request)

保存/更新平台级别短信配置

queryPlatformTicketCenterSettings

@ActionAnnotation(title="Settings",
                  action="\u67e5\u8be2\u5e73\u53f0\u5de5\u5355\u4e2d\u5fc3\u914d\u7f6e",
                  description="query platform ticket center settings")
@GetMapping("/platform/ticket-center")
public org.springframework.http.ResponseEntity<?> queryPlatformTicketCenterSettings()

查询平台级别工单中心配置

savePlatformTicketCenterSettings

@ActionAnnotation(title="Settings",
                  action="\u4fdd\u5b58\u5e73\u53f0\u5de5\u5355\u4e2d\u5fc3\u914d\u7f6e",
                  description="save platform ticket center settings")
@PostMapping("/platform/ticket-center")
public org.springframework.http.ResponseEntity<?> savePlatformTicketCenterSettings(@RequestBody
 SettingsRequest request)

保存/更新平台级别工单中心配置

testPlatformEmailSettings

@ActionAnnotation(title="Settings",
                  action="\u6d4b\u8bd5\u5e73\u53f0\u90ae\u4ef6\u914d\u7f6e",
                  description="test platform email settings")
@PostMapping("/platform/email/test")
public org.springframework.http.ResponseEntity<?> testPlatformEmailSettings(@RequestParam
 String testEmail)

测试平台邮件配置

testPlatformSmsSettings

@ActionAnnotation(title="Settings",
                  action="\u6d4b\u8bd5\u5e73\u53f0\u77ed\u4fe1\u914d\u7f6e",
                  description="test platform sms settings")
@PostMapping("/platform/sms/test")
public org.springframework.http.ResponseEntity<?> testPlatformSmsSettings(@RequestParam
 String testMobile)

测试平台短信配置