SudoSOS Back-end API / terms-of-service / TermsOfServiceController
Class: TermsOfServiceController ​
The BaseController class is responsible for:
- Storing route definitions.
- Generating router objects based on the policy.
Extends ​
Constructors ​
Constructor ​
ts
new TermsOfServiceController(options): TermsOfServiceController;Creates a new terms of service controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
TermsOfServiceController
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() ​
ts
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() ​
ts
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getTOS() ​
ts
getTOS(req, res): Promise<void>;GET /terms-of-service
Parameters ​
| Parameter | Type |
|---|---|
req | Request |
res | Response |
Returns ​
Promise<void>
200 - The requested terms of service version
Operation Id ​
getTermsOfService
Tags ​
terms-of-service - Operations of terms of service controller
Security ​
JWT