Class: HttpRequest

Members

---

rawMessage :boolean

raw response message を返す場合に true をセットする (Node.js専用)。

true を指定すると、execute 成功時の応答は http.IncomingMessage となる。

HTTP/2を使用する場合、http2.ClientHttp2Streamとなる。

Type:

• boolean

---

responseHeaders :Object

レスポンスヘッダ(Node.js のみ)

Type:

• Object

---

useHttp2 :boolean

HTTP/2 を使用する場合にtrueをセットする。(Node.js専用)。

Type:

• boolean

Methods

---

<static> closeHttp2Session(authority)

Parameters:

Name	Type	Description
authority	string	対象のauthority 未指定の場合は全てのセッションをcloseする

---

<static> getDefaultTimeout()

デフォルト通信タイムアウト値を取得する

Returns:

タイムアウト値(ミリ秒)

Type

number

---

<static> setDefaultTimeout(timeout)

デフォルト通信タイムアウト値を設定する

Parameters:

Name	Type	Description
timeout	number	タイムアウト値(ミリ秒)

---

addQueryParams(params)

クエリパラメータを追加する。以前設定されていた値に追加される。

Parameters:

Name	Type	Description
params	Object	パラメータ(Object形式)

Returns:

this

Type

HttpRequest

---

addRequestHeader(header, value)

リクエストヘッダを設定する。

注: 1つのヘッダに対して設定できる値は1つのみである。

Parameters:

Name	Type	Description
header	string	ヘッダ名
value	string	値

Returns:

this

Type

HttpRequest

---

execute()

HTTP リクエストを実行する。 X-Application-Id, X-Application-Key, X-Session-Token ヘッダは自動的に付与される。

Returns:

Promise

Type

Promise

---

setContentType(contentType)

Content-Type 設定する

Parameters:

Name	Type	Description
contentType	string	Content-Type

Returns:

this

Type

HttpRequest

---

setData(data)

送信データを設定する。

文字列を指定した場合は文字列がそのまま設定される。 Objectを指定した場合は JSON 文字列に変換される。 Blob および Buffer を指定した場合は、バイナリデータが設定される。

Parameters:

Name	Type	Description
data	Object	データ

Returns:

this

Type

HttpRequest

---

setMethod(method)

HTTP メソッドを設定する

Parameters:

Name	Type	Description
method	string	メソッド

Returns:

this

Type

HttpRequest

---

setQueryParam(key, value)

クエリパラメータ(1件)を設定する

Parameters:

Name	Type	Description
key	string	パラメータ名
value	Object	値

Returns:

this

Type

HttpRequest

---

setQueryParams(params)

クエリパラメータを設定する。以前設定されていた値は消去される。

Parameters:

Name	Type	Description
params	Object	パラメータ(Object形式)

Returns:

this

Type

HttpRequest

---

setReceiveResponseHeaders(receive)

レスポンスヘッダ受信設定を行う。

true に設定すると、execute 成功時の応答は {body: ..., headers: {...}, status: statusCode} 形式となる。

ブラウザ(XHR)の場合は、headers は文字列(全ヘッダ連結したもの)、 Node.js の場合は headers はヘッダ名をキーとした Object となる。

Parameters:

Name	Type	Description
receive	boolean	true の場合はレスポンスヘッダを受信する

Returns:

this

Type

HttpRequest

---

setResponseType(responseType)

ResponseType を設定する。 指定できるタイプは以下のいずれかで、返却されるレスポンスの型が変化する。 デフォルトは "text"。

• text : 文字列
• json : JSON。レスポンスは JSON.parse されたもの。
• blob : blob (ブラウザのみ)
• buffer : Buffer (Node.jsのみ)

Parameters:

Name	Type	Description
responseType	string	レスポンスタイプ

Returns:

this

Type

HttpRequest

---

setSessionToken(sessionToken)

SessionToken を設定する。

通常は本クラスのインスタンス生成時点で自動的に SessionToken は設定されている(ユーザログイン済みの場合)

Parameters:

Name	Type	Description
sessionToken	string	セッショントークン文字列

Returns:

this

Type

HttpRequest