「インタラクションAPI」の版間の差分
(→JavaScriptの記述例) |
|||
行1: | 行1: | ||
− | '''インタラクションAPI''' とは[[PIONE]](主に[[PIONE Webclient]])においてインタラクティブ操作による[[コマンド]] | + | '''インタラクションAPI''' とは[[PIONE]](主に[[PIONE Webclient]])においてインタラクティブ操作による[[コマンド]]を実現するためにサーバとの通信を行うための操作です。インタラクティブ操作含む[[コマンド]]を作成する場合はこれらの操作を.htmlや.cgiファイルなどに記述する必要があります。<br> |
== 操作一覧 == | == 操作一覧 == | ||
行21: | 行21: | ||
=== ファイル取得操作 === | === ファイル取得操作 === | ||
− | + | 通知したファイル名(formの場合はactionに当たる)にて指定したCGIを実行します。実行できなかった場合はエラーとなります。また、この操作で取得するファイルは予めパッケージに含まれているファイルに限ります。それ以外のファイルは対象外ですので、ご注意ください。<br> | |
<table border="1"> | <table border="1"> | ||
<tr> | <tr> | ||
行45: | 行45: | ||
=== ファイル作成操作 === | === ファイル作成操作 === | ||
− | + | 通知したファイル名でファイルを作成します。pione-contentに書き込むデータ内容を指定します。<br> | |
<table border="1"> | <table border="1"> | ||
<tr> | <tr> | ||
行69: | 行69: | ||
=== ファイル削除操作 === | === ファイル削除操作 === | ||
− | + | 通知したファイルを削除します。<br> | |
<table border="1"> | <table border="1"> | ||
<tr> | <tr> | ||
行87: | 行87: | ||
=== ファイル一覧操作 === | === ファイル一覧操作 === | ||
− | + | 通知したディレクトリ内のファイル情報一覧を[[JSON]]データで得ます。<br> | |
<table border="1"> | <table border="1"> | ||
<tr> | <tr> |
2014年12月16日 (火) 23:52時点における版
インタラクションAPI とはPIONE(主にPIONE Webclient)においてインタラクティブ操作によるコマンドを実現するためにサーバとの通信を行うための操作です。インタラクティブ操作含むコマンドを作成する場合はこれらの操作を.htmlや.cgiファイルなどに記述する必要があります。
目次
操作一覧
終了通知操作
インタラクティブ操作画面を終了します。メインに処理を返すときに必ず通知する必要があります。
パラメータ名 | 区分 | 値 | 説明 |
---|---|---|---|
pione-action | 必須 | finish | 終了通知 |
ファイル取得操作
通知したファイル名(formの場合はactionに当たる)にて指定したCGIを実行します。実行できなかった場合はエラーとなります。また、この操作で取得するファイルは予めパッケージに含まれているファイルに限ります。それ以外のファイルは対象外ですので、ご注意ください。
パラメータ名 | 区分 | 値 | 説明 |
---|---|---|---|
pione-action | 必須 | get | ファイル取得 |
その他全てのパラメータ | 任意 | 任意の値 | 全てのパラメータが引き渡される |
ファイル作成操作
通知したファイル名でファイルを作成します。pione-contentに書き込むデータ内容を指定します。
パラメータ名 | 区分 | 値 | 説明 |
---|---|---|---|
pione-action | 必須 | create | ファイル作成 |
pione-content | 必須 | ファイル名または文字列 | ファイル名の場合はファイル内のデータを、文字列の場合は文字列を書き込む |
ファイル削除操作
通知したファイルを削除します。
パラメータ名 | 区分 | 値 | 説明 |
---|---|---|---|
pione-action | 必須 | delete | ファイル削除 |
ファイル一覧操作
通知したディレクトリ内のファイル情報一覧をJSONデータで得ます。
パラメータ名 | 区分 | 値 | 説明 |
---|---|---|---|
pione-action | 必須 | list | ファイルリスト |
HTMLl文書による操作の記述方法
.htmlまたは.cgiにてこれらの操作を実行するためには下記のような記述を用います。
a hrefの記述例
a hrefを用いる場合は?pione-action=操作名へリンクするようにします。
<a href="?pione-action=finish">終了</a>
form actionの記述例
form actionタグ内にてpione-actionの値を定義して、ボタン操作によってsubmitすると操作命令を送信することができます。この場合はfileなどの値も合わせて送信できるので、ファイル操作のときにはこちらを用います。
<form action="./AAA.txt" method="post" enctype="multipart/form-data"> <input type="hidden" name="pione-action" value="create"/> <button type="submit">作成(テキスト)</button> <input type="text" name="pione-content" value=""/> </form>
JavaScriptの記述例
特にファイル一覧操作はJavaScriptを利用することに戻り値を使ったページを作成することができます。ファイル一覧操作での戻り値はJSONデータですので、データを使用するためにgetJSONを使用しています。
<script src="http://code.jquery.com/jquery-1.11.1.min.js"></script> <div id="textDiv"></div> <script> var div = document.getElementById("textDiv"); div.textContent = ""; $.getJSON("./", {"pione-action": "list"}, function(data){ $.each(data, function() { div.textContent += this.name +"\n"; }); }); </script>