アプリケーション開発

クラウドプラグイン API

getAvailableCloudPlugins()

このメソッドは、利用可能クラウドプラグインの一覧を取得します。

サンプルコード
dSymphony.getAvailableCloudPlugins().then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});;

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "availableCloudPluginList": [
    {
      "cloudPluginId": "cp-ABCD68E8E851B5A4D40DE2F1DD6006F1",
      "cloudPluginName": "Fitbitクラウドプラグイン",
      "providerName": "NTT docomo",
      "summary": "Fitbitのクラウドサービスへアクセスするためのプラグイン",
      "availableProfile": ",/activity,, /activity/calorie, ...",
      "icon": "https://example.jp/Fitbit_app_icon.png",
      "version": null,
      "enabled": false
    },
    ...
  ]
}

getRegisteredCloudPlugins()

このメソッドは、登録済みクラウドプラグインの一覧を取得します。

サンプルコード
dSymphony.getRegisteredCloudPlugins().then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});;

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "cloudPluginList": [
    {
      "cloudPluginId": "cp-ABCD68E8E851B5A4D40DE2F1DD6006F1",
      "cloudPluginName": "Fitbitクラウドプラグイン",
      "providerName": "NTT docomo",
      "summary": "Fitbitのクラウドサービスへアクセスするためのプラグイン",
      "availableProfile": ",/activity, /activity/calorie, ...",
      "icon": "https://example.jp/Fitbit_app_icon.png",
      "version": null,
      "gatewayId": "gw-ABCDF2B125E77359DBEE37CB93004BA",
      "thingId": "th-ABCD5657116414AFBED688CC8BE1772E",
      "serviceId": "cp-ABCD322D22CB825D70CA910BEAAE32E2",
      "enabled": true,
      "expirationDate": null,
      "authorizeUri": "https://example.jp/link"
    }
  ]
}

getCloudPlugin()

このメソッドは、指定のクラウドプラグイン情報を取得します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
サンプルコード
dSymphony.getCloudPlugin({
  cloudPluginId  : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "cloudPluginInfo": {
    "cloudPluginId": "cp-ABCD8E8E851B5A4D40DE2F1DD6006F1",
    "cloudPluginName": "Fitbitクラウドプラグイン",
    "providerName": "NTT docomo",
    "summary": "Fitbitのクラウドサービスへアクセスするためのプラグイン",
    "availableProfile": ",/activity, /activity/calorie, ...",
    "icon": "https://example.jp/Fitbit_app_icon.png",
    "version": null,
    "gatewayId": null,
    "thingId": null,
    "serviceId": null,
    "enabled": false,
    "expirationDate": null,
    "authorizeUri": "https://example.jp/auth"
  }
}

enableCloudPlugin()

このメソッドは、指定のクラウドプラグインを有効化します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
サンプルコード
dSymphony.enableCloudPlugin({
  cloudPluginId  : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "cloudPluginInfo": {
    "cloudPluginId": "cp-ABCDE8E8E851B5A4D40DE2F1DD6006F1",
    "cloudPluginName": "Fitbitクラウドプラグイン",
    "providerName": "NTT docomo",
    "summary": "Fitbitのクラウドサービスへアクセスするためのプラグイン",
    "availableProfile": ",/activity, /activity/calorie, ...",
    "icon": "https://example.jp/Fitbit_app_icon.png",
    "version": null,
    "gatewayId": "gw-ABCDD8CBA2EA3B4F684DEE5C178A4D0A",
    "thingId": "th-ABCDDF4A4FA23C1FFA8B295ACD26F53A",
    "serviceId": "cp-fitbit-serviceId",
    "enabled": true,
    "expirationDate": null,
    "authorizeUri": "https://example.jp/auth"
  }
}

disableCloudPlugin()

このメソッドは、指定のクラウドプラグインを無効化します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
サンプルコード
dSymphony.disableCloudPlugin({
  cloudPluginId  : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null
}

addCloudPluginUser()

このメソッドは、クラウドプラグインユーザーを登録します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
userId String 必須 ユーザー ID。
サンプルコード
dSymphony.addCloudPluginUser({
  cloudPluginId : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1',
	userId        : 'AbCd521V'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null
}

deleteCloudPluginUser()

このメソッドは、クラウドプラグインユーザーを削除します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
userId String 必須 ユーザー ID。
サンプルコード
dSymphony.deleteCloudPluginUser({
  cloudPluginId : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1',
	userId        : 'AbCd521V'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null
}

getCloudPluginAccountLinkState()

このメソッドは、クラウドプラグインのアカウントリンキングにおける連携サービス認可状態を取得します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
サンプルコード
dSymphony.getCloudPluginAccountLinkState({
  cloudPluginId : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "status": "LINKED"
}

getCloudPluginAccountLinkToken()

このメソッドは、クラウドプラグインのアカウントリンキングに必要なワンタイムトークンを取得します。

このメソッドは、以下のプロパティを持ったオブジェクトを引数に取ります。

パラメータ
プロパティ名 型 必須 説明
cloudPluginId String 必須 クラウドプラグイン ID。
サンプルコード
dSymphony.getCloudPluginAccountLinkToken({
  cloudPluginId : 'cp-ABCD68E8E851B5A4D40DE2F1DD6006F1'
}).then(function (res) {
  console.log(JSON.stringify(res, null, '  '));
}).catch(function (error) {
  console.error(error);
});

このメソッドの実行が成功すると、コールバック関数には Symphony から返されたオブジェクトが引数に与えられます。

レスポンスの例
{
  "result": 0,
  "error": null,
  "token": "oTqUHbaJJWe3FO2lhG777TP-aRznaNBf",
  "expiresIn": 1800
}
アプリケーション開発