Class: URIBuilder

(private) dConnectSDK.URIBuilder()

(private) new URIBuilder()

Publicなクラスとしては非推奨. URIを作成するためのユーティリティクラス。 コンストラクタの引数には、オブジェクトを指定することもできる.

ホスト名やポート番号は、省略された場合にはdConnectSDK.setHost()、 dConnectSDK.setPort()で指定された値が設定される。

Source:
Example
let builder = new dConnect.URIBuilder();
builder.setProfile('battery');
builder.setAttribute('level');
builder.setServiceId(serviceId);
builder.setAccessToken(accessToken);
builder.addParameter('key', 'value');

const uri = builder.build('GET');

uriは'http://localhost:4035/gotapi/battery/level?serviceId=serviceId&accessToken=accessToken&key=value'に変換される。

Methods

(static) URIBuilder#addParameter(key, value) → {URIBuilder}

パラメータを追加する。
Parameters:
Name Type Description
key String キー
value Object.<String, String> バリュー
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#build(method) → {String}

URIに変換する。
Parameters:
Name Type Description
method String HTTPMethod
Source:
Returns:
uri
Type
String

(static) URIBuilder#getApi() → {String}

APIを取得する。 デフォルトではgotapiが指定される。
Source:
Returns:
API
Type
String

(static) URIBuilder#getAttribute() → {String}

アトリビュート名を取得する。
Source:
Returns:
アトリビュート名
Type
String

(static) URIBuilder#getHost() → {String}

ホスト名を取得する。
Source:
Returns:
ホスト名
Type
String

(static) URIBuilder#getInterface() → {String}

インターフェース名を取得する。
Source:
Returns:
インターフェース名
Type
String

(static) URIBuilder#getPath() → {String}

パスを取得する。
Source:
Returns:
パス
Type
String

(static) URIBuilder#getPort() → {Number}

ポート番号を取得する。
Source:
Returns:
ポート番号
Type
Number

(static) URIBuilder#getProfile() → {String}

プロファイル名を取得する。
Source:
Returns:
プロファイル名
Type
String

(static) URIBuilder#getScheme() → {String}

スキーマ名を取得する。
Source:
Returns:
スキーマ名
Type
String

(static) URIBuilder#setAccessToken(accessToken) → {URIBuilder}

アクセストークンを設定する。
Parameters:
Name Type Description
accessToken String アクセストークン
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setApi(api) → {URIBuilder}

APIを設定する。

デフォルトではgotapiが指定される。

Parameters:
Name Type Description
api String API
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setAttribute(attribute) → {URIBuilder}

アトリビュート名を設定する。
Parameters:
Name Type Description
attribute String アトリビュート名
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setHost(host) → {URIBuilder}

ホスト名を設定する。

デフォルトでは、dConnectSDK.setHost()で設定された値が設定される。
何も設定していない場合にはlocalhostが設定される。

Parameters:
Name Type Description
host String ホスト名
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setPath(path) → {URIBuilder}

パスを設定する。
Parameters:
Name Type Description
path String パス
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setPort(port) → {URIBuilder}

ポート番号を設定する。

デフォルトでは、dConnectSDK.setPort()で設定された値が設定される。
何も設定していない場合には4035が設定される。

Parameters:
Name Type Description
port Number ポート番号
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setProfile(profile) → {URIBuilder}

プロファイル名を設定する。

Device Connectで定義してあるプロファイル名を指定すること。

  • servicediscovery
  • system
  • battery
  • mediastreamrecording
などなど。

Parameters:
Name Type Description
profile String プロファイル名
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setScheme(scheme) → {URIBuilder}

スキーム名を設定する。

デフォルトでは、dConnectSDK.isSSLEnabled()が真の場合にhttps、そうでない場合にはhttpが設定されている。

Parameters:
Name Type Description
scheme String スキーム名
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setServiceId(serviceId) → {URIBuilder}

サービスIDを設定する。
Parameters:
Name Type Description
serviceId String サービスID
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

(static) URIBuilder#setSessionKey(sessionKey) → {URIBuilder}

セッションキーを設定する。
Parameters:
Name Type Description
sessionKey String セッションキー
Deprecated:
  • Yes
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder

setInterface(interface) → {URIBuilder}

インターフェース名を設定する。
Parameters:
Name Type Description
interface String インターフェース名
Source:
Returns:
自分自身のインスタンス
Type
URIBuilder