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

戻り値

• IEnumerable<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#