メインコンテンツへスキップ

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();

戻り値

  • List<HttpHeader>#
    • name String

      ヘッダー名です。

    • value String

      ヘッダーの値です。


ok

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

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

使用法

APIResponse.ok();

戻り値


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();

戻り値