APIResponse

APIResponse クラスは、APIRequestContext.get() および類似のメソッドによって返されるレスポンスを表します。

---

メソッド

body

追加バージョン: v1.16 apiResponse.body

レスポンスボディのバッファを返します。

使用法

APIResponse.body();

戻り値

• byte[]#

---

dispose

追加バージョン: v1.16 apiResponse.dispose

このレスポンスのボディを破棄します。呼び出されない場合、ボディはコンテキストが閉じるまでメモリに残ります。

使用法

APIResponse.dispose();

戻り値

• void#

---

headers

追加バージョン: v1.16 apiResponse.headers

このレスポンスに関連付けられたすべてのHTTPレスポンスヘッダーを含むオブジェクトです。

使用法

APIResponse.headers();

戻り値

• Map<String, String>#

---

headersArray

追加バージョン: v1.16 apiResponse.headersArray

このレスポンスに関連付けられたすべてのHTTPレスポンスヘッダーの配列です。ヘッダー名は小文字に変換されません。Set-Cookieのように複数のエントリを持つヘッダーは、配列内に複数回出現します。

使用法

APIResponse.headersArray();

戻り値

• List<HttpHeader>#

  • name String

    ヘッダー名。

  • value String

    ヘッダー値。

---

ok

追加バージョン: v1.16 apiResponse.ok

レスポンスが成功したかどうか (ステータスが200-299の範囲) を示すブール値が含まれます。

使用法

APIResponse.ok();

戻り値

• boolean#

---

status

追加バージョン: v1.16 apiResponse.status

レスポンスのステータスコード (例: 成功の場合は200) が含まれます。

使用法

APIResponse.status();

戻り値

• int#

---

statusText

追加バージョン: v1.16 apiResponse.statusText

レスポンスのステータステキスト (例: 通常は成功の場合の"OK") が含まれます。

使用法

APIResponse.statusText();

戻り値

• String#

---

text

追加バージョン: v1.16 apiResponse.text

レスポンスボディのテキスト表現を返します。

使用法

APIResponse.text();

戻り値

• String#

---

url

追加バージョン: v1.16 apiResponse.url

レスポンスのURLが含まれます。

使用法

APIResponse.url();

戻り値

• String#