Notification - masaru-takano/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	サービスID。取得対象スマートデバイス
tag	string	No	タグ。任意タグ文字列 カンマ(,)区切りで任意個数指定。
uri	string	No	アイコン。アイコンファイルのURI。

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

{
  "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

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

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

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

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

{
  "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"
}

物理名	データ型	必須	説明
notificationId	string	Yes	ノーティフィケーションID ノーティフィケーションを識別するID。
attribute	string	Yes	アトリビュート名。
serviceId	string	Yes	0:正常応答 0以外:異常応答
interface	string	Yes	インターフェース名。
profile	string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.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

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

ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。

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

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

{
  "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"
}

物理名	データ型	必須	説明
notificationId	string	Yes	ノーティフィケーションID ノーティフィケーションを識別するID。
attribute	string	Yes	アトリビュート名。
serviceId	string	Yes	0:正常応答 0以外:異常応答
interface	string	Yes	インターフェース名。
profile	string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.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

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

スマートデバイスでノーティフィケーション操作でエラーが発生した時にイベントが発行される。表示要求に対する表示失敗のエラー、非表示要求に対する消去失敗のエラーなどが通知される。

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

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

{
  "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"
}

物理名	データ型	必須	説明
notificationId	string	Yes	ノーティフィケーションID ノーティフィケーションを識別するID。
attribute	string	Yes	アトリビュート名。
serviceId	string	Yes	0:正常応答 0以外:異常応答
interface	string	Yes	インターフェース名。
profile	string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.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

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

スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。

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

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

{
  "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"
}

物理名	データ型	必須	説明
notificationId	string	Yes	ノーティフィケーションID ノーティフィケーションを識別するID。
attribute	string	Yes	アトリビュート名。
serviceId	string	Yes	0:正常応答 0以外:異常応答
interface	string	Yes	インターフェース名。
profile	string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.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"
}