APIリファレンス

Transcription

1 FUJITSU Software Interstage Mobile Application Server V1.0.0 API リファレンス B1WS (00) 2013 年 10 月

2 まえがき 本書の目的本書は Interstage Mobile Application Serverが提供するAPIについて説明します 本書の読者本書はInterstage Mobile Application Serverを利用したアプリケーションの設計 開発を行う方を対象としています 本書を読むにあたっては 以下の知識が必要です 使用するOSに関する基本的な知識 インターネットに関する基本的な知識 スマートデバイスに関する基本的な知識 Interstage Mobile Application Serverの基本的な知識 アプリケーションサーバ管理に関する基本的な知識 アプリケーション開発に関する基本的な知識 HTML5 JavaScript CSS3の知識 本書の構成 本マニュアルは 次の構成になっています 第 1 章 APIリファレンス Interstage Mobile Application Serverが提供するAPIについて説明しています オペレーティングシステム表記 本書では オペレーティングシステムを以下のように略記しています 正式名称 略称 Microsoft(R) Windows Server(R) 2012 Datacenter Windows Server 2012 Windows Microsoft(R) Windows Server(R) 2012 Standard Microsoft(R) Windows Server(R) 2012 Essentials Microsoft(R) Windows Server(R) 2012 Foundation Microsoft(R) Windows Server(R) 2008 R2 Standard Windows Server 2008 R2 Microsoft(R) Windows Server(R) 2008 R2 Enterprise 商標 Access Excel PowerPoint および Word は 米国 Microsoft Corporation の製品です Adobe Acrobat Adobe Reader Acrobat Reader Adobe ロゴ Adobe AIR Flash Flash Player は Adobe Systems Incorporated の米国ならびに他の国における商標または登録商標です Android は Google Inc. の登録商標です Eclipse は 開発ツールプロバイダのオープンコミュニティである Eclipse Foundation, Inc. により構築された開発ツール統合のためのオープンプラットフォームです Internet Explorer Microsoft Internet Explorer ロゴ Microsoft Windows Windows Server またはその他のマイクロソフト製品の名称および製品名は 米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です Interstage は 富士通株式会社の登録商標です - i -

3 Oracle と Java は Oracle Corporation 及びその子会社 関連会社の米国及びその他の国における登録商標です 文中の社名 商品名等は各社の商標または登録商標である場合があります 本書におけるその他名称については 各社の登録商標または商標です なお 本書では システム名または製品名に付記される登録表示 ((TM) または (R)) は 省略しています 輸出管理規制 本ドキュメントを輸出または提供する場合は 外国為替 外国貿易法および米国輸出管理関連法規等の規制をご確認の上 必要な手続きをおとりください お願い このマニュアルは 予告に変更されることがあります このマニュアルを無断で他に転用しないようお願いします このマニュアルに記載されたデータの使用に起因する第三者の特許権およびその他の権利の侵害については 当社はその責を負いません 発行年月日 2013 年 10 月著作権 Copyright 2013 FUJITSU LIMITED - ii -

4 目次 第 1 章 API リファレンス アプリ実行 addeventlistener removeappdata abortapp 使用例 認証 getuserid isonlineflag 使用例 データ暗号化 API(SecureLocalStorage) length key setitem getitem removeitem clear 使用例 通信 enableasynccomm processserverresponse 使用例 AR アプリケーション連携 start 使用例 Cordova API iii -

