Class: dConnect

dConnect

Device Connect

new dConnect()

Source:

Classes

URIBuilder

Namespaces

constants

Methods

<static> addEventListener(uri, event_cb, {Function], {Function])

指定されたDevice Connect Event APIにイベントリスナーを登録する。
Parameters:
Name Type Description
uri String 特定のDevice Connect Event APIを表すURI(必要なパラメータはURLパラメータとして埋め込まれている)
event_cb function 登録したいイベント受領用コールバック。
{Function] success_cb イベント登録成功コールバック
{Function] error_cb イベント登録失敗コールバック
Source:
Example
var uri = "http://localhost:4035/gotapi/battery/onchargingchange?device=xxx&clientId=yyy&accessToken=zzz";
dConnect.addEventListener(uri, event_cb, success_cb, error_cb);

<static> authorization(scopes, applicationName, success_cb, error_cb)

dConnectManagnerに認可を求める.
Parameters:
Name Type Description
scopes 使用するスコープの配列
applicationName アプリ名
success_cb 成功時のコールバック
error_cb 失敗時のコールバック
Source:
Example
// アクセスするプロファイル一覧を定義
var scopes = Array('servicediscovery', 'sysytem', 'battery');
// 認可を実行
dConnect.authorization(scopes, 'サンプル',
    function(clientId, clientSecret, accessToken) {
        // clientId, clientSecret, accessTokenを保存して、プロファイルにアクセス
    },
    function(errorCode, errorMessage) {
        alert('Failed to get accessToken.');
    });

<static> checkDeviceConnect(success_cb, error_cb)

Device Connect Managerが起動しているチェックする。そもそもインストールされていなければ、インストール 画面へと進ませる。
Parameters:
Name Type Description
success_cb function 成功時コールバック。
error_cb function 失敗時コールバック。
Source:

<static> combineScope(scopes)

スコープの配列を文字列に置換する.
Parameters:
Name Type Description
scopes Array.<String> スコープ一覧
Source:
Returns:
連結されたスコープ一覧

<static> connectWebSocket(accessToken, cb)

WebSocketを開く.

WebSocketは、一つしか接続することができない。 dConnect.isConnectedWebSocket()を用いて、接続確認はできるので、 接続されている場合には、一度、dConnect.disconnectWebSocket()で 切断してから、再度接続処理を行って下さい。

Parameters:
Name Type Description
accessToken String Device Connectシステムから取得したアクセストークン
cb WebSocketの開閉イベントを受け取るコールバック関数
Source:
Example
// Websocketを開く
dConnect.connectWebSocket(accessToken, function(eventCode, message) {
});

<static> createClient(successCallback, errorCallback)

クライアントを作成する.
Parameters:
Name Type Description
successCallback クライアント作成に成功した場合のコールバック
errorCallback クライアント作成に失敗した場合のコールバック
Source:
Example
dConnect.createClient(
    function(clientId) {
        // clientIdを保存して、アクセストークンの取得に使用する
    },
    function(errorCode, errorMessage) {
    }
);

<static> disconnectWebSocket()

WebSocketを切断する.
Source:

<static> discoverDevices(accessToken, successCallback, errorCallback)

Service Discovery APIへの簡易アクセスを提供する。
Parameters:
Name Type Description
accessToken String アクセストークン
successCallback function 成功時コールバック。
errorCallback function 失敗時コールバック。
Source:
Example
// デバイスの検索
dConnect.discoverDevices(accessToken,
    function(json) {
        var devices = json.services;
    },
    function(errorCode, errorMessage) {
    });

<static> discoverDevicesFromProfile(profileName, accessToken, success_cb, error_cb)

プロファイル名からサービス一覧を取得するためのAPIを提供する。
Parameters:
Name Type Description
profileName String プロファイル名
accessToken String アクセストークン
success_cb function 成功時コールバック。
error_cb function 失敗時コールバック。
Source:
Example
// サービスの検索
discoverDevicesFromProfile('battery', accessToken,
    function(json) {
        var services = json.services;
    },
    function(errorCode, errorMessage) {
    });

<static> execute(method, uri, header, data, successCallback, errorCallback)

REST API呼び出し.
Parameters:
Name Type Description
method String HTTPメソッド
uri String URI
header Object.<String, String> HTTPリクエストヘッダー。Key-Valueマップで渡す。
data コンテンツデータ
successCallback dConnect.HTTPSuccessCallback 成功時コールバック。
errorCallback dConnect.HTTPFailCallback 失敗時コールバック。
Source:
See:
  • sendRequest

<static> getBaseDomain() → {String}

ベースとなるドメイン名を取得する.
Source:
Returns:
ドメイン名
Type
String

<static> getSystemDeviceInfo(serviceId, accessToken, success_cb, error_cb)

Service Information APIへの簡易アクセスを提供する。
Parameters:
Name Type Description
serviceId String サービスID
accessToken String アクセストークン
success_cb dConnect.HTTPSuccessCallback 成功時コールバック。
error_cb dConnect.HTTPFailCallback 失敗時コールバック。
Source:

<static> getSystemInfo(accessToken, success_cb, error_cb)

System APIへの簡易アクセスを提供する。
Parameters:
Name Type Description
accessToken String アクセストークン
success_cb function 成功時コールバック。
error_cb function 失敗時コールバック。
Source:

<static> isEnabledAntiSpoofing()

サーバからのレスポンス受信時にサーバの認証を行うかどうかのフラグを取得する.
Source:
Returns:
サーバの認証を行う場合はtrue、そうでない場合はfalse

<static> isSSLEnabled()

HTTPおよびWebSocket通信でSSLを使用するかどうかを取得する.

デフォルト設定ではSSLは使用しない。

Source:
Returns:
SSLを使用する場合はtrue、使用しない場合はfalse

