ServiceResult Class
表示服务调用结果的类。
本类同时提供了若干获取不同结果的静态方法,便于快速调用。
Namespace: QuickAdmin.CommonAssembly: QuickAdmin.Net (in QuickAdmin.Net.dll) Version: 2.0.13
public class ServiceResult : IServiceResult
- Inheritance
- object ServiceResult
- Derived
- Implements
- IServiceResult
本类提供了针对不同场景的丰富重载。在正常业务开发中,请按语义使用,不要刻意给参数传入
null 字面量,以免因编译器无法区分重载而导致编译错误。另外,有些调用需要明确书写才能正确匹配重载版本,例如:
var result1 = ServiceResult.Ok("abc"); // 表示消息为 'abc' 的成功结果
var result2 = ServiceResult.Ok<string>("abc"); // 表示数据为字符串 'abc' 的成功结果
Public Properties |
| ActionResult |
获取返回的 IActionResult。此属性不会被 Json 序列化。
|
| Code |
获取/设置返回的代码。
|
| Msg |
获取/设置返回的消息。
|
| Success |
指示调用是否成功。此属性不会被 Json 序列化。
|
Public Methods |
| AccessDenied(string, int) |
获取一个表示调用失败的,包含 403Forbidden 纯文本 ContentResult 的结果。
|
| AccessDeniedT(string, int, T) |
获取一个表示调用失败的,包含 403Forbidden 纯文本 ContentResult 以及指定类型数据的结果。
|
| Action(IActionResult) |
获取一个表示调用成功的,包含指定 IActionResult 的结果。
|
| ActionT(IActionResult, T) |
获取一个表示调用成功的,包含指定 IActionResult 以及指定类型数据的结果。
|
| BadRequest(string, int) |
获取一个表示调用失败的,包含 BadRequestResult 的结果。
|
| BadRequestT(string, int, T) |
获取一个表示调用失败的,包含 BadRequestResult 以及指定类型数据的结果。
|
| Failed(int) |
获取一个表示调用失败的结果。可指定返回代码。
|
| Failed(string, int) |
获取一个表示调用失败的结果。可指定返回消息和返回代码。
|
| FailedT(int, T) |
获取一个返回指定类型数据的,表示调用失败的结果。
可指定返回代码和返回数据。
|
| FailedT(string, int, T) |
获取一个返回指定类型数据的,表示调用失败的结果。
可指定返回消息、返回代码和返回数据。
|
| Forbid(string, int) |
获取一个表示调用失败的,包含 ForbidResult 的结果。
|
| ForbidT(string, int, T) |
获取一个表示调用失败的,包含 ForbidResult 以及指定类型数据的结果。
|
| FromResult(IServiceResult) |
由指定的 IServiceResult 构造无返回数据的结果。
|
| FromResultT(IServiceResult, T) |
由指定的 IServiceResult 构造包含指定类型数据的结果。
|
| NotFound(string, int) |
获取一个表示调用失败的,包含 NotFoundResult 的结果。
|
| NotFoundT(string, int, T) |
获取一个表示调用失败的,包含 NotFoundResult 以及指定类型数据的结果。
|
| Ok(string) |
获取一个表示调用成功的结果。
|
| OkT(T, string) |
获取一个返回指定类型数据的,表示调用成功的结果。
|
| Result(bool, string) |
获取一个表示调用成功或者表示调用失败的结果。
|
| ResultT(bool, string, T) |
获取一个表示调用成功或者表示调用失败的,包含指定类型数据的结果。
|
| StatusCode(int, string) |
获取一个表示 HTTP 响应状态(ActionResult 是一个 StatusCodeResult)的结果。
|
| StatusCodeT(int, string, T) |
获取一个表示 HTTP 响应状态(ActionResult 是一个 StatusCodeResult)的,包含指定类型数据的结果。
|
| Unauthorized(string, int) |
获取一个表示调用失败的,包含 UnauthorizedResult 的结果。
|
| UnauthorizedT(string, int, T) |
获取一个表示调用失败的,包含 UnauthorizedResult 以及指定类型数据的结果。
|