Notification - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

スマートデバイスのノーティフィケーションを操作する機能。

API	概要
POST /gotapi/notification/notify	スマートデバイスにノーティフィケーションの表示リクエストを送信する。
DELETE /gotapi/notification/notify	スマートデバイスにノーティフィケーションの消去リクエストを送信する。
GET /gotapi/notification/onClick	スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 取得する。
PUT /gotapi/notification/onClick	スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 開始する。
DELETE /gotapi/notification/onClick	スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 停止する。
GET /gotapi/notification/onClose	スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 取得する。
PUT /gotapi/notification/onClose	スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 開始する。
DELETE /gotapi/notification/onClose	スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 停止する。
GET /gotapi/notification/onError	スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを取得する。
PUT /gotapi/notification/onError	スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを開始する。
DELETE /gotapi/notification/onError	スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを停止する。
GET /gotapi/notification/onShow	スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 取得する。
PUT /gotapi/notification/onShow	スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 開始する。
DELETE /gotapi/notification/onShow	スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 停止する。

one-shot

スマートデバイスにノーティフィケーションの表示リクエストを送信する。

ノーティフィケーションの表示リクエストの到達成否を応答として返却し、 ノーティフィケーションの表示完了を待って応答をするわけではない。
ノーティフィケーションの表示方法は表示リクエストを受けたスマートデバイスに依存する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
type	integer	Yes	通知タイプ。通知のタイプを識別する。 0: 音声通話着信 1: メール着信 2: SMS着信 3: イベント
dir	string	No	向き。メッセージの文字の向き。 auto: 自動 rtl: 右から左 ltr: 左から右
lang	string	No	言語。メッセージの言語。 ref. BCP47
body	string	No	表示させる文字列。
tag	string	No	タグ。任意タグ文字列 カンマ(,)区切りで任意個数指定。
uri	string	No	アイコン。アイコンファイルのURI。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ユニークな文字列。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

one-shot

スマートデバイスにノーティフィケーションの消去リクエストを送信する。

ノーティフィケーションの消去リクエストの到達成否を応答として返却し、 ノーティフィケーションの消去完了を待って応答をするわけではない。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
notificationId	string	Yes	通知ID。ユニークな文字列。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 開始する。

スマートデバイスでノーティフィケーションがクリック(タップ)された時に イベントが発行される。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

論理名	物理名	データ型	必須	説明
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclick",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを 停止する。

スマートデバイスでノーティフィケーションがクリック(タップ) された時にイベントが発行される。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 開始する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

論理名	物理名	データ型	必須	説明
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclose",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを 停止する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを開始する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

論理名	物理名	データ型	必須	説明
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onerror",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーション操作でエラーが発生したことを 通知するイベントを停止する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 取得する。

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 開始する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

論理名	物理名	データ型	必須	説明
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onshow",
  "notificationId" : 123456
}

event

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを 停止する。

スマートデバイスでサポートしていないパラメータがある場合には、 そのパラメータを省略する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}