AbstractActionController
Class AbstractActionController
Hierarchy
↳ AbstractActionController
Index
Properties
Methods
- badRequestResponse
- createdResponse
- forbiddenResponse
- getResponseService
- internalServerErrorResponse
- notFoundResponse
- okResponse
- permanentRedirectResponse
- requestTimeoutResponse
- unauthorizedResponse
Properties
Protected responseService
responseService: ResponseService
Inherited from AbstractResponseHelper.responseService
Defined in Library/Response/AbstractResponseHelper.ts:10
Methods
Protected badRequestResponse
badRequestResponse(message?: string, data?: any, meta?: Object): ClientErrorResponse
Inherited from AbstractResponseHelper.badRequestResponse
Defined in Library/Response/AbstractResponseHelper.ts:36
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ClientErrorResponse
Protected createdResponse
createdResponse(data?: any, meta?: any): SuccessfulResponse
Inherited from AbstractResponseHelper.createdResponse
Defined in Library/Response/AbstractResponseHelper.ts:20
Parameters:
| Name | Type |
|---|---|
Optional data | any |
Optional meta | any |
Returns: SuccessfulResponse
Protected forbiddenResponse
forbiddenResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Inherited from AbstractResponseHelper.forbiddenResponse
Defined in Library/Response/AbstractResponseHelper.ts:32
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected getResponseService
getResponseService(): ResponseService
Inherited from AbstractResponseHelper.getResponseService
Defined in Library/Response/AbstractResponseHelper.ts:12
Returns: ResponseService
Protected internalServerErrorResponse
internalServerErrorResponse(message?: string, data?: any, meta?: Object): ServerErrorResponse
Inherited from AbstractResponseHelper.internalServerErrorResponse
Defined in Library/Response/AbstractResponseHelper.ts:44
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ServerErrorResponse
Protected notFoundResponse
notFoundResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Inherited from AbstractResponseHelper.notFoundResponse
Defined in Library/Response/AbstractResponseHelper.ts:24
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected okResponse
okResponse(data?: any, meta?: any): SuccessfulResponse
Inherited from AbstractResponseHelper.okResponse
Defined in Library/Response/AbstractResponseHelper.ts:16
Parameters:
| Name | Type |
|---|---|
Optional data | any |
Optional meta | any |
Returns: SuccessfulResponse
Protected permanentRedirectResponse
permanentRedirectResponse(location: string, alt?: string, meta?: any): RedirectionResponse
Inherited from AbstractResponseHelper.permanentRedirectResponse
Defined in Library/Response/AbstractResponseHelper.ts:48
Parameters:
| Name | Type |
|---|---|
| location | string |
Optional alt | string |
Optional meta | any |
Returns: RedirectionResponse
Protected requestTimeoutResponse
requestTimeoutResponse(message?: string, data?: any, meta?: any): ClientErrorResponse
Inherited from AbstractResponseHelper.requestTimeoutResponse
Defined in Library/Response/AbstractResponseHelper.ts:28
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | any |
Returns: ClientErrorResponse
Protected unauthorizedResponse
unauthorizedResponse(message?: string, data?: any, meta?: Object): ClientErrorResponse
Inherited from AbstractResponseHelper.unauthorizedResponse
Defined in Library/Response/AbstractResponseHelper.ts:40
Parameters:
| Name | Type |
|---|---|
Optional message | string |
Optional data | any |
Optional meta | Object |
Returns: ClientErrorResponse