Cordova 構成ファイル
Cordova config.xml ファイルは、アプリケーションのグローバル構成ファイルです。
Cordova 構成ファイルは、アプリケーション・メタデータを含む必須の XML ファイルであり、アプリケーションのルート・ディレクトリーに保管されています。このファイルは Cordova アプリケーションを作成すると自動的に生成されます。その後、カスタム・プロパティーを追加して変更することができます。
このファイルに関する一般情報は、 Apache Cordova config.xml documentationに記載されています。
MobileFirst 固有の構成について詳しくは、以下のセクションを参照してください。
config.xml ファイルの構造
MobileFirst 固有の構成のいずれかに関する詳細情報を表示するには、 以下のファイル記述またはその後にあるアルファベット順リストでエレメント名をクリックしてください。
<?xml version='1.0'encoding='utf-8'?>
<widget>
<name>...</name>
<description>...</description>
<author>...</author>
<content/>
<plugin/>
<access/>
<allow-intent/>
<platform>
<allow-intent/>
<icon/>
<splash/>
<update/>
</platform>
<mfp:platformVersion>...</mfp:platformVersion>
<mfp:directUpdateAuthenticityPublicKey>...</mfp:directUpdateAuthenticityPublicKey>
<mfp:languagePreferences>...</mfp:languagePreferences>
<mfp:clientCustomInit/>
<mfp:server/>
<mfp:ios>
<mfp:appChecksum>...</mfp:appChecksum>
<mfp:sdkChecksum>...</mfp:sdkChecksum>
<mfp:security>
<mfp:testWebResourcesChecksum/>
</mfp:security>
</mfp:ios>
<mfp:android>
<mfp:appChecksum>...</mfp:appChecksum>
<mfp:sdkChecksum>...</mfp:sdkChecksum>
<mfp:security>
<mfp:testWebResourcesChecksum/>
</mfp:security>
</mfp:android>
<mfp:windows>
<mfp:appChecksum>...</mfp:appChecksum>
<mfp:windowsphone8>
<mfp:sdkChecksum>...</mfp:sdkChecksum>
<mfp:security>
<mfp:testWebResourcesChecksum/>
</mfp:security>
</mfp:windowsphone8>
<mfp:windows8>
<mfp:sdkChecksum>...</mfp:sdkChecksum>
<mfp:security>
<mfp:testWebResourcesChecksum/>
</mfp:security>
</mfp:windows8>
<mfp:windows10>
<mfp:sdkChecksum>...</mfp:sdkChecksum>
<mfp:security>
<mfp:testWebResourcesChecksum/>
</mfp:security>
</mfp:windows10>
</mfp:windows>
</widget>
config.xml エレメント
- <mfp:android>
- <mfp:appChecksum>
- <mfp:clientCustomInit/>
- <mfp:directUpdateAuthenticityPublicKey>
- <mfp:ios>
- <mfp:languagePreferences>
- <mfp:platformVersion>
- <mfp:sdkChecksum>
- <mfp:security>
- <mfp:server/>
- <mfp:testWebResourcesChecksum/>
- <mfp:windows>
- <mfp:windows8>
- <mfp:windowsphone8>
- <mfp:windows10>
- <widget>
<widget>
- 構文
-
<widget id="my.mfp.cordova.with.push.plugin" version="1.0.5" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0" xmlns:mfp="http://www.ibm.com/mobilefirst/cordova-plugin-mfp"> ... </widget> - 説明
- Apache Cordova config.xml documentation を参照してください。
- MobileFirst 固有の属性
-
- id: これは Cordova プロジェクト作成時に指定されたアプリケーション・パッケージ名です。アプリケーションが MobileFirst Server に登録された後にこの値が手動で変更された場合、アプリケーションの再登録が必要です。
- xmlns:mfp: 必須。デフォルトで設定されます。これは、MobileFirst プラグイン XML 名前空間です。
<mfp:platformVersion>
- 構文
-
<mfp:platformVersion>8.0.0.00.20160205-2039</mfp:platformVersion> - 次に含まれる
- <widget>
- 構成
- デフォルトで設定されます。変更してはなりません。
- 説明
- 必須。アプリケーションが開発された製品バージョン。
<mfp:directUpdateAuthenticityPublicKey>
- 構文
-
<mfp:directUpdateAuthenticityPublicKey>public_key_string</mfp:directUpdateAuthenticityPublicKey> - 次に含まれる
- <widget>
- 構成
- mfpdev app config direct_update_authenticity_public_key
<value> コマンドで設定されます。
mfpdev app config コマンドについて詳しくは、コマンド・ウィンドウで mfpdev help app config と入力してください。
- 説明
- オプション。ダイレクト・アップデート認証性機能を有効にした場合、デプロイメント時にダイレクト・アップデート・パッケージがデジタル署名されます。クライアントがパッケージをダウンロードした後、
パッケージの認証性を検証するためにセキュリティー検査が実行されます。このストリング値は、ダイレクト・アップデート .zip ファイルの認証に使用される公開鍵です。
詳しくは、クライアント・サイドでのセキュア・ダイレクト・アップデートの実装を参照してください。注: このエレメント値は、 ダイレクト・アップデートをサポートする Cordova iOS および Cordova Android プラットフォームでのみサポートされます。
<mfp:languagePreferences>
- 構文
-
<mfp:languagePreferences>en</mfp:languagePreferences> - 次に含まれる
- <widget>
- 構成
- mfpdev app config language_preferences <value> コマンドで設定されます。
mfpdev app config コマンドについて詳しくは、コマンド・ウィンドウで mfpdev help app config と入力してください。
- 説明
- オプション。システム・メッセージの表示に使用されるロケールのコンマ区切りリストを含みます。
<mfp:clientCustomInit>
- 構文
-
<mfp:clientCustomInit enabled="false"/> - 次に含まれる
- <widget>
- 構成
- 手動で編集されます。enabled 属性に設定できる値は true または false です。
- 説明
- WL.Client.init メソッドがどのように呼び出されるのかを制御します。 デフォルトでは、この値は false に設定され、WL.Client.init メソッドは MobileFirst プラグイン が初期化された後に自動的に呼び出されます。WL.Client.init が呼び出されるタイミングをクライアント・コードで明示的に制御するには、この値を true に設定します。
- 属性
-
- enabled: 有効な値は true および false です。
<mfp:server>
- 構文
-
<mfp:server url="http://10.0.0.1:9080" runtime="mfp" /> - 次に含まれる
- <widget>
- 構成
-
- サーバー url 値は mfpdev app config server コマンドで設定されます。
- サーバー runtime 値は mfpdev app config runtime コマンドで設定されます。
mfpdev app config コマンドについて詳しくは、コマンド・ウィンドウで mfpdev help app config と入力してください。
- 説明
- クライアント・アプリケーションが MobileFirst Server との通信に使用する、デフォルトのリモート・サーバー接続情報。
- 属性
-
- url: url 値は、クライアントがサーバーに接続するためにデフォルトで使用する、 MobileFirst Server プロトコル、ホスト、およびポートの値を指定します。
- runtime: runtime 値は、アプリケーションが登録された MobileFirst Server ランタイムを指定します。MobileFirst ランタイムについて詳しくは、 MobileFirst Server 概要を参照してください。
<mfp:ios>
- 構文
-
<mfp:ios> <mfp:appChecksum>...</mfp:appChecksum> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:ios> - 次に含まれる
- <widget>
- 次を含む
- 説明
- このエレメントは、iOS プラットフォーム用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。
<mfp:android>
- 構文
-
<mfp:android <mfp:appChecksum>...</mfp:appChecksum> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:android> - 次に含まれる
- <widget>
- 次を含む
- 説明
- このエレメントは、Android プラットフォーム用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。
<mfp:windows>
- 構文
-
<mfp:windows> <mfp:appChecksum>...</mfp:appChecksum> <mfp:windowsphone8> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windowsphone8> <mfp:windows8> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windows8> <mfp:windows10> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windows10> </mfp:windows> - 次に含まれる
- <widget>
- 次を含む
- 説明
-
このエレメントは、Windows プラットフォーム用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。
<mfp:windows8>
- 構文
-
<mfp:windows8> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windows8> - 次に含まれる
- <mfp:windows>
- 次を含む
- 説明
- このエレメントは、Windows 8.1 プラットフォーム用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。注: Windows Phone 8.1 構成は、<mfp:windowsphone8> エレメントの下に含まれます。
<mfp:windowsphone>
- 構文
-
<mfp:windowsphone8> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windowsphone8> - 次に含まれる
- <mfp:windows>
- 次を含む
- 説明
- このエレメントは、Windows Phone 8.1 プラットフォーム用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。
<mfp:windows10>
- 構文
-
<mfp:windows10> <mfp:sdkChecksum>...</mfp:sdkChecksum> <mfp:security> <mfp:testWebResourcesChecksum/> </mfp:security> </mfp:windows10> - 次に含まれる
- <mfp:windows>
- 次を含む
- 説明
-
このエレメントは、Windows 10 Universal Windows Platform (UWP) 用のすべての MobileFirst 関連のクライアント・アプリケーション構成を含みます。
<mfp:appChecksum>
- 構文
-
<mfp:appChecksum>1234567890</mfp:appChecksum> - 次に含まれる
- <mfp:ios>、<mfp:android>、 および <mfp:windows>
- 構成
- ユーザーによる構成はできません。チェックサム値は mfpdev
app webupdate コマンドが実行されると更新されます。
mfpdev app webupdate コマンドについて詳しくは、コマンド・ウィンドウで mfpdev help app webupdate と入力してください。
- 説明
- この値は、アプリケーション Web リソースのチェックサムです。mfpdev app webupdate が実行されるときに計算されます。
<mfp:sdkChecksum>
- 構文
-
<mfp:sdkChecksum>2101152546</mfp:sdkChecksum> - 次に含まれる
- <mfp:ios>、<mfp:android>、<mfp:windowsphone8>、<mfp:windows8>、 および <mfp:windows10>
- 構成
- ユーザーによる構成はできません。この値はデフォルトで設定されます。
- 説明
- この値は、IBM MobileFirst™ Platform SDK チェックサムであり、 固有の IBM MobileFirst Platform SDK レベルを識別するために使用されます。
<mfp:security>
- 構文
-
<mfp:security> <mfp:testWebResourcesChecksum enabled="false" ignoreFileExtensions="png, jpg, jpeg, gif, mp4, mp3/> </mfp:security> - 次に含まれる
- <mfp:ios>、<mfp:android>、<mfp:windowsphone8>、<mfp:windows8>、 および <mfp:windows10>
- 次を含む
- <mfp:testWebResourcesChecksum/>
- 説明
-
このエレメントには、MobileFirst セキュリティーについての、クライアント・アプリケーションのプラットフォーム固有構成が含まれます。
<mfp:testWebResourcesChecksum>
- 構文
-
<mfp:testWebResourcesChecksum enabled="false" ignoreFileExtensions="png, jpg, jpeg, gif, mp4, mp3"/> - 次に含まれる
- <mfp:security>
- 構成
-
- enabled 属性は mfpdev app config android_security_test_web_resources_checksum <value> コマンドで設定されます。
- ignoreFileExtensions 属性は mfpdev app config android_security_ignore_file_extensions <value> コマンドで設定されます。
mfpdev app config コマンドについて詳しくは、コマンド・ウィンドウで mfpdev help app config と入力してください。
- 説明
- アプリケーションがモバイル・デバイス上で実行を開始するたびにその Web リソースの保全性を検証するかどうかを制御します。
- 属性
-
- enabled: 有効な値は true および false です。 この属性が true に設定されている場合、アプリケーションは Web リソースのチェックサムを計算し、アプリケーションが最初に実行されたときに保存しておいた値とこのチェックサムを比較します。
- ignoreFileExtensions: チェックサム計算には、Web リソースのサイズによって、数秒かかる場合があります。この時間を短縮するには、この計算において無視するファイル拡張子のリストを指定します。この値は、enabled 属性が false の場合は無視されます。