5.12　JavaScriptプラグインパーツで使用できるAPI

JavaScriptプラグインパーツで使用できるAPI（JavaScript API）を次に示します。

表5‒4　JavaScriptプラグインパーツで使用できるAPI一覧
分類	クラス名	説明
プラグインマネージャ	JavaScriptPluginManager	JavaScriptからナビゲーションプラットフォーム独自の処理を行うためのオブジェクトを提供するクラスです。
REST呼び出し	RestClient	JavaScriptからURLを呼び出すためのクラスです。

APIを使用する場合は，JavaScript内から予約変数ucnpJavaScriptPluginManagerでJavaScriptPluginManagerオブジェクトを取得します。また，REST呼び出しを行う場合は，予約変数ucnpJavaScriptPluginManagerのgetRestClientメソッドでRestClientオブジェクトを取得します。

記述例

var client = ucnpJavaScriptPluginManager.getRestClient();

RestClientオブジェクトのメソッド（executeメソッドを除く）は，呼び出し元のRestClientオブジェクトを返すため，メソッドチェーンで呼び出すことができます。

記述例

var result = client
.addHeader("Accept-Encoding", "deflate")
.setAuthentication("user1", "pass1")
.setMethod(client.METHOD_POST)
.setPostContentType("text/json")
.setPostContent("{ \"operation\": \"start\" }")
.setReturnType(client.RETURNTYPE_JSON)
.execute();

RestClientオブジェクトのメソッドの引数に指定する定数は，RestClientインスタンスから取得できます。

記述例

var client = ucnpJavaScriptPluginManager.getRestClient();
var result = client
.setMethod(client.METHOD_POST)
.setReturnType(client.RETURNTYPE_STRING)
.execute();

注意事項

［ブラウザで実行］チェックボックスをチェックし，次のAPIをWebブラウザ（クライアント側）で実行するJavaで使用する場合，各APIで取得するMapとListの格納形式が，サーバ側で実行するJavaで使用する場合と変わります。

getCurrentParamsTypeMap
getReturnMap

Mapは同等のキーと値を格納した連想配列，Listは値を羅列した配列の形式となります。MapとListを扱うAPIは，次の記述例に示すように，［ブラウザで実行］チェックボックスのチェックの有無に応じて使用方法が異なる点に注意してください。

■記述例1：入力パラメタparam0の型を取得する場合

［ブラウザで実行］チェックボックスがチェックなしのとき

var map = getCurrentParamsTypeMap();
var param0Type = map.get("param0");

［ブラウザで実行］チェックボックスがチェックありのとき

var map = getCurrentParamsTypeMap();
var param0Type = map["param0"];

■記述例2：入力パラメタparam0が入力なしのときにエラーを表示して強調表示する場合

［ブラウザで実行］チェックボックスがチェックなしのとき

var retMap = ucnpJavaScriptPluginManager.getReturnMap();
if (praram0 === "") {
  var errorParts = new java.util.ArrayList();
  errorParts.add("param0");
  retMap.put("ucnp.error.params.list", errorParts);
  retMap.put("ucnp.error.message", "エラー!");
}

［ブラウザで実行］チェックボックスがチェックありのとき

var retMap = ucnpJavaScriptPluginManager.getReturnMap();
if (praram0 === "") {
  var errorParts = [];
  errorParts.push("param0");
  retMap["ucnp.error.params.list"] = errorParts;
  retMap["ucnp.error.message"] = "エラー!";
}

〈この節の構成〉

ページの先頭へ

5.12 JavaScriptプラグインパーツで使用できるAPI

5.12　JavaScriptプラグインパーツで使用できるAPI