5 第 1 章 API リファレンス 本章では Interstage Mobile Application Server が提供する API について説明します APIを利用するためには 以下のJavaScriptファイルをhtmlファイルでインクルードしてください imaps-バージョン.js cordova-バージョン.js JavaScriptファイルは以下に格納されています IMAPSアプリの開発資産と同じフォルダへコピーしてください < 製品インストールフォルダ >\MAPS\development 注意 Interstage Mobile Application Server が提供する API は Cordova の deviceready イベントの受信後に呼び出してください deviceready イベントの受信前に呼び出した場合は 正常に動作しません deviceready イベントの受信は 以下のように addeventlistener でリスナーを追加します document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { // リスナーの処理 注意 backbutton イベントは index.html には通知されません index.html でバックキーまたはバックアイコンが押された場合は IMAPS エージェントの [ ホーム ] 画面へ遷移します Storage API で保存したデータは IMAPS クライアントアプリケーション間で共有されます 1.1 アプリ実行 addeventlistener IMAPSクライアントアプリケーションのイベントリスナーを登録します 呼出し形式 imaps.app.addeventlistener(event, callback) event callback 受信するイベントを指定します 説明 イベント発生時に呼び出すコールバック関数を指定します 指定可能なイベント コールバックで行う処理例は 以下の通りです - 1 -

6 イベントコールバック処理説明 background foreground 処理を停止してください 終了に備えて 揮発性データの永続化を行ってください 必要に応じて 永続したデータの復元等を行ってください 利用者の操作により 実行中 ( フォアグラウンド ) の IMAPS クライアントアプリケーションが実行中 ( バックグラウンド ) になるイベントです IMAPS クライアントアプリケーションが停止する前にも発生します ( 強制終了の前には発生しません ) 利用者の操作により 実行中 ( バックグラウンド ) の IMAPS クライアントアプリケーションが実行中 ( フォアグラウンド ) になるイベントです ポイント イベントに上記以外を指定した場合 コールバックに null を指定した場合は イベント通知を行いません 注意 IMAPS クライアントアプリケーションの終了操作を行った際に コールバック処理が IMAPS アプリ終了処理のタイムアウト時間 ( デフォルト : 30 秒 ) 以上かかった場合 IMAPS エージェントはメッセージを表示して終了します IMAPS クライアントアプリケーションをフォアグラウンドに切り替えた直後に終了操作を行った場合 foreground と background のコールバック処理が実行されます 従って IMAPS アプリ終了処理のタイムアウト時間には foreground と background のコールバック処理にかかる時間よりも大きな値を設定してください IMAPS アプリ終了処理のタイムアウト時間の設定方法については エージェント操作ガイド の 付録 B IMAPS 初期設定のカスタマイズ方法 を参照してください removeappdata IMAPSクライアントアプリケーションに関連するすべてのデータを削除します なお Storage APIで保存したデータは IMAPSクライアントアプリケーション間で共有されるため削除されません 呼出し形式 imaps.app.removeappdata(, ) 説明 すべての削除が成功した場合に呼び出すコールバック関数を指定します 削除が失敗した場合に呼び出すコールバック関数を指定します - 2 -

7 1.1.3 abortapp IMAPSクライアントアプリケーションを強制終了します 呼出し形式 imaps.app.abortapp() 使用例 addeventlistener の使用例を以下に示します <!DOCTYPE HTML> <html lang="ja"> <head> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { imaps.app.addeventlistener("background", onbackground); imaps.app.addeventlistener("foreground", onforeground); function onbackground() { console.log("background event"); function onforeground() { console.log("foreground event"); </head> <body> </body> </html> removeappdata の使用例を以下に示します <!DOCTYPE HTML> <html lang="ja"> <head> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { function removeappdata() { imaps.app.removeappdata(, ); ; function () { alert("removeappdata success"); function () { - 3 -

8 alert("removeappdata fail"); </head> <body> <button onclick="removeappdata()">removeappdata</button> </body> </html> abortapp の使用例を以下に示します <!DOCTYPE HTML> <html lang="ja"> <head> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { function abortapp() { imaps.app.abortapp(); ; </head> <body> <button onclick="abortapp()">abortapp</button> </body> </html> 1.2 認証 getuserid ログイン中のユーザー IDを取得します 呼出し形式 imaps.auth.getuserid(, ) 説明ユーザー ID 取得が成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型でユーザー IDが返却されます ユーザー ID 取得が失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます - 4 -

9 1.2.2 isonlineflag オンライン認証 またはオフライン認証のどちらでログインしているかを取得します 呼出し形式 imaps.auth.isonlineflag(, ) 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型で認証方法が返却されます 返却される値の意味は以下の通りです true : オンライン認証 false: オフライン認証失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます 使用例 getuserid の使用例を以下に示します <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script> function onbodyload() { document.addeventlistener("deviceready", getuserid); function getuserid() { imaps.auth.getuserid(resulthandler, errorhandler); function resulthandler (result) { alert("result: \r\n"+result ); function errorhandler (error) { alert("error: \r\n"+error ); </head> <body onload="onbodyload();"> </body> </html> isonlineflag の使用例を以下に示します <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> - 5 -

10 <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script> function onbodyload() { document.addeventlistener("deviceready", isonlineflag); function isonlineflag() { imaps.auth.isonlineflag(resulthandler, errorhandler); function resulthandler (result) { alert("result: \r\n"+result ); function errorhandler (error) { alert("error: \r\n"+error ); </head> <body onload="onbodyload();"> </body> </html> 1.3 データ暗号化 API(SecureLocalStorage) length 保存されているデータの数を返します 呼出し形式 imaps.sls.length(, ) 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型でデータの数が返却されます 失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます key 保存されている index 番目の key を返します 注意 key 追加 削除後の順序は保障されません - 6 -

11 呼出し形式 imaps.sls.key(,, index) 説明 成功した場合に呼び出すコールバック関数を指定します 第 1 に String 型で index 番目の key が返却されます index が null または不正な値の場合は 0 番目の key を返却します index 番目に key が存在しない場合は null を返却します index 失敗した場合に呼び出すコールバック関数を指定します 第 1 に String 型で例外メッセージが返却されます 取得すべき key の index 値 setitem keyとvalueのペアでデータを保存します key/valueには空文字を使用することができます nullは文字列 "null" として扱います すでに同じkeyが保存されている場合はvalueが更新されます 呼出し形式 imaps.sls.setitem(,, key, value) key value 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型で "OK" が返却されます 失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます 保存するkey 保存するvalue getitem key に対する value を取得します - 7 -

12 呼出し形式 imaps.sls.getitem(,, key) key 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型でkeyに対するvalueが返却されます 該当するvalueが存在しない場合はnullが返却されます 失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます 取得するvalueのkey removeitem keyに対するvalueを削除します 呼出し形式 imaps.sls.removeitem(,, key) key 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型で "OK" が返却されます 該当するvalueが存在しない場合も "OK" が返却されます 失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます 削除するvalueのkey clear データをすべてクリアします 呼出し形式 imaps.sls.clear(, ) - 8 -

13 説明成功した場合に呼び出すコールバック関数を指定します 第 1 にString 型で "OK" が返却されます 失敗した場合に呼び出すコールバック関数を指定します 第 1 にString 型で例外メッセージが返却されます 使用例 使用例として ボタンを押下すると API の実行結果をアラート表示する HTML サンプルを示します <html> <head> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { // length() function length() { imaps.sls.length(resulthandler, errorhandler); // key(index) function key(index) { imaps.sls.key(resulthandler, errorhandler, index); // setitem(key, value) function setitem(key, value) { imaps.sls.setitem(resulthandler, errorhandler, key, value); // getitem(key) function getitem(key) { imaps.sls.getitem(resulthandler, errorhandler, key); // removeitem(key) function removeitem(key) { imaps.sls.removeitem(resulthandler, errorhandler, key); // clearitem() function clearitem() { imaps.sls.clear(resulthandler, errorhandler); // 正常時の CallBack function resulthandler(result) { // length(), key(index), getitem(key) 含め 結果は result に設定される. alert("success: \r\n"+result); // 異常時の CallBack. function errorhandler(error) { alert("error: \r\n"+error); </head> <body> - 9 -

14 <button onclick="length();">click to length</button><br> <button onclick="key(0);">click to key</button><br> <button onclick="setitem('key', 'value');">click to setitem</button><br> <button onclick="getitem('key');">click to getitem</button><br> <button onclick="removeitem('key');">click to removeitem</button><br> <button onclick="clearitem();">click to clear</button><br> </body> </html> 1.4 通信 enableasynccomm URLがInterstage SSOの保護パスとして登録されているサーバアプリケーションとのAjax 通信を有効化します 呼び出し形式 imaps.comm.enableasynccomm(url) url 説明 サーバアプリケーションが同梱している imaps-async-comm html の URL を指定します processserverresponse URLがInterstage SSOの保護パスとして登録されているサーバアプリケーションとAjax 通信した結果を処理します 呼び出し形式 imaps.comm.processserverresponse(onproceed,responsetext) onproceed responsetext 説明有効なレスポンスデータが戻ってきた場合に処理を継続するためのコールバック関数を指定します 第 1 にString 型でレスポンスデータが返却されます Ajax 通信のレスポンスデータを指定します

15 1.4.3 使用例 <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> imaps.comm.enableasynccomm(" </head> <body> <script type="text/javascript"> // Ajax 通信するデータを設定してサーバと通信する関数です function dataup(){ var xmlhttprequest = new XMLHttpRequest(); xmlhttprequest.open( 'POST', servername); xmlhttprequest.setrequestheader( 'Content-Type', 'application/x-www-form-urlencoded' ); var params = []; var updatawork = encodeuricomponent( updata0 ).replace( /%20/g, '+' ); var upsyomeiwork = encodeuricomponent( upsyomei0 ).replace( /%20/g, '+' ); params.push( 'data=' + updatawork ); params.push( 'syomei=' + upsyomeiwork ); var paramsdata = params.join( '&' ); xmlhttprequest.send(paramsdata); xmlhttprequest.onreadystatechange = function(){ var READYSTATE_COMPLETED = 4; var HTTP_STATUS_OK = 200; if( this.readystate == READYSTATE_COMPLETED && this.status == HTTP_STATUS_OK ) { // レスポンスデータを処理します imaps.comm.processserverresponse(onproceed,this.responsetext); // 実際にレスポンスデータを処理する関数です function onproceed(responsetext) { alert("responsetext:"+responsetext); </body> </html> 1.5 AR アプリケーション連携 start ARアプリケーションのActivityを起動します 呼出し形式 imaps.ar.start(,, packagename, activityclass, url)

16 packagename activityclass 説明 成功した場合に呼び出すコールバック関数を指定します 失敗した場合に呼び出すコールバック関数を指定します 第 1 にエラー情報を保持したエラーオブジェクトが返却されます エラーオブジェクト.code でエラーコードを参照できます エラーオブジェクト.message でエラーメッセージを参照できます 詳細は エラー時に返却される情報 を参照してください AR アプリケーションのパッケージ名を指定します 起動する Activity を指定します AR 重畳表示アプリケーション Activity の場合 : "com.fujitsu.interstage.ar.mobileclient.android.base.web.arwebmainactivity" または AR_WEB_MAIN クライアントオーサリング Activity の場合 : "com.fujitsu.interstage.ar.mobileclient.android.authoring.ui.liveauthoringactivity" ま た は AR_LIVE_AUTH 設定画面 Activity の場合 : "com.fujitsu.interstage.ar.mobileclient.android.base.pref.arpreferenceactivity" ま た は AR_PREFERENCE url AR 重畳表示アプリケーション Activity を起動する場合 起動する URL 文字列を指定します その他の Activity の場合は無視されます エラー時に返却される情報 以下にエラーコードとメッセージの意味および対処を説明します コードメッセージ意味対処 100 以下のどれかが返却されます INVALID_PACKAGE_NAM E INVALID_INTENT_OPTIO N INVALID_ACTIVITY_CLA SS INVALID_WEBMAIN_URL 以下の意味です 不当なパッケージ名です 不当なインテントオプションです 不当なActivityです 不当なURLです 正しい値を指定してください 101 PACKAGE_NOT_EXIST [%1] パッケージ名が指定されましたが Androidデバ イス上にそのようなパッケージはインストールさ れていません パッケージがデバイス上に存在するか確認してください %1: パッケージ名 102 ENV_NOT_INITIALIZED Cordova 環境が適切に初期化されていません 技術員に連絡してください 105 ACTIVITY_NOT_FOUND [%1] 実行する Activity がありません %1: Activity 106 ENV_ERROR [%1] CordovaまたはAndroid 上で内部的な例外が発 生しました %1: 例外メッセージ 正しい Activity を指定してください 技術員に連絡してください

17 1.5.2 使用例 start の使用例を以下に示します <!DOCTYPE HTML> <html lang="ja"> <head> <script type="text/javascript" src="cordova js"> <script type="text/javascript" src="imaps js"> <script type="text/javascript"> document.addeventlistener("deviceready", ondeviceready, false); function ondeviceready() { function launch_ar(activity) { imaps.ar.start(,, "com.sample.clientdev", activity, " function () { console.log("ar appli start success"); function () { console.log("ar appli start failure"); </head> <body> <button onclick="launch_ar(ar_web_main)">arwebmainactivity</button><br/> <button onclick="launch_ar(ar_live_auth)">liveauthoringactivity</button><br/> <button onclick="launch_ar(ar_preference)">arpreferenceactivity</button><br/> </body> </html> 1.6 Cordova API Cordova API については マニュアル DVD の Apache Cordova Documentation API Reference を参照してください マニュアル DVD: /html/cordovaapireference/index.html