APIResponse

APIResponse 类代表由 ApiRequestContext.GetAsync() 及类似方法返回的响应。

---

方法

BodyAsync

新增于：v1.16 apiResponse.BodyAsync

返回包含响应体的缓冲区。

用法

await ApiResponse.BodyAsync();

返回值

• byte[]#

---

DisposeAsync

新增于：v1.16 apiResponse.DisposeAsync

释放此响应的响应体。如果不调用此方法，则响应体将一直留在内存中直到上下文关闭。

用法

await ApiResponse.DisposeAsync();

返回值

• void#

---

Headers

新增于：v1.16 apiResponse.Headers

包含此响应所有关联的 HTTP 响应头对象。

用法

ApiResponse.Headers

返回值

• IDictionary<string, string>#

---

HeadersArray

新增于：v1.16 apiResponse.HeadersArray

一个包含此响应所有关联的 HTTP 响应头的数组。头名称不会转换为小写。具有多个条目的头，例如 Set-Cookie，在数组中会多次出现。

用法

ApiResponse.HeadersArray

返回值

• IReadOnlyList<HttpHeader>#

  • name string

    头的名称。

  • value string

    头的值。

---

JsonAsync

新增于：v1.16 apiResponse.JsonAsync

返回响应体的 JSON 表示。

如果响应体无法通过 JSON.parse 解析，此方法将抛出异常。

用法

await ApiResponse.JsonAsync();

返回值

• JsonElement?#

---

Ok

新增于：v1.16 apiResponse.Ok

包含一个布尔值，表示响应是否成功（状态码在 200-299 范围内）。

用法

ApiResponse.Ok

返回值

• bool#

---

Status

新增于：v1.16 apiResponse.Status

包含响应的状态码（例如，成功为 200）。

用法

ApiResponse.Status

返回值

• int#

---

StatusText

新增于：v1.16 apiResponse.StatusText

包含响应的状态文本（例如，成功通常为 "OK"）。

用法

ApiResponse.StatusText

返回值

• string#

---

TextAsync

新增于：v1.16 apiResponse.TextAsync

返回响应体的文本表示。

用法

await ApiResponse.TextAsync();

返回值

• string#

---

Url

新增于：v1.16 apiResponse.Url

包含响应的 URL。

用法

ApiResponse.Url

返回值

• string#