Skip to main content

APIResponse

APIResponse 类表示 ApiRequestContext.GetAsync() 和类似方法返回的响应。

¥APIResponse class represents responses returned by ApiRequestContext.GetAsync() and similar methods.

方法​

¥Methods

BodyAsync​

Added in: v1.16 apiResponse.BodyAsync

返回带有响应正文的缓冲区。

¥Returns the buffer with response body.

用法

¥Usage

await ApiResponse.BodyAsync();

返回

¥Returns

DisposeAsync​

Added in: v1.16 apiResponse.DisposeAsync

处理此响应的正文。如果没有被调用，那么主体将保留在内存中，直到上下文关闭。

¥Disposes the body of this response. If not called then the body will stay in memory until the context closes.

用法

¥Usage

await ApiResponse.DisposeAsync();

返回

¥Returns

标头​

¥Headers

Added in: v1.16 apiResponse.Headers

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

¥An object with all the response HTTP headers associated with this response.

用法

¥Usage

ApiResponse.Headers

返回

¥Returns

HeadersArray​

Added in: v1.16 apiResponse.HeadersArray

包含与此响应关联的所有响应 HTTP 标头的数组。标头名称不是小写的。具有多个条目的标头（例如 Set-Cookie）会多次出现在数组中。

¥An array with all the response HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

用法

¥Usage

ApiResponse.HeadersArray

返回

¥Returns

标头的名称。

¥Name of the header.

标头的值。

¥Value of the header.

JsonAsync​

Added in: v1.16 apiResponse.JsonAsync

返回响应正文的 JSON 表示形式。

¥Returns the JSON representation of response body.

如果响应正文无法通过 JSON.parse 进行解析，则此方法将抛出异常。

¥This method will throw if the response body is not parsable via JSON.parse.

用法

¥Usage

await ApiResponse.JsonAsync();

返回

¥Returns

是​

¥Ok

Added in: v1.16 apiResponse.Ok

包含一个布尔值，说明响应是否成功（状态范围为 200-299）。

¥Contains a boolean stating whether the response was successful (status in the range 200-299) or not.

用法

¥Usage

ApiResponse.Ok

返回

¥Returns

状态​

¥Status

Added in: v1.16 apiResponse.Status

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

¥Contains the status code of the response (e.g., 200 for a success).

用法

¥Usage

ApiResponse.Status

返回

¥Returns

StatusText​

Added in: v1.16 apiResponse.StatusText

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

¥Contains the status text of the response (e.g. usually an "OK" for a success).

用法

¥Usage

ApiResponse.StatusText

返回

¥Returns

TextAsync​

Added in: v1.16 apiResponse.TextAsync

返回响应正文的文本表示形式。

¥Returns the text representation of response body.

用法

¥Usage

await ApiResponse.TextAsync();

返回

¥Returns

URL​

Added in: v1.16 apiResponse.Url

包含响应的 URL。

¥Contains the URL of the response.

用法

¥Usage

ApiResponse.Url

返回

¥Returns