第6章 Cordova

6.1. ダウンロード

6.2. スタート

RHMAP JavaScript SDK により、Cordova アプリで RHMAP API を使用することができます。このアプリは主に HTML、JS、CSS などの Web テクノロジーを使用して開発され、また数多くのデバイス機能へのアクセスを許可します。

基礎となるネイティブプロジェクトおよび Cordova ライブラリーは開発者に公開されます。これにより、Cordova プラグインやサードパーティーライブラリーを含む、アプリケーションの完全なカスタマイズが可能になります。通常、Cordova アプリのネイティブコードの作成または修正に必要な時間は比較的短く、開発チーム内の小規模なグループのみがネイティブコードを扱えるようにするだけで十分です。この小規模なグループは、ネイティブコードを処理したり、Cordova プラグインアーキテクチャーを使用して追加のプラグインまたは SDK を JavaScript API で公開したりできます。

Cordova についての詳細は、公式 Cordova web サイト を参照してください。

6.2.1. 新規アプリ

サンプルアプリをダウンロードし、すでに RHMAP JavaScript SDK が組み込まれている新規の Cordova アプリを使って開始します。

6.2.2. 既存アプリ

SDK をダウンロードし、feedhenry.js として保存します。

feedhenry.js を Cordova アプリの index.html ファイルと同じ場所 (通常は www ディレクトリー内) にコピーします。

以下のコードを index.html ファイルに追加します。 

<head>
  <script src="feedhenry.js" type="text/javascript"></script>
</head>

6.2.3. セットアップ

最後に、アプリが RHMAP サーバーと通信できるようにするプロパティーを定義する必要があります。SDK ファイルと同じディレクトリーに、以下の内容の fhconfig.json という新規ファイルを作成します。括弧内の参照部分はプロジェクトの値に置き換えます。 

{
  "host": "<RHMAP Core host>",
  "projectid": "<Project ID>",
  "connectiontag": "<Connection tag>",
  "appid": "<Client App ID>",
  "appkey": "<Client App API key>"
}

クライアントアプリとクラウドアプリ間の通信についての詳細は、「Projects - Connections」を参照してください。

6.3. 互換性

Cordova アプリ開発用のセットアップを機能させるには、ローカルの Cordova CLI バージョンが RHMAP ビルドファームにインストールされた Cordova のバージョンと一致しており、Cordova プラットフォームのバージョンがサポートされている範囲内のものであることを確認するようお勧めします。このセクションでは、ビルドファームでサポートされている Cordova CLI およびプラットフォームのバージョンを一覧表示します。

Cordova プラットフォームのバージョンをアプリに指定しない場合は、ビルドファームで使用される Cordova CLI のデフォルトの固定バージョンが使用されます。ビルドの再現性および安定性を確保するには、常にプラットフォームのバージョンを Cordova アプリに指定することをお勧めします。

6.3.1. 現行バージョン

Cordova CLI: 5.2.0

プラットフォーム最小のバージョン最大のバージョン

Android

3.1.0

5.0.0

iOS

3.1.0

4.1.0

Windows

3.1.0

3.8.2

6.4. API ドキュメント

  • API Docs: すべてのクライアント API についてのドキュメント