Class: HttpRequest

HttpRequest

HTTPリクエストクラス


new HttpRequest(service, path, option)

コンストラクタ。

ユーザがログイン中の場合、自動的に SessionToken が設定される。

Parameters:
Name Type Description
service NebulaService

NebulaService

path string

パス

option Object

オプション。noprefix プロパティに true を設定すると、パスプレフィクス("/1/{tenantId}")を付与しない。

Members


responseHeaders :Object

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

Type:
  • Object

Methods


<static> get()

HTTP2 の使用・不使用状態を返す

Returns:

HTTP2を使用する場合は true

Type
boolean

<static> getDefaultTimeout()

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

Returns:

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

Type
number

<static> set(value)

HTTP2 の使用・不使用を指定する。 HTTP2 を使用する場合は、Node.js v8.x 以上が必要。

Parameters:
Name Type Description
value boolean

HTTP2を使用する場合は true


<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