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#