Touch - TakayukiHoshi1984/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	デバイスでタッチ(touchstart,touchendされた後)されたイベントの受信を停止する。
GET /gotapi/touch/onTouchCancel	デバイスでタッチがキャンセルされたイベントを取得する。
PUT /gotapi/touch/onTouchCancel	デバイスでタッチがキャンセルされたイベントの受信を開始する。
DELETE /gotapi/touch/onTouchCancel	デバイスでタッチがキャンセルされたイベントの受信を停止する。
GET /gotapi/touch/onTouchChange	デバイスでタッチされた座標と状態をイベントとして取得する。
PUT /gotapi/touch/onTouchChange	デバイスでタッチされた座標と状態をイベントとしての受信を開始する。
DELETE /gotapi/touch/onTouchChange	デバイスでタッチされた座標と状態をイベントとしての受信を停止する。
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	デバイスでタッチが開始されたイベントの受信を停止する。

GET /gotapi/touch/onDoubleTap

種別

one-shot

概要

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

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onDoubleTap

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onDoubleTap

種別

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

GET /gotapi/touch/onTouch

種別

one-shot

概要

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

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onTouch

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onTouch

種別

event

概要

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

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

リクエスト

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

GET /gotapi/touch/onTouchCancel

種別

one-shot

概要

デバイスでタッチがキャンセルされたイベントを取得する。

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onTouchCancel

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onTouchCancel

種別

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

GET /gotapi/touch/onTouchChange

種別

one-shot

概要

デバイスでタッチされた座標と状態をイベントとして取得する。

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

リクエスト

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

レスポンス

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチの状態		state	string	No	start:タッチを開始した。 end:タッチが終了した。 doubletap:ダブルタップが行われた。 move:タッチされ続けている。 cancel:タッチが中断された。
タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
	ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
	x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
	y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

レスポンスサンプル

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

PUT /gotapi/touch/onTouchChange

種別

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

イベント

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
タッチの状態		state	string	No	start:タッチを開始した。 end:タッチが終了した。 doubletap:ダブルタップが行われた。 move:タッチされ続けている。 cancel:タッチが中断された。
タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
	ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
	x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
	y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

イベントサンプル

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

DELETE /gotapi/touch/onTouchChange

種別

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

GET /gotapi/touch/onTouchEnd

種別

one-shot

概要

デバイスでタッチが終了したイベントを取得する。

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onTouchEnd

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onTouchEnd

種別

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

GET /gotapi/touch/onTouchMove

種別

one-shot

概要

デバイスでタッチされ続けているイベントを取得する。

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onTouchMove

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onTouchMove

種別

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

GET /gotapi/touch/onTouchStart

種別

one-shot

概要

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

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

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/touch/onTouchStart

種別

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

イベント

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

イベントサンプル

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

DELETE /gotapi/touch/onTouchStart

種別

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

Touch - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

目次

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

⚠️ GitHub.com Fallback ⚠️