no versions found for ApplicationFrameworkReferences / Utility/Network/webapi_makeResponse / en

WebApi: makeResponse()

HTTP リクエストと HTTP レスポンスから必要な結果を取り出します。

このメソッドは非同期関数であり、オーバーライド可能です。

概要

このメソッドは WebApi の HTTP 対応メソッドがメソッド呼び出しの返値を作成するために呼び出されます。つまり、このメソッドをオーバーライドすることでメソッド呼び出しの結果をカスタマイズすることができます。

既定の動作は各メソッドを参照してください。

構文

webApi.makeResponse(request, response) => Promise<object>

引数

  • request: object

    makeRequest で作成したリクエストオブジェクトです。

  • response: Response

    取得したレスポンスオブジェクトです。

返値: Promise<object>

HTTP 対応メソッドの呼び出し結果となるレスポンスデータです。既定ではリクエストメソッドとレスポンスステータスによってデータの形状が決定されます。それぞれの形状は各メソッドを参照してください。

例外

  • WebApiError
    • レスポンスステータスコードが 4xx 系または 5xx 系だった場合