SudoSOS Back-end API / banners / BannerController
Class: BannerController ​
Controller for managing all routes related to the banner entity.
Extends ​
Constructors ​
Constructor ​
new BannerController(options): BannerController;Creates a new banner controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
BannerController
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 ​
createBanner() ​
createBanner(req, res): Promise<void>;POST /banners
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The created banner entity
Operation Id ​
create
Tags ​
banners - Operations of banner controller
Security ​
JWT
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 ​
removeBanner() ​
removeBanner(req, res): Promise<void>;DELETE /banners/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Update success
Operation Id ​
delete
Tags ​
banners - Operations of banner controller
Security ​
JWT
returnActiveBanners() ​
returnActiveBanners(req, res): Promise<void>;GET /banners/active
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All active banners
Operation Id ​
getActive
Tags ​
banners - Operations of banner controller
Security ​
JWT
returnAllBanners() ​
returnAllBanners(req, res): Promise<void>;GET /banners
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing banners
Operation Id ​
getAllBanners
Tags ​
banners - Operations of banner controller
Security ​
JWT
returnSingleBanner() ​
returnSingleBanner(req, res): Promise<void>;GET /banners/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested banner entity
Operation Id ​
getBanner
Tags ​
banners - Operations of banner controller
Security ​
JWT
updateBanner() ​
updateBanner(req, res): Promise<void>;PATCH /banners/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested banner entity
Operation Id ​
update
Tags ​
banners - Operations of banner controller
Security ​
JWT
uploadBannerImage() ​
uploadBannerImage(req, res): Promise<void>;POST /banners/{id}/image
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Operation Id ​
updateImage
Tags ​
banners - Operations of banner controller
Security ​
JWT