Touch - masaru-takano/DeviceConnect-Spec GitHub Wiki

スマートデバイス上でのタッチイベントを通知するプロファイル。

API	概要
GET /gotapi/touch/onDoubleTap	デバイスでダブルタップされたイベントを取得する。
PUT /gotapi/touch/onDoubleTap	デバイスでダブルタップされたイベントの受信を開始する。
DELETE /gotapi/touch/onDoubleTap	当該イベントの通知を停止する。
GET /gotapi/touch/onTouch	デバイスでタッチ(touchstart,touchendされた後)されたイベントを取得する。
PUT /gotapi/touch/onTouch	デバイスでタッチ(touchstart,touchendされた後)されたイベントの受信を開始する。
DELETE /gotapi/touch/onTouch	当該イベントの通知を停止する。
GET /gotapi/touch/onTouchCancel	デバイスでタッチがキャンセルされたイベントを取得する。
PUT /gotapi/touch/onTouchCancel	デバイスでタッチがキャンセルされたイベントの受信を開始する。
DELETE /gotapi/touch/onTouchCancel	当該イベントの通知を停止する。
GET /gotapi/touch/onTouchEnd	デバイスでタッチが終了したイベントを取得する。
PUT /gotapi/touch/onTouchEnd	デバイスでタッチが終了したイベントの受信を開始する。
DELETE /gotapi/touch/onTouchEnd	当該イベントの通知を停止する。
GET /gotapi/touch/onTouchMove	デバイスでタッチされ続けているイベントを取得する。
PUT /gotapi/touch/onTouchMove	デバイスでタッチされ続けているイベントの受信を開始する。
DELETE /gotapi/touch/onTouchMove	当該イベントの通知を停止する。
GET /gotapi/touch/onTouchStart	デバイスでタッチが開始されたイベントを取得する。
PUT /gotapi/touch/onTouchStart	デバイスでタッチが開始されたイベントの受信を開始する。
DELETE /gotapi/touch/onTouchStart	当該イベントの通知を停止する。

one-shot

デバイスでダブルタップされたイベントを取得する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

物理名			データ型	必須	説明
result			integer	Yes	0:正常応答 0以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

event

デバイスでダブルタップされたイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ondoubletap",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

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

デバイスでタッチ(touchstart,touchendされた後)されたイベントを取得する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

物理名			データ型	必須	説明
result			integer	Yes	0:正常応答 0以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 256,
      "y" : 128,
      "id" : 0
    }, {
      "x" : 64,
      "y" : 32,
      "id" : 1
    } ]
  }
}

event

デバイスでタッチ(touchstart,touchendされた後)されたイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouch",
  "touch" : {
    "touches" : [ {
      "x" : 256,
      "y" : 128,
      "id" : 0
    }, {
      "x" : 64,
      "y" : 32,
      "id" : 1
    } ]
  }
}

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以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 192,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 256,
      "id" : 1
    } ]
  }
}

event

デバイスでタッチがキャンセルされたイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchcancel",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 192,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 256,
      "id" : 1
    } ]
  }
}

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以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 512,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 768,
      "id" : 1
    } ]
  }
}

event

デバイスでタッチが終了したイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchend",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 512,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 768,
      "id" : 1
    } ]
  }
}

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以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 16,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 32,
      "y" : 64,
      "id" : 1
    } ]
  }
}

event

デバイスでタッチされ続けているイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchmove",
  "touch" : {
    "touches" : [ {
      "x" : 16,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 32,
      "y" : 64,
      "id" : 1
    } ]
  }
}

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以外:異常応答
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 64,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 128,
      "y" : 256,
      "id" : 1
    } ]
  }
}

event

デバイスでタッチが開始されたイベントの受信を開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

物理名	データ型	必須	説明
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"
}

物理名			データ型	必須	説明
touch			object	Yes	イベントの内容を保持するオブジェクト。
	touches		array(object)	Yes	各タッチに関する情報の配列。
		id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchstart",
  "touch" : {
    "touches" : [ {
      "x" : 64,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 128,
      "y" : 256,
      "id" : 1
    } ]
  }
}

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