Canvas

概要

デバイスに画像を描画・削除する機能を提供するAPI。

目次

API	概要
POST /gotapi/canvas/drawImage	デバイスに画像を描画する。
DELETE /gotapi/canvas/drawImage	デバイスに描画した画像を削除する。

POST /gotapi/canvas/drawImage

種別

one-shot

概要

デバイスに画像を描画する。

すでにCanvasで画像が表示されている場合は、画像が更新される。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mimeType	string	No	MIMEタイプ。表示する画像のMimeType。
data	file	No	ファイルのbinary。 表示する画像ファイルのbinary。 uriと同時に省略することはできない。 両方指定した場合の挙動は未定義。
uri	string	No	ファイルのURI。 表示する画像ファイルのURI。 dataと同時に省略することはできない。 両方指定した場合の挙動は未定義。
x	integer	No	デバイスが持つ空間の左上を原点としたx座標。 0～デバイスの空間領域。 等倍描画モードの場合のみ有効。
y	integer	No	デバイスが持つ空間の左上を原点としたy座標。 0～デバイスの空間領域。 等倍描画モードの場合のみ有効。
mode	string	No	画像描画モード。 (省略時)：等倍描画モード。座標(x,y)に画像の左上隅がくるように描画する。 scales：スケールモード。アスペクト比を保持して最大限に拡大して画面中央に描画する。 x,y座標は無効。 fills：フィルモード。等倍の画像を並べて画面全体に敷き詰めるように描画する。 x, y座標は無効。

レスポンス

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

DELETE /gotapi/canvas/drawImage

種別

one-shot

概要

デバイスに描画した画像を削除する。

Canvasにより、デバイスに画像が描画されていない場合はエラーを返すこと。

リクエスト

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