<static> parent.delete(uri, header, success, error)

Device Connect RESTful APIのDELETEメソッドを実行する.

+ レスポンスの受信に成功した場合でも、サーバの認証に失敗した場合はエラーコールバックを実行する.

Parameters:
Name Type Description
uri String URI
header Object.<String, String> リクエストヘッダー。Key-Valueマップで渡す。
success function 成功時コールバック
error function 失敗時コールバック
Source:

<static> parent.get(uri, headers, success, error)

Device Connect RESTful APIのGETメソッドを実行する.

+ レスポンスの受信に成功した場合でも、サーバの認証に失敗した場合はエラーコールバックを実行する.

Parameters:
Name Type Description
uri String URI
headers Object.<String, String> リクエストヘッダー。Key-Valueマップで渡す。
success function 成功時コールバック
error function 失敗時コールバック
Source:

<static> parent.post(uri, header, data, success, error)

Device Connect RESTful APIのPOSTメソッドを実行する.

+ レスポンスの受信に成功した場合でも、サーバの認証に失敗した場合はエラーコールバックを実行する.

Parameters:
Name Type Description
uri String URI
header Object.<String, String> リクエストヘッダー。Key-Valueマップで渡す。
data コンテンツデータ
success function 成功時コールバック
error function 失敗時コールバック
Source:

<static> parent.put(uri, header, data, success, error)

Device Connect RESTful APIのPUTメソッドを実行する.

+ レスポンスの受信に成功した場合でも、サーバの認証に失敗した場合はエラーコールバックを実行する.

Parameters:
Name Type Description
uri String URI
header Object.<String, String> リクエストヘッダー。Key-Valueマップで渡す。
data コンテンツデータ
success function 成功時コールバック
error function 失敗時コールバック
Source:

<static> removeEventListener(uri, {Function], {Function])

指定されたDevice Connect Event APIからイベントリスナーを削除する。
Parameters:
Name Type Description
uri String 特定のDevice Connect Event APIを表すURI(必要なパラメータはURLパラメータとして埋め込まれている)
{Function] success_cb イベント登録解除成功コールバック
{Function] error_cb イベント登録解除失敗コールバック
Source:
Example
var uri = "http://localhost:4035/gotapi/battery/onchargingchange?device=xxx&clientId=yyy&accessToken=zzz";
dConnect.removeEventListener(uri, success_cb, error_cb);

<static> requestAccessToken(clientId, scopes, applicationName, successCallback, errorCallback)

アクセストークンを要求する.
Parameters:
Name Type Description
clientId クライアントID
scopes スコープ一覧(配列)
applicationName アプリ名
successCallback アクセストークン取得に成功した場合のコールバック
errorCallback アクセストークン取得に失敗した場合のコールバック
Source:
Example
dConnect.requestAccessToken(clientId, scopes, 'アプリ名',
    function(accessToken) {
        // アクセストークンの保存して、プロファイルのアクセスを行う
    },
    function(errorCode, errorMessage) {
    }
);

<static> sendRequest(method, uri, header, data, success, error)

Device Connect RESTful APIを実行する.

+ レスポンスの受信に成功した場合でも、サーバの認証に失敗した場合はエラーコールバックを実行する.

Parameters:
Name Type Description
method String メソッド
uri String URI
header Object.<String, String> リクエストヘッダー。Key-Valueマップで渡す。
data コンテンツデータ
success function 成功時コールバック
error function 失敗時コールバック
Source:

<static> setAntiSpoofing(enable)

サーバからのレスポンス受信時にサーバの認証を行うかどうかを設定する.
Parameters:
Name Type Description
enable サーバの認証を行う場合はtrue、そうでない場合はfalse
Source:

<static> setExtendedOrigin(o)

オリジンを設定する. ハイブリッドアプリとして動作させる場合には本メソッドでオリジンを設定する.
Parameters:
Name Type Description
o String オリジン
Source:

<static> setHost(h)

ホスト名を設定する.
Parameters:
Name Type Description
h String ホスト名
Source:

<static> setLaunchListener(listener)

Device Connect Managerの起動通知を受信するリスナーを設定する.

注意: Device Connect Managerの起動はアプリケーションの表示状態が非表示から表示へ 遷移したタイミングで確認される.

Parameters:
Name Type Description
listener リスナー
Source:

<static> setPort(p)

ポート番号を設定する.
Parameters:
Name Type Description
p Number ポート番号
Source:

<static> setSSLEnabled(enabled)

HTTPおよびWebSocket通信でSSLを使用するかどうかを設定する.

デフォルト設定ではSSLは使用しない。

Parameters:
Name Type Description
enabled String SSLを使用する場合はtrue、使用しない場合はfalse
Source:

<static> setURISchemeName(name)

Manager起動用URIスキームの名前を設定する.
Parameters:
Name Type Description
name String Manager起動用URIスキームの名前
Source:

<static> startManager(state)

Device Connect Managerを起動する.
Parameters:
Name Type Description
state 起動画面を出すか出さないか
Source:

<static> stopManager(state)

Device Connect Managerを停止する.
Parameters:
Name Type Description
state 停止画面を出すか出さないか
Source:

Type Definitions

HTTPFailCallback(readyState, status)

HTTP通信失敗時のコールバック。
Parameters:
Name Type Argument Description
readyState Number HTTPリクエスト送信に用いたXMLHTTPRequestの、失敗時のreadyState
status Number <nullable>
HTTPレスポンスのステータスコード
Source:

HTTPSuccessCallback(status, headers, responseText)

HTTP通信成功時のコールバック。
Parameters:
Name Type Description
status Number HTTPレスポンスのステータスコード
headers Object.<String, String> HTTPレスポンスのヘッダー
responseText String HTTPレスポンスのテキスト
Source: