AbstractActionController
Class AbstractActionController
Hierarchy
AbstractActionController
Index
Properties
Methods
- badRequestResponse
- createdResponse
- forbiddenResponse
- getResponseService
- internalServerErrorResponse
- notFoundResponse
- okResponse
- permanentRedirectResponse
- requestTimeoutResponse
- unauthorizedResponse
Properties
Protected responseService
responseService: ResponseService
Defined in Library/Controller/AbstractActionController.ts:12
Methods
Protected badRequestResponse
badRequestResponse(message?: string, data?: any, meta?: Object): ClientErrorResponse
Defined in Library/Controller/AbstractActionController.ts:38
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ClientErrorResponse
Protected createdResponse
createdResponse(data?: any, meta?: any): SuccessfulResponse
Defined in Library/Controller/AbstractActionController.ts:22
Parameters:
| Name | Type |
|---|---|
Optional data | any |
Optional meta | any |
Returns: SuccessfulResponse
Protected forbiddenResponse
forbiddenResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Defined in Library/Controller/AbstractActionController.ts:34
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected getResponseService
getResponseService(): ResponseService
Defined in Library/Controller/AbstractActionController.ts:14
Returns: ResponseService
Protected internalServerErrorResponse
internalServerErrorResponse(message?: string, data?: any, meta?: Object): ServerErrorResponse
Defined in Library/Controller/AbstractActionController.ts:46
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ServerErrorResponse
Protected notFoundResponse
notFoundResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Defined in Library/Controller/AbstractActionController.ts:26
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected okResponse
okResponse(data?: any, meta?: any): SuccessfulResponse
Defined in Library/Controller/AbstractActionController.ts:18
Parameters:
| Name | Type |
|---|---|
Optional data | any |
Optional meta | any |
Returns: SuccessfulResponse
Protected permanentRedirectResponse
permanentRedirectResponse(location: string, alt?: string, meta?: any): RedirectionResponse
Defined in Library/Controller/AbstractActionController.ts:50
Parameters:
| Name | Type |
|---|---|
| location | string |
Optional alt | string |
Optional meta | any |
Returns: RedirectionResponse
Protected requestTimeoutResponse
requestTimeoutResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Defined in Library/Controller/AbstractActionController.ts:30
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected unauthorizedResponse
unauthorizedResponse(message?: string, data?: any, meta?: Object): ClientErrorResponse
Defined in Library/Controller/AbstractActionController.ts:42
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ClientErrorResponse