SudoSOS Back-end API / internal/server-settings / ServerSettingsController
Class: ServerSettingsController ​
The BaseController class is responsible for:
- Storing route definitions.
- Generating router objects based on the policy.
Extends ​
Constructors ​
Constructor ​
new ServerSettingsController(options): ServerSettingsController;Parameters ​
| Parameter | Type |
|---|---|
options | BaseControllerOptions |
Returns ​
ServerSettingsController
Overrides ​
Properties ​
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
roleManager | protected | RoleManager | A reference to the role manager passed in the base controller options. | BaseController.roleManager |
specification | public | SwaggerSpecification | A reference to the swagger specification passed in the base controller options. | BaseController.specification |
Methods ​
getPolicy() ​
getPolicy(): Policy;Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.
Returns ​
The policy of this controller.
Overrides ​
getRouter() ​
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getWrappedEnabled() ​
getWrappedEnabled(req, res): Promise<void>;GET /server-settings/wrapped-enabled
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Success.
Operation Id ​
getWrappedEnabled
Tags ​
serverSettings - Operations of the server settings controller
Security ​
JWT
setMaintenanceMode() ​
setMaintenanceMode(req, res): Promise<void>;PUT /server-settings/maintenance-mode
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success.
Operation Id ​
setMaintenanceMode
Tags ​
serverSettings - Operations of the server settings controller
Security ​
JWT
setWrappedEnabled() ​
setWrappedEnabled(req, res): Promise<void>;PUT /server-settings/wrapped-enabled
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success.
Operation Id ​
setWrappedEnabled
Tags ​
serverSettings - Operations of the server settings controller
Security ​
JWT