跳转到主要内容

APIResponse

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

方法​

body​

添加于：v1.16 apiResponse.body

返回带有响应体的缓冲区。

用法

APIResponse.body();

返回

dispose​

添加于：v1.16 apiResponse.dispose

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

用法

APIResponse.dispose();

返回

headers​

添加于：v1.16 apiResponse.headers

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

用法

APIResponse.headers();

返回

headersArray​

添加于：v1.16 apiResponse.headersArray

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

用法

APIResponse.headersArray();

返回

ok​

添加于：v1.16 apiResponse.ok

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

用法

APIResponse.ok();

返回

securityDetails​

添加于：v1.61 apiResponse.securityDetails

返回 SSL 及其他安全信息。对于非 HTTPS 响应，解析结果为 null。对于重定向请求，返回重定向链中最后一个请求的相关信息。

用法

APIResponse.securityDetails();

返回

  • null | SecurityDetails#

    • issuer String (可选)

      证书中 Issuer 字段的通用名称组件。这仅用于信息目的。可选。

    • protocol String (可选)

      使用的特定 TLS 协议。(例如 TLS 1.3)。可选。

    • subjectName String (可选)

      证书中 Subject 字段的通用名称组件。这仅用于信息目的。可选。

    • validFrom double (可选)

      指定此证书何时生效的 Unix 时间戳（以秒为单位）。可选。

    • validTo double (可选)

      指定此证书何时失效的 Unix 时间戳（以秒为单位）。可选。

serverAddr​

添加于：v1.61 apiResponse.serverAddr

返回服务器的 IP 地址和端口。如果无法获取服务器地址，解析结果为 null。对于重定向请求，返回重定向链中最后一个请求的相关信息。

用法

APIResponse.serverAddr();

返回

  • null | ServerAddr#

    • ipAddress String

      服务器的 IPv4 或 IPv6 地址。

    • port int

status​

添加于：v1.16 apiResponse.status

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

用法

APIResponse.status();

返回

statusText​

添加于：v1.16 apiResponse.statusText

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

用法

APIResponse.statusText();

返回

text​

添加于：v1.16 apiResponse.text

返回响应体的文本表示。

用法

APIResponse.text();

返回

url​

添加于：v1.16 apiResponse.url

包含响应的 URL。

用法

APIResponse.url();

返回