Config.xml API
config.xml
ファイルは、Cordovaアプリケーションの動作のさまざまな側面を管理するグローバルな設定ファイルです。 XML形式で記述されており、W3CのPackaged Web Apps (Widgets)仕様で定義された構造に従っています。さらに、コアCordova API機能、プラグイン、およびプラットフォーム固有の設定を含めるように拡張されています。
Cordova CLIを使用してプロジェクトを作成する場合(コマンドラインインターフェースで説明されているとおり)、config.xml
ファイルはプロジェクトの最上位ディレクトリにあります。
./hellocordova
└── config.xml
CLIを使用してプロジェクトをビルドする場合、このファイルのバージョンはさまざまなplatforms/
サブディレクトリにパッシブにコピーされます。例:
./hellocordova
└── platforms
├── android
│ └── app
│ └── src
│ └── main
│ └── res
│ └── xml
│ └── config.xml
└── ios
└── HelloCordova
└── config.xml
一部のプラットフォームでは、iOSのXcodeやAndroidのAndroid Studioなどの統合開発環境(IDE)を提供しており、これを使用してアプリケーションのビルドとテストを行うことができます。これらのIDEを使用してプロジェクトのビルドとテストを行う場合は、Cordovaアプリケーションのconfig.xml
に変更を加えるたびに、cordova prepare
CLIコマンドを実行することをお勧めします。これにより、更新された設定がそれぞれのplatforms/
サブディレクトリにコピーされます。
以下に説明する設定オプションに加えて、各ターゲットプラットフォームでアプリケーションのコア画像セットをカスタマイズできます。アイコンのカスタマイズに関するトピックを参照してください。
config.xml
のサンプル
<?xml version="1.0" encoding="UTF-8"?>
<widget xmlns="http://www.w3.org/ns/widgets"
xmlns:cdv="https://cordova.dokyumento.jp/ns/1.0"
id="io.cordova.hellocordova"
version="1.0.0">
<name>HelloCordova</name>
<description>Sample Apache Cordova App</description>
<author email="dev@cordova.apache.org" href="https://cordova.dokyumento.jp">
Apache Cordova Team
</author>
<content src="index.html" />
<!-- Security Related Settings -->
<access origin="https://cordova.dokyumento.jp" />
<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
<!-- Platform Configs & Platform Overriding Configs -->
<platform name="android"></platform>
<platform name="ios"></platform>
</widget>
widget
config.xmlドキュメントのルート要素。
属性 | 説明 |
---|---|
id 文字列 |
必須 アプリの識別子を指定します。 id はリバースDNS形式にする必要がありますが、英数字とドット文字のみが許可されます。例:com.example.myapp |
version 文字列 |
必須 メジャー/マイナー/パッチ表記で表された完全なバージョン番号。 |
android-versionCode 文字列 |
Androidの代替バージョン。アプリケーションのバージョンコードを設定します。Androidガイドで、この属性の変更方法に関する情報を確認してください。 |
ios-CFBundleVersion 文字列 |
iOSの代替バージョン。詳細については、Apple Developer - CFBundleVersionを参照してください。 |
android-packageName 文字列 |
このプリファレンスは、Android専用の代替パッケージ名でid属性をオーバーライドします。 |
ios-CFBundleIdentifier 文字列 |
このプリファレンスは、iOS専用の代替バンドルIDでid属性をオーバーライドします。 |
defaultlocale 文字列 |
IANA言語コードを使用してアプリのデフォルト言語を指定します。このプリファレンスキーは、CFBundleDevelopmentRegionの値を明示的に設定します。たとえば、en やen_US などの値を使用できます。 |
android-activityName 文字列 |
AndroidManifest.xmlでアプリのアクティビティ名を設定します。これは、Androidプラットフォームが最初に追加された後、一度だけ設定されることに注意してください。 |
xmlns 文字列 |
必須 config.xmlドキュメントの名前空間。 |
xmlns:cdv 文字列 |
必須 名前空間プレフィックス。 |
例
<!-- Android -->
<widget id="io.cordova.hellocordova" version="0.0.1" android-versionCode="13" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="https://cordova.dokyumento.jp/ns/1.0">
</widget>
<!-- iOS -->
<widget id="io.cordova.hellocordova" version="0.0.1" ios-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="https://cordova.dokyumento.jp/ns/1.0">
</widget>
name
デバイスのホーム画面やアプリストアインターフェースに表示されるアプリの正式名を指定します。
例
<widget ...>
<name>HelloCordova</name>
</widget>
short name
アプリのオプションの表示名を指定します。スペースが限られているため、アプリ名は、デバイスのホーム画面と情報やアプリストアのインターフェースで異なる表示名になる場合があります。
例
<widget ...>
<name short="HiCdv">HelloCordova</name>
</widget>
description
アプリストアリストに表示される可能性のあるメタデータを指定します。
例
<widget ...>
<description>A sample Apache Cordova application</description>
</widget>
author
アプリストアリストに表示される可能性のある連絡先情報を指定します。
属性 | 説明 |
---|---|
email 文字列 |
必須 作成者のメールアドレス。 |
href 文字列 |
必須 作成者のウェブサイト。 |
例
<widget ...>
<author email="dev@cordova.apache.org" href="https://cordova.io"></author>
</widget>
content
最上位のWebアセットディレクトリ内のアプリの開始ページを定義します。デフォルト値はindex.htmlで、通常はプロジェクトの最上位www
ディレクトリに表示されます。
属性 | 説明 |
---|---|
src 文字列 |
必須 最上位のWebアセットディレクトリ内のアプリの開始ページを定義します。デフォルト値はindex.htmlで、通常はプロジェクトの最上位 www ディレクトリに表示されます。 |
例
<widget ...>
<content src="startPage.html"></content>
</widget>
access
アプリが通信を許可される外部ドメインを定義します。アクセス元が「*」に設定されている場合、アプリはどのサーバーにもアクセスできますが、セキュリティリスクが発生する可能性があります。安全な設定を確保するために、許可されるURLを明示的に指定することをお勧めします。詳細な手順については、許可リストガイドを参照してください。
属性 | 説明 |
---|---|
origin 文字列 |
必須 アプリが通信を許可される外部ドメインURLまたはURLパターンを定義します。 |
例
<widget ...>
<access origin="*"></access>
</widget>
<widget ...>
<access origin="http://google.com"></access>
</widget>
allow-navigation
WebViewでどのURLに移動できるかを制御します。最上位のナビゲーションのみに適用されます。許可リストガイドで詳細を確認してください。
属性 | 説明 |
---|---|
href 文字列 |
必須 WebViewが移動を許可される外部ドメインまたはドメインパターンを定義します。 |
例
<!-- Allow links to example.com -->
<allow-navigation href="http://example.com/*" />
<!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
<allow-navigation href="*://*.example.com/*" />
allow-intent
アプリがシステムに開くよう要求することを許可されるURLを制御します。デフォルトでは、外部URLは許可されていません。許可リストガイドで詳細を確認してください。
属性 | 説明 |
---|---|
href 文字列 |
必須 アプリがシステムに開くよう要求することを許可されるURLまたはURLパターンを定義します。 |
例
<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
<allow-intent href="tel:*" />
<allow-intent href="sms:*" />
edit-config
<config-file>ドキュメントを参照してください(plugin.xml)。
config-file
<config-file>ドキュメントを参照してください(plugin.xml)。
engine
prepare中に復元するプラットフォームに関する詳細を指定します。
属性 | 説明 |
---|---|
name 文字列 |
必須 復元するプラットフォームの名前 |
spec 文字列 |
必須 復元するプラットフォームに関する詳細。これは、`major.minor.patch`バージョン番号、プラットフォームを含むディレクトリ、またはGitリポジトリを指すURLの可能性があります。この情報は、NPM、ローカルディレクトリ、またはGitリポジトリから復元するプラットフォームコードを取得するために使用されます。プラットフォーム仕様で詳細を確認してください。 |
例
<engine name="android" spec="https://github.com/apache/cordova-android.git#5.1.1" />
<engine name="ios" spec="^4.0.0" />
plugin
prepare中に復元するプラグインに関する詳細を指定します。この要素は、`--save`フラグを使用してプラグインを追加すると、プロジェクトの`config.xml`に自動的に追加されます。プラグインの追加の詳細については、CLIリファレンスを参照してください。
注:Cordova 9.x以降、このタグは廃止されました。詳細はこちら
属性 | 説明 |
---|---|
name 文字列 |
必須 復元するプラグインの名前 |
spec 文字列 |
必須 復元するプラグインに関する詳細。これは、`major.minor.patch`バージョン番号、プラグインを含むディレクトリ、またはGitリポジトリを指すURLの可能性があります。この情報は、NPM、ローカルディレクトリ、またはGitリポジトリから復元するプラグインコードを取得するために使用されます。プラグイン仕様で詳細を確認してください。 |
例
<plugin name="cordova-plugin-device" spec="^1.1.0" />
<plugin name="cordova-plugin-device" spec="https://github.com/apache/cordova-plugin-device.git#1.0.0" />
variable
prepare中にプラグインを復元する際に使用するCLI変数の値を保持します。この要素は、CLI変数を使用するプラグインを`--save`フラグを使用して追加すると、`config.xml`に追加されます。プラグインの追加の詳細については、CLIリファレンスを参照してください。
この値は、prepare中にプラグインがプロジェクトに復元されるときにのみ使用されることに注意してください。変更しても、現在のプロジェクトでプラグインによって使用される値は変更されません。この値の変更を有効にするには、プロジェクトからプラグインを削除し、`cordova prepare`を実行して復元します。plugin.xmlのpreference要素で、CLI変数の詳細を確認してください。
属性 | 説明 |
---|---|
name 文字列 |
必須 CLI変数の名前。大文字、数字、アンダースコアのみを含めることができます。 |
value 文字列 |
必須 prepare中に親プラグインを復元する際に使用するCLI変数の値。 |
例
<plugin name="cordova-plugin-device" spec="^1.1.0">
<variable name="MY_VARIABLE" value="my_variable_value" />
</plugin>
preference
名前/値属性のペアとしてさまざまなオプションを設定します。各プリファレンスの名前は大文字と小文字が区別されません。多くのプリファレンスは特定のプラットフォームに固有のものであり、そのようなものとして示されます。
属性 | 説明 |
---|---|
AllowInlineMediaPlayback ブール値 |
デフォルト:false HTML5メディアの再生を画面レイアウト内でインラインで表示できるようにするには、trueに設定します。ネイティブコントロールではなく、ブラウザ提供のコントロールを使用します。これを実行するには、すべての <video> 要素にplaysinline 属性を追加します。 注:iOS 10より前は、<video> 要素は代わりにwebkit-playsinline 属性名を使用する必要があります。 |
AllowNewWindows ブール値 |
デフォルト:false JavaScriptの window.open とHTMLのtarget="_blank" リンクで、WebView上に新しいビューをオーバーレイとして開くことを許可するには、trueに設定します。 |
AndroidLaunchMode 文字列 |
デフォルト:singleTop 許可される値:standard、singleTop、singleTask、singleInstance Activityのandroid:launchMode属性を設定します。これにより、アプリアイコンまたはインテントからアプリが起動され、既に実行されている場合の動作が変わります。 |
AndroidInsecureFileModeEnabled ブール値 |
デフォルト:false true に設定すると、file:/// URLの読み込みが許可されます。 **注**:この設定を有効にすると、`file:///`コンテキストで読み込まれた悪意のあるスクリプトが、WebView Cookie、アプリの個人データ、または任意のWebサイトで使用される資格情報を含む任意のローカルファイルにアクセスするクロスサイトスクリプティング攻撃を実行できるようになります。 |
android-maxSdkVersion 数値 |
デフォルト:未指定 プロジェクトの AndroidManifest.xml 内の<uses-sdk> タグのmaxSdkVersion 属性を設定します(こちらを参照)。 |
android-minSdkVersion 数値 |
デフォルト:cordova-androidバージョンに依存 プロジェクトの AndroidManifest.xml 内の<uses-sdk> タグのminSdkVersion 属性を設定します(こちらを参照)。 |
android-targetSdkVersion 数値 |
デフォルト:cordova-androidバージョンに依存 プロジェクトの AndroidManifest.xml 内の<uses-sdk> タグのtargetSdkVersion 属性を設定します(こちらを参照)。 |
android-compileSdkVersion 数値 |
デフォルト:cordova-androidバージョンに依存 compileSdkVersion 属性を設定します。 |
android-buildToolsVersion Semver |
デフォルト:cordova-androidバージョンに依存 完全なバージョン文字列(例:「32.0.0」)を想定しています。これの変更には、適切なビルドツールを見つけるためにPATH環境変数の変更も必要になる場合があります。 このプリファレンスは主にCordova開発用であり、Android SDKの今後のバージョンのテスト用です。これは、新しいビルドツールによって頻繁に破壊的な変更が導入されるため、変更するとビルドが壊れる可能性が高くなります。 |
GradleVersion 文字列 |
デフォルト:cordova-androidバージョンに依存 使用するGradleラッパーのバージョンを設定します。 このプリファレンスは主にCordova開発用であり、Android SDKの今後のバージョンのテスト用です。これは、新しいビルドツールによって頻繁に破壊的な変更が導入されるため、変更するとビルドが壊れる可能性が高くなります。 |
AndroidGradlePluginVersion Semver |
デフォルト:cordova-androidバージョンに依存 使用するAndroid Gradle Pluginのバージョンを設定します。 このプリファレンスは主にCordova開発用であり、Android SDKの今後のバージョンのテスト用です。これは、新しいビルドツールによって頻繁に破壊的な変更が導入されるため、変更するとビルドが壊れる可能性が高くなります。 |
AndroidXAppCompatVersion Semver |
デフォルト:cordova-androidバージョンに依存 Android App Compatライブラリのバージョンをオーバーライドします。 |
AndroidXWebKitVersion Semver |
デフォルト:cordova-androidバージョンに依存 Android WebKitライブラリのバージョンをオーバーライドします。 |
AndroidGradlePluginGoogleServicesVersion Semver |
デフォルト:cordova-androidバージョンに依存 Google Servicesライブラリのバージョンをオーバーライドします。 |
AndroidGradlePluginGoogleServicesEnabled ブール値 |
デフォルト:false Google Servicesを有効にします。 google-services.json ファイルが必要です。 |
GradlePluginKotlinEnabled ブール値 |
デフォルト:false KotlinサポートのためにKotlinプラグインを有効にします。 |
AppendUserAgent 文字列 |
設定されている場合、この値はwebviewの既存のUserAgentの末尾に追加されます。OverrideUserAgentと同時に使用する場合、この値は無視されます。 |
BackgroundColor 文字列 |
アプリの背景色を設定します。4バイトの16進値をサポートします。最初のバイトはアルファチャネルを表し、残りの3バイトは標準的なRGB値を表します。 注記: transparent 値は、Windowsでアプリケーションタイルの背景をアクセントカラーに設定します。 |
CordovaWebViewEngine 文字列 |
デフォルト: CDVWebViewEngine ホストアプリのレンダリングに使用するWebViewエンジンプラグインを設定します。このプラグインはCDVWebViewEngineProtocolプロトコルに準拠している必要があります。ここの'value'は、インストールされているWebViewエンジンプラグインの'feature'名と一致する必要があります。この設定は通常、インストールされているWebViewエンジンプラグインによって自動的に設定されます。 |
DefaultVolumeStream 文字列 |
デフォルト: default cordova-android 3.7.0で追加されました。この設定は、ハードウェアの音量ボタンがリンクする音量を設定します。デフォルトでは、電話では"call"、タブレットでは"media"です。アプリの音量ボタンで常にメディアの音量を変更するには、これを"media"に設定します。Cordovaのメディアプラグインを使用している場合、Mediaオブジェクトがアクティブになっていると、音量ボタンは動的にメディア音量の制御に変わります。 |
DisallowOverscroll ブール値 |
デフォルト:false ユーザーがコンテンツの先頭または末尾を超えてスクロールしたときに、インターフェースにフィードバックを表示させたくない場合は、trueに設定します。iOSでは、オーバースクロールジェスチャーによってコンテンツが元の位置に戻ります。Androidでは、コンテンツの上下端に微妙なグロー効果が表示されます。 |
EnableViewportScale ブール値 |
デフォルト:false trueに設定すると、ビューポートメタタグによってユーザーのスケーリングの範囲を無効化または制限できます(デフォルトでは有効)。スケーリングを無効にしてコンテンツをレンダリングされたWebView内に柔軟に収めるには、HTMLに次の様なビューポートを配置します。 <meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' /> |
ErrorUrl URL |
デフォルト: null この設定がされている場合、アプリケーションはエラー発生時に指定されたローカルページを表示します。さらに、この設定がされている場合、Androidシステムは「アプリケーションエラー」というタイトルのデフォルトダイアログを抑制します。 |
FullScreen ブール値 |
デフォルト:false 画面上部のステータスバーを非表示にすることができます。 注記: これを達成するためのプラットフォームに依存しない推奨方法は、StatusBarプラグインを使用することです。 |
GapBetweenPages 浮動小数点数 |
デフォルト: 0 ページ間のギャップのサイズ(ポイント単位)。 |
GradlePluginGoogleServicesEnabled ブール値 |
デフォルト:false Google Services Gradleプラグインを有効にするには、trueに設定します。 |
GradlePluginGoogleServicesEnabled Semver |
デフォルト: 4.2.0 使用するGoogle Services Gradleプラグインのバージョンを設定します。 |
GradlePluginKotlinEnabled ブール値 |
デフォルト:false Kotlinファイルのビルドを許可するには、trueに設定します。 |
GradlePluginKotlinCodeStyle 文字列 |
デフォルト: official 許容値: official, obsolete Kotlinコードの整形方法(可読性のため)を設定します。 |
GradlePluginKotlinVersion Semver |
デフォルト: 1.3.50 使用するKotlin Gradleプラグインのバージョンを設定します。 |
InAppBrowserStorageEnabled ブール値 |
デフォルト: true InAppBrowser内で開かれたページが、デフォルトブラウザで開かれたページと同じlocalStorageとWebSQLストレージにアクセスできるかどうかを制御します。 |
InspectableWebview ブール値 |
デフォルト: デバッグ/リリースビルドによって異なります iOS 16.4以降で、webviewインスペクターを有効または無効にします。デバッグビルドでは true 、リリースビルドではfalse がデフォルトです。この設定はiOS 16.3以前では無視されます。インスペクターはデバッグビルドでは常に有効で、リリースビルドでは常に無効です。 |
KeepRunning ブール値 |
デフォルト: true pauseイベントが発生した後も、アプリケーションがバックグラウンドで実行され続けるかどうかを決定します。これをfalseに設定しても、pauseイベント後にアプリが強制終了されることはありませんが、アプリがバックグラウンドにある間はcordova webview内のコードの実行が停止されます。 |
KeyboardDisplayRequiresUserAction ブール値 |
デフォルト: true フォーム入力でfocus()を呼び出したときにキーボードが表示されるようにするには、falseに設定します。 |
LoadUrlTimeoutValue 数値 |
デフォルト: 20000 (20秒) ページの読み込み時に、タイムアウトエラーをスローする前に待つ時間(ミリ秒単位)。 |
LoadingDialog 文字列 |
デフォルト: null 設定されている場合、アプリケーションの最初のページを読み込む際に、指定されたタイトルとメッセージ、およびスピナーを含むダイアログが表示されます。タイトルとメッセージは、この値文字列内でコンマで区切られ、ダイアログが表示される前にコンマが削除されます。 |
LogLevel 文字列 |
デフォルト: DEBUG 許容値: ERROR, WARN, INFO, DEBUG, VERBOSE アプリケーションからのログメッセージをフィルタリングする最小ログレベルを設定します。 |
MediaPlaybackAllowsAirPlay ブール値 |
デフォルト: true このビューでAirPlayの使用を禁止するには、falseに設定します。デフォルトのUIWebViewとWKWebViewで使用できます。 |
MediaPlaybackRequiresUserAction ブール値 |
デフォルト:false autoplay属性またはJavaScriptを使用してHTML5ビデオまたはオーディオが自動的に再生されないようにするには、trueに設定します。 |
Orientation 文字列 |
デフォルト: default 許容値: default, landscape, portrait 向きをロックし、向きの変更に応じてインターフェースが回転するのを防ぐことができます。 注記: デフォルト値は、Cordovaがプラットフォームのマニフェスト/設定ファイルから方向設定エントリを削除し、プラットフォームがデフォルトの動作にフォールバックすることを意味します。iOSでは、縦向きと横向きの両方を指定するには、プラットフォーム固有の値「all」を使用します。 |
OverrideUserAgent 文字列 |
設定されている場合、この値はwebviewの既存のUserAgentを置き換えます。リモートページを要求する際にアプリ/ブラウザからの要求を識別するのに役立ちます。注意して使用してください。これはWebサーバーとの互換性の問題を引き起こす可能性があります。ほとんどの場合、AppendUserAgentの代わりに使用してください。 |
PageLength 浮動小数点数 |
デフォルト: 0 ページの流れの方向における各ページのサイズ(ポイント単位)。PaginationModeが左から右または右から左の場合、このプロパティは各ページの幅を表します。PaginationModeが上から下または下から上の場合、このプロパティは各ページの高さを表します。デフォルト値は0で、レイアウトはビューポートのサイズを使用してページの寸法を決定します。 |
PaginationBreakingMode 文字列 |
デフォルト: page 許容値: page, column 有効な値はpageとcolumnです。列またはページの改ページが発生する方法。このプロパティは、列とページの改ページに関する特定のCSSプロパティが尊重されるか無視されるかを決定します。このプロパティがcolumnに設定されている場合、コンテンツはページの改ページの代わりに列の改ページに関連するCSSプロパティを尊重します。 |
PaginationMode 文字列 |
デフォルト: unpaginated 許容値: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft このプロパティは、webview内のコンテンツが一度に1画面を埋めるページに分割されるか、1つの長いスクロールビューとして表示されるかを決定します。ページング形式に設定されている場合、このプロパティはコンテンツのページングレイアウトを切り替え、webviewがPageLengthとGapBetweenPagesの値を使用してコンテンツを再レイアウトするようにします。 |
PreferredContentMode 文字列 |
デフォルト: auto iPadのWebViewおよびInAppBrowsers WebViewのコンテンツモード(ユーザーエージェント)を設定します。有効な値は mobile とdesktop です。 |
InAppBrowserStatusBarStyle 文字列 |
デフォルト: default iOSのInAppBrowserのStatusBarのテキストの色スタイルを設定します。有効な値は lightcontent とdefault です。 |
SetFullscreen ブール値 |
デフォルト:false このxmlファイルのグローバル設定にあるFullscreenパラメータと同じです。このAndroid固有の要素は、グローバルFullscreen要素に取って代わられ、将来のバージョンでは削除されます。 |
ShowTitle ブール値 |
デフォルト:false 画面上部にタイトルを表示します。 |
Suppresses3DTouchGesture ブール値 |
デフォルト:false ユーザーがwebviewを長押ししたときに、3D Touch対応のiOSデバイスが拡大鏡ウィジェットをレンダリングするのを避けるためにtrueに設定します。onclickハンドラーが無効になるため、アプリを徹底的にテストしてください。ただし、ontouchendとは問題なく動作します。この設定がtrueの場合、SuppressesLongPressGestureも事実上trueになります。 |
SuppressesIncrementalRendering ブール値 |
デフォルト:false すべてのコンテンツの受信が完了するまで待つようにするには、trueに設定します。 |
SuppressesLongPressGesture ブール値 |
デフォルト:false ユーザーがwebviewを長押ししたときに、iOS9以降で拡大鏡ウィジェットがレンダリングされないようにするには、trueに設定します。テキスト選択機能に影響する可能性があるため、アプリを徹底的にテストしてください。 |
SwiftVersion 文字列 |
デフォルト: (空) Swiftのバージョンを指定するために設定します。 |
TopActivityIndicator 文字列 |
デフォルト: gray 許容値: whiteLarge, white, gray. 重要なプロセッサアクティビティを示すステータスバーの小さな回転アイコンの外観を制御します。 |
UIWebViewDecelerationSpeed 文字列 |
デフォルト: normal 許容値: normal, fast このプロパティは、モーメンタムスクロールの減速速度を制御します。normalはほとんどのネイティブアプリのデフォルト速度で、fastはMobile Safariのデフォルトです。 |
deployment-target 文字列 |
これはビルドでIPHONEOS_DEPLOYMENT_TARGETを設定し、最終的にはipaのMinimumOSVersionに変換されます。詳細については、AppleのDeployment Target Settingsに関するドキュメントを参照してください。 |
target-device 文字列 |
デフォルト: universal 許容値: handset, tablet, universal このプロパティは、xcodeプロジェクトのTARGETED_DEVICE_FAMILYに直接マップされます。universalをターゲットとする場合(デフォルト)、iPhoneとiPadの両方のスクリーンショットを提供する必要があります。そうでないと、アプリが拒否される可能性があります。 |
scheme 文字列 |
デフォルト - Android: https - iOS: 定義されていませんが、値が無効な場合は app にフォールバックします。許容値 - Android: http またはhttps - iOS: 予約されていないスキーム。(予約済みスキームの例) このプロパティには、アプリのコンテンツが提供されるスキームが含まれています。 |
hostname 文字列 |
デフォルト: localhost このプロパティには、アプリのコンテンツが提供されるホスト名が含まれています。 iOSで設定 scheme が定義されていない場合、hostname の値は無視されます。 |
例
<preference name="DisallowOverscroll" value="true"/>
<preference name="Fullscreen" value="true" />
<preference name="BackgroundColor" value="0xff0000ff"/>
<preference name="HideKeyboardFormAccessoryBar" value="true"/>
<preference name="Orientation" value="landscape" />
<!-- iOS only preferences -->
<preference name="EnableViewportScale" value="true"/>
<preference name="MediaPlaybackAllowsAirPlay" value="false"/>
<preference name="MediaPlaybackRequiresUserAction" value="true"/>
<preference name="AllowInlineMediaPlayback" value="true"/>
<preference name="TopActivityIndicator" value="white"/>
<preference name="SuppressesIncrementalRendering" value="true"/>
<preference name="GapBetweenPages" value="0"/>
<preference name="PageLength" value="0"/>
<preference name="PaginationBreakingMode" value="page"/>
<preference name="PaginationMode" value="unpaginated"/>
<preference name="UIWebViewDecelerationSpeed" value="fast" />
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />
<preference name="target-device" value="universal" />
<preference name="deployment-target" value="7.0" />
<preference name="CordovaWebViewEngine" value="CDVWebViewEngine" />
<preference name="CordovaDefaultWebViewEngine" value="CDVWebViewEngine" />
<preference name="SuppressesLongPressGesture" value="true" />
<preference name="Suppresses3DTouchGesture" value="true" />
<!-- Android only preferences -->
<preference name="KeepRunning" value="false"/>
<preference name="LoadUrlTimeoutValue" value="10000"/>
<preference name="InAppBrowserStorageEnabled" value="true"/>
<preference name="LoadingDialog" value="My Title,My Message"/>
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="ShowTitle" value="true"/>
<preference name="LogLevel" value="VERBOSE"/>
<preference name="AndroidLaunchMode" value="singleTop"/>
<preference name="AndroidInsecureFileModeEnabled" value="true" />
<preference name="DefaultVolumeStream" value="call" />
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />
<preference name="GradlePluginGoogleServicesEnabled" value="true" />
<preference name="GradlePluginGoogleServicesVersion" value="4.2.0" />
<preference name="GradlePluginKotlinEnabled" value="true" />
<preference name="GradlePluginKotlinCodeStyle" value="official" />
<preference name="GradlePluginKotlinVersion" value="1.3.50" />
feature
CLIを使用してアプリケーションをビルドする場合、プラグインコマンドを使用してデバイスAPIを有効にします。これは最上位のconfig.xmlファイルを変更しないため、
属性 | 説明 |
---|---|
name 文字列 |
必須 有効にするプラグインの名前。 |
param
プラグインコードを取得するパッケージ、およびwebviewの初期化中にプラグインコードを初期化するかどうかなど、特定のプラグインパラメータを指定するために使用されます。
属性 | 説明 |
---|---|
name 文字列 |
必須 許容値: android-package, ios-package, onload. 'ios-package'と'android-package'は、プラグインコードの初期化に使用されるパッケージの名前('value'属性で指定)を指定するために使用され、'onload'は、対応するプラグイン('value'属性で指定)がコントローラの初期化時にインスタンス化されるかどうかを指定するために使用されます。 |
value 文字列/ブール値 |
必須 プラグインコードの初期化に使用されるパッケージの名前を指定します('name'属性がandroid-packageまたはios-packageの場合)、コントローラの初期化中に読み込むプラグインの名前を指定します('name'属性が'onload'に設定されている場合)。 |
例
<!-- Here is how to specify the Device API for Android projects -->
<feature name="Device">
<param name="android-package" value="org.apache.cordova.device.Device" />
</feature>
<!-- Here's how the element appears for iOS projects -->
<feature name="Device">
<param name="ios-package" value="CDVDevice" />
<param name="onload" value="true" />
</feature>
platform
CLIを使用してアプリケーションをビルドする場合、特定のプラットフォームに固有の設定またはその他の要素を指定する必要がある場合があります。
属性 | 説明 |
---|---|
name 文字列 |
必須 設定が定義されているプラットフォーム。 |
例
<platform name="android">
<preference name="Fullscreen" value="true" />
</platform>
フック
特定のアクションが発生したときにCordovaによって呼び出されるカスタムスクリプトを表します(例:プラグインの追加後、またはプラットフォーム準備ロジックの呼び出し後)。これは、デフォルトのCordova機能を拡張する必要がある場合に役立ちます。詳細はHooksガイドを参照してください。
属性 | 説明 |
---|---|
種類 文字列 |
必須 カスタムスクリプトが呼び出されるアクションを指定します。 |
src 文字列 |
必須 特定のアクションが発生したときに呼び出されるスクリプトの場所を指定します。 |
例
<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />
リソースファイル
このタグはリソースファイルをプラットフォームにインストールし、plugin.xml内の同じタグと似ています。このタグは現在、cordova-ios@4.4.0
以上とcordova-android@6.2.1
以上でのみサポートされています。
属性 | 説明 |
---|---|
src 文字列 |
必須 config.xml を基準としたファイルの場所。 |
ターゲット 文字列 |
ファイルがコピーされるディレクトリのパス。 |
例
Androidの場合
<resource-file src="FooPluginStrings.xml" target="res/values/FooPluginStrings.xml" />