Modified: cordova/site/public/docs/en/6.x/config_ref/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/config_ref/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff ============================================================================== --- cordova/site/public/docs/en/6.x/config_ref/index.html (original) +++ cordova/site/public/docs/en/6.x/config_ref/index.html Mon May 16 21:17:45 2016 @@ -2675,7 +2675,7 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2688,24 +2688,24 @@ platform. See <a href="images.html">Cust <td><em>Required</em> <br/> Full version number expressed in major/minor/patch notation.</td> </tr> <tr> -<td>android-versionCode(string)</td> -<td><mark>Android</mark> <br/> Alternative version for Android. Sets the <a href="http://developer.android.com/tools/publishing/versioning.html";>version code</a> for the application. See <a href="../guide/platforms/android/index.html#setting-the-version-code">the Android guide</a> for information on how this attribute may be modified.</td> +<td>android-versionCode(string) <br/> <mark>Android</mark></td> +<td>Alternative version for Android. Sets the <a href="http://developer.android.com/tools/publishing/versioning.html";>version code</a> for the application. See <a href="../guide/platforms/android/index.html#setting-the-version-code">the Android guide</a> for information on how this attribute may be modified.</td> </tr> <tr> -<td>ios-CFBundleVersion(string)</td> -<td><mark>iOS</mark> <br/> Alternative version for iOS. For further details, see <a href="https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364";>iOS versioning</a>.</td> +<td>ios-CFBundleVersion(string) <br/> <mark>iOS</mark></td> +<td>Alternative version for iOS. For further details, see <a href="https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364";>iOS versioning</a>.</td> </tr> <tr> -<td>osx-CFBundleVersion(string)</td> -<td><mark>OS X</mark> <br/> Alternative version for OS X. For further details, see <a href="https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364";>OS X versioning</a>.</td> +<td>osx-CFBundleVersion(string) <br/> <mark>OS X</mark></td> +<td>Alternative version for OS X. For further details, see <a href="https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364";>OS X versioning</a>.</td> </tr> <tr> -<td>windows-packageVersion(string)</td> -<td><mark>Windows</mark> <br/> Alternative version for Windows. For futher details, see <a href="https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx";>Windows versioning</a></td> +<td>windows-packageVersion(string) <br/> <mark>Windows</mark></td> +<td>Alternative version for Windows. For futher details, see <a href="https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx";>Windows versioning</a></td> </tr> <tr> -<td>packageName(string)</td> -<td><em>Default: Cordova.Example</em> <br/> <mark>Windows</mark> <br/> Package name for Windows.</td> +<td>packageName(string) <br/> <mark>Windows</mark></td> +<td><em>Default: Cordova.Example</em> <br/> Package name for Windows.</td> </tr> <tr> <td>xmlns(string)</td> @@ -2718,39 +2718,39 @@ platform. See <a href="images.html">Cust </tbody></table> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="c"><!-- Android --></span> - <span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">android-versionCode=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> - <span class="nt"></widget></span> - - <span class="c"><!-- iOS --></span> - <span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">ios-CFBundleVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> - <span class="nt"></widget></span> - - <span class="c"><!-- Windows --></span> - <span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">windows-packageVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> - <span class="nt"></widget></span> - - <span class="c"><!-- OS X --></span> - <span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">osx-CFBundleVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="c"><!-- Android --></span> +<span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">android-versionCode=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> +<span class="nt"></widget></span> + +<span class="c"><!-- iOS --></span> +<span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">ios-CFBundleVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> +<span class="nt"></widget></span> + +<span class="c"><!-- Windows --></span> +<span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">windows-packageVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> +<span class="nt"></widget></span> + +<span class="c"><!-- OS X --></span> +<span class="nt"><widget</span> <span class="na">id=</span><span class="s">"io.cordova.hellocordova"</span> <span class="na">version=</span><span class="s">"0.0.1"</span> <span class="na">osx-CFBundleVersion=</span><span class="s">"0.1.3"</span> <span class="na">xmlns=</span><span class="s">"http://www.w3.org/ns/widgets";</span> <span class="na">xmlns:cdv=</span><span class="s">"http://cordova.apache.org/ns/1.0";</span><span class="nt">></span> +<span class="nt"></widget></span> </code></pre></div> <h2>name</h2> <p>Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><name></span>HelloCordova<span class="nt"></name></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><name></span>HelloCordova<span class="nt"></name></span> +<span class="nt"></widget></span> </code></pre></div> <h2>description</h2> <p>Specifies metadata that may appear within app-store listings.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><description></span>A sample Apache Cordova application<span class="nt"></description></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><description></span>A sample Apache Cordova application<span class="nt"></description></span> +<span class="nt"></widget></span> </code></pre></div> <h2>author</h2> @@ -2758,7 +2758,7 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2773,18 +2773,18 @@ platform. See <a href="images.html">Cust </tbody></table> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><author</span> <span class="na">email=</span><span class="s">"d...@cordova.apache.org"</span> <span class="na">href=</span><span class="s">"http://cordova.io";</span><span class="nt">></author></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><author</span> <span class="na">email=</span><span class="s">"d...@cordova.apache.org"</span> <span class="na">href=</span><span class="s">"http://cordova.io";</span><span class="nt">></author></span> +<span class="nt"></widget></span> </code></pre></div> <h2>content</h2> <p>Defines the app's starting page in the top-level web assets directory. The default value is index.html, which customarily - appears in a project's top-level <code>www</code> directory.</p> +appears in a project's top-level <code>www</code> directory.</p> <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2797,18 +2797,18 @@ platform. See <a href="images.html">Cust <p>appears in a project's top-level <code>www</code> directory.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><content</span> <span class="na">src=</span><span class="s">"startPage.html"</span><span class="nt">></content></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><content</span> <span class="na">src=</span><span class="s">"startPage.html"</span><span class="nt">></content></span> +<span class="nt"></widget></span> </code></pre></div> <h2>access</h2> <p>Defines the set of external domains the app is allowed to communicate with. The default value shown above allows it to access any server. - See the Domain <a href="../guide/appdev/whitelist/index.html">Whitelist Guide</a> for details.</p> +See the Domain <a href="../guide/appdev/whitelist/index.html">Whitelist Guide</a> for details.</p> <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2819,16 +2819,16 @@ platform. See <a href="images.html">Cust </tbody></table> <p>The default value shown above allows it to access any server. - See the Domain <a href="../guide/appdev/whitelist/index.html">Whitelist Guide</a> for details.</p> +See the Domain <a href="../guide/appdev/whitelist/index.html">Whitelist Guide</a> for details.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><access</span> <span class="na">origin=</span><span class="s">"*"</span><span class="nt">></content></span> - <span class="nt"></widget></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><access</span> <span class="na">origin=</span><span class="s">"*"</span><span class="nt">></content></span> +<span class="nt"></widget></span> - <span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> - <span class="nt"><access</span> <span class="na">origin=</span><span class="s">"http://google.com";</span><span class="nt">></content></span> - <span class="nt"></widget></span> +<span class="nt"><widget</span> <span class="err">...</span><span class="nt">></span> + <span class="nt"><access</span> <span class="na">origin=</span><span class="s">"http://google.com";</span><span class="nt">></content></span> +<span class="nt"></widget></span> </code></pre></div> <h2>allow-navigation</h2> @@ -2836,7 +2836,7 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2849,11 +2849,11 @@ platform. See <a href="images.html">Cust <p>See the cordova-plugin-whitelist <a href="../reference/cordova-plugin-whitelist/index.html#navigation-whitelist">cordova-plugin-whitelist</a> for details.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="c"><!-- Allow links to example.com --></span> - <span class="nt"><allow-navigation</span> <span class="na">href=</span><span class="s">"http://example.com/*";</span> <span class="nt">/></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="c"><!-- Allow links to example.com --></span> +<span class="nt"><allow-navigation</span> <span class="na">href=</span><span class="s">"http://example.com/*";</span> <span class="nt">/></span> - <span class="c"><!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path --></span> - <span class="nt"><allow-navigation</span> <span class="na">href=</span><span class="s">"*://*.example.com/*"</span> <span class="nt">/></span> +<span class="c"><!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path --></span> +<span class="nt"><allow-navigation</span> <span class="na">href=</span><span class="s">"*://*.example.com/*"</span> <span class="nt">/></span> </code></pre></div> <h2>allow-intent</h2> @@ -2861,7 +2861,7 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2874,10 +2874,10 @@ platform. See <a href="images.html">Cust <p>See the cordova-plugin-whitelist <a href="../reference/cordova-plugin-whitelist/index.html#intent-whitelist">cordova-plugin-whitelist</a> for details.</p> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"http://*/*";</span> <span class="nt">/></span> - <span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"https://*/*";</span> <span class="nt">/></span> - <span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"tel:*"</span> <span class="nt">/></span> - <span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"sms:*"</span> <span class="nt">/></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"http://*/*";</span> <span class="nt">/></span> +<span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"https://*/*";</span> <span class="nt">/></span> +<span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"tel:*"</span> <span class="nt">/></span> +<span class="nt"><allow-intent</span> <span class="na">href=</span><span class="s">"sms:*"</span> <span class="nt">/></span> </code></pre></div> <h2>engine</h2> @@ -2885,7 +2885,7 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2900,16 +2900,19 @@ platform. See <a href="images.html">Cust </tbody></table> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"android"</span> <span class="na">spec=</span><span class="s">"https://github.com/apache/cordova-android.git#5.1.1";</span> <span class="nt">/></span> - <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"ios"</span> <span class="na">spec=</span><span class="s">"^4.0.0"</span> <span class="nt">/></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><engine</span> <span class="na">name=</span><span class="s">"android"</span> <span class="na">spec=</span><span class="s">"https://github.com/apache/cordova-android.git#5.1.1";</span> <span class="nt">/></span> +<span class="nt"><engine</span> <span class="na">name=</span><span class="s">"ios"</span> <span class="na">spec=</span><span class="s">"^4.0.0"</span> <span class="nt">/></span> </code></pre></div> <h2>plugin</h2> -<p>Specifies details about what plugin to restore during a prepare.</p> +<p>Specifies details about what plugin to restore during a prepare. This element +is automatically added to a project's <code>config.xml</code> when a plugin is added using +the <code>--save</code> flag. See the <a href="../reference/cordova-cli/index.html#cordova-plugin-command">CLI reference</a> for more information on +adding plugins.</p> <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -2924,320 +2927,354 @@ platform. See <a href="images.html">Cust </tbody></table> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><plugin</span> <span class="na">name=</span><span class="s">"cordova-plugin-device"</span> <span class="na">spec=</span><span class="s">"^1.1.0"</span> <span class="nt">/></span> - <span class="nt"><plugin</span> <span class="na">name=</span><span class="s">"cordova-plugin-device"</span> <span class="na">spec=</span><span class="s">"https://github.com/apache/cordova-plugin-device.git#1.0.0";</span> <span class="nt">/></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><plugin</span> <span class="na">name=</span><span class="s">"cordova-plugin-device"</span> <span class="na">spec=</span><span class="s">"^1.1.0"</span> <span class="nt">/></span> +<span class="nt"><plugin</span> <span class="na">name=</span><span class="s">"cordova-plugin-device"</span> <span class="na">spec=</span><span class="s">"https://github.com/apache/cordova-plugin-device.git#1.0.0";</span> <span class="nt">/></span> +</code></pre></div> +<h3>variable</h3> + +<p>Persists the value of a CLI variable to be used when restoring a plugin during a +prepare. This element is added to <code>config.xml</code> when a plugin that uses CLI variables +is added using the <code>--save</code> flag. See the <a href="../reference/cordova-cli/index.html#cordova-plugin-command">CLI reference</a> for more +information on adding plugins.</p> + +<p>Note that this value is only used when the plugin is restored to the project during a +prepare, changing it will <em>not</em> change the value used by the plugin in the current +project. In order for changes to this value to take effect, remove the plugin from the +project and restore it by running <code>cordova prepare</code>. See the +<a href="../plugin_ref/spec.html#preference">preference element</a> of <code>plugin.xml</code> for more details on CLI variables.</p> + +<table><thead> +<tr> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> +<th>Description</th> +</tr> +</thead><tbody> +<tr> +<td>name(string)</td> +<td><em>Required</em> <br/> Name of the CLI variable. Can only contain capital letters, digits, and underscores.</td> +</tr> +<tr> +<td>value(string)</td> +<td><em>Required</em> <br/> Value of the CLI variable to be used when restoring the parent plugin during a prepare.</td> +</tr> +</tbody></table> + +<p>Examples:</p> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><plugin</span> <span class="na">name=</span><span class="s">"cordova-plugin-device"</span> <span class="na">spec=</span><span class="s">"^1.1.0"</span><span class="nt">></span> + <span class="nt"><variable</span> <span class="na">name=</span><span class="s">"MY_VARIABLE"</span> <span class="na">value=</span><span class="s">"my_variable_value"</span> <span class="nt">/></span> +<span class="nt"></plugin></span> </code></pre></div> <h2>preference</h2> <p>Sets various options as pairs of name/value attributes. Each preference's name is case-insensitive. Many preferences are unique to specific platforms, - and will be indicated as such.</p> +and will be indicated as such.</p> <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> <tr> -<td>AllowInlineMediaPlayback(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any <code><video></code> elements.</td> +<td>AllowInlineMediaPlayback(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any <code><video></code> elements.</td> </tr> <tr> -<td>AndroidLaunchMode(string)</td> -<td><em>Default: singleTop</em> <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> <mark>Android</mark> <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.</td> +<td>AndroidLaunchMode(string) <br/> <mark>Android</mark></td> +<td><em>Default: singleTop</em> <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> Sets the Activity android:launchMode attribute. This changes what happens when the app is launched from app icon or intent and is already running.</td> </tr> <tr> -<td>android-maxSdkVersion(integer)</td> -<td><em>Default: Not Specified</em> <br/> <mark>Android</mark> <br/> Sets the <code>maxSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> +<td>android-maxSdkVersion(integer) <br/> <mark>Android</mark></td> +<td><em>Default: Not Specified</em> <br/> Sets the <code>maxSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> </tr> <tr> -<td>android-minSdkVersion(integer)</td> -<td><em>Default: Dependent on cordova-android Version</em> <br/> <mark>Android</mark> <br/> Sets the <code>minSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> +<td>android-minSdkVersion(integer) <br/> <mark>Android</mark></td> +<td><em>Default: Dependent on cordova-android Version</em> <br/> Sets the <code>minSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> </tr> <tr> -<td>android-targetSdkVersion(integer)</td> -<td><em>Default: Dependent on cordova-android Version</em> <br/> <mark>Android</mark> <br/> Sets the <code>targetSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> +<td>android-targetSdkVersion(integer) <br/> <mark>Android</mark></td> +<td><em>Default: Dependent on cordova-android Version</em> <br/> Sets the <code>targetSdkVersion</code> attribute of the <code><uses-sdk></code> tag in the project's <code>AndroidManifest.xml</code> (see <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html";>here</a>).</td> </tr> <tr> -<td>AppendUserAgent(string)</td> -<td><mark>Android</mark> <mark>iOS</mark> <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.</td> +<td>AppendUserAgent(string) <br/> <mark>Android</mark> <mark>iOS</mark></td> +<td>If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored.</td> </tr> <tr> -<td>BackgroundColor(string)</td> -<td><mark>Android</mark> <mark>BlackBerry</mark> <mark>Windows</mark> <br/> Sets the app's background color. Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. <br/> For Windows, the alpha channel is ignored. <br/> <strong>Note</strong>: <code>transparent</code> value will set the application tile background to the accent color on Windows.</td> +<td>BackgroundColor(string) <br/> <mark>Android</mark> <mark>BlackBerry</mark> <mark>Windows</mark></td> +<td>Sets the app's background color. Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. <br/> For Windows, the alpha channel is ignored. <br/> <strong>Note</strong>: <code>transparent</code> value will set the application tile background to the accent color on Windows.</td> </tr> <tr> -<td>BackupWebStorage(string)</td> -<td><em>Default: cloud</em> <br/> Allowed values: none, local, cloud. <br/> <mark>iOS</mark> <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.</td> +<td>BackupWebStorage(string) <br/> <mark>iOS</mark></td> +<td><em>Default: cloud</em> <br/> Allowed values: none, local, cloud. <br/> Set to cloud to allow web storage data to backup via iCloud. Set to local to allow only local backups via iTunes sync. Set to none prevent web storage backups.</td> </tr> <tr> -<td>ChildBrowser(string)</td> -<td><em>Default: enable</em> <br/> <mark>BlackBerry</mark> <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.</td> +<td>ChildBrowser(string) <br/> <mark>BlackBerry</mark></td> +<td><em>Default: enable</em> <br/> Disables child browser windows. By default, apps launch a secondary browser window to display resources accessed via window.open() or by specifying a _blank anchor target. Specify disable to override this default behavior.</td> </tr> <tr> -<td>CordovaWebViewEngine(string)</td> -<td><em>Default: CDVUIWebViewEngine</em> <br/> <mark>iOS</mark> <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.</td> +<td>CordovaWebViewEngine(string) <br/> <mark>iOS</mark></td> +<td><em>Default: CDVUIWebViewEngine</em> <br/> This sets the WebView engine plugin to be used to render the host app. The plugin must conform to the CDVWebViewEngineProtocol protocol. The 'value' here should match the 'feature' name of the WebView engine plugin that is installed. This preference usually would be set by the WebView engine plugin that is installed, automatically.</td> </tr> <tr> -<td>DefaultVolumeStream(string)</td> -<td><em>Default: default</em> <br/> <mark>Android</mark><br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.</td> +<td>DefaultVolumeStream(string) <br/> <mark>Android</mark></td> +<td><em>Default: default</em> <br/> Added in cordova-android 3.7.0, This preference sets which volume the hardware volume buttons link to. By default this is "call" for phones and "media" for tablets. Set this to "media" to have your app's volume buttons always change the media volume. Note that when using Cordova's media plugin, the volume buttons will dynamically change to controlling the media volume when any Media objects are active.</td> </tr> <tr> -<td>DisallowOverscroll(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <mark>Android</mark> <br/> Set to <strong>true</strong> if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/></td> +<td>DisallowOverscroll(boolean) <br/> <mark>iOS</mark> <mark>Android</mark></td> +<td><em>Default: false</em> <br/> Set to <strong>true</strong> if you don't want the interface to display any feedback when users scroll past the beginning or end of content. On iOS, overscroll gestures cause content to bounce back to its original position. on Android, they produce a more subtle glowing effect along the top or bottom edge of the content. <br/></td> </tr> <tr> -<td>EnableViewportScale(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> <code><meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' /></code></td> +<td>EnableViewportScale(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling, which is enabled by default. Place a viewport such as the following in the HTML to disable scaling and fit content flexibly within the rendering WebView: <br/> <code><meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' /></code></td> </tr> <tr> -<td>EnableWebGL(boolean)</td> -<td><em>Default: false</em> <br/> <mark>OS X <strong>4.0.0</strong></mark> <br/> Set to true to enable WebGL on the web view.</td> +<td>EnableWebGL(boolean) <br/> <mark>OS X</mark></td> +<td><em>Default: false</em> <br/> <strong>(OS X 4.0.0+)</strong> Set to true to enable WebGL on the web view.</td> </tr> <tr> -<td>ErrorUrl(URL)</td> -<td><em>Default: null</em> <br/> <mark>Android</mark> <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".</td> +<td>ErrorUrl(URL) <br/> <mark>Android</mark></td> +<td><em>Default: null</em> <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error".</td> </tr> <tr> -<td>ErrorUrl(string)</td> -<td><mark>iOS</mark> <br/> If set, will display the referenced local page upon an error in the application.</td> +<td>ErrorUrl(string) <br/> <mark>iOS</mark></td> +<td>If set, will display the referenced local page upon an error in the application.</td> </tr> <tr> -<td>FullScreen(boolean)</td> -<td><em>Default: false</em> <br/> <mark>Android</mark> <br/> Allows you to hide the status bar at the top of the screen. <br/> <strong>Note</strong>: Recommended platform-agnostic way to achieve this is to use the <a href="../reference/cordova-plugin-statusbar/">StatusBar plugin</a>.</td> +<td>FullScreen(boolean) <br/> <mark>Android</mark></td> +<td><em>Default: false</em> <br/> Allows you to hide the status bar at the top of the screen. <br/> <strong>Note</strong>: Recommended platform-agnostic way to achieve this is to use the <a href="../reference/cordova-plugin-statusbar/">StatusBar plugin</a>.</td> </tr> <tr> -<td>GapBetweenPages(float)</td> -<td><em>Default: 0</em> <br/> <mark>iOS</mark> <br/> The size of the gap, in points, between pages.</td> +<td>GapBetweenPages(float) <br/> <mark>iOS</mark></td> +<td><em>Default: 0</em> <br/> The size of the gap, in points, between pages.</td> </tr> <tr> -<td>HideKeyboardFormAccessoryBar(boolean)</td> -<td><em>Default: false</em> <br/> <mark>BlackBerry</mark> <br/> Set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.</td> +<td>HideKeyboardFormAccessoryBar(boolean) <br/> <mark>BlackBerry</mark></td> +<td><em>Default: false</em> <br/> Set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another.</td> </tr> <tr> -<td>HideMousePointer(integer)</td> -<td><em>Default: -1</em> <br/> <mark>OS X <strong>4.0.0</strong></mark> <br/> Sets the timeout for hiding the mouse pointer. Set to 0 for immediate, set to -1 for never.</td> +<td>HideMousePointer(integer) <br/> <mark>OS X</mark></td> +<td><em>Default: -1</em> <br/> <strong>(OS X 4.0.0+)</strong> Sets the timeout for hiding the mouse pointer. Set to 0 for immediate, set to -1 for never.</td> </tr> <tr> -<td>InAppBrowserStorageEnabled (boolean)</td> -<td><em>Default: true</em> <br/> <mark>Android</mark> <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.</td> +<td>InAppBrowserStorageEnabled (boolean) <br/> <mark>Android</mark></td> +<td><em>Default: true</em> <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser.</td> </tr> <tr> -<td>KeepRunning(boolean)</td> -<td><em>Default: true</em> <br/> <mark>Android</mark> <br/> Determines whether the application stays running in the background even after a <a href="../../../cordova/events/events.pause.html">pause</a> event fires. Setting this to false does not kill the app after a <a href="../../../cordova/events/events.pause.html">pause</a> event, but simply halts execution of code within the cordova webview while the app is in the background.</td> +<td>KeepRunning(boolean) <br/> <mark>Android</mark></td> +<td><em>Default: true</em> <br/> Determines whether the application stays running in the background even after a <a href="../../../cordova/events/events.pause.html">pause</a> event fires. Setting this to false does not kill the app after a <a href="../../../cordova/events/events.pause.html">pause</a> event, but simply halts execution of code within the cordova webview while the app is in the background.</td> </tr> <tr> -<td>KeyboardDisplayRequiresUserAction(boolean)</td> -<td><em>Default: true</em> <br/> <mark>iOS</mark> <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.</td> +<td>KeyboardDisplayRequiresUserAction(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: true</em> <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs.</td> </tr> <tr> -<td>LoadUrlTimeoutValue(number in milliseconds)</td> -<td><em>Default: 20000, 20 seconds</em> <br/> <mark>Android</mark> <br/> When loading a page, the amount of time to wait before throwing a timeout error.</td> +<td>LoadUrlTimeoutValue(number in milliseconds) <br/> <mark>Android</mark></td> +<td><em>Default: 20000, 20 seconds</em> <br/> When loading a page, the amount of time to wait before throwing a timeout error.</td> </tr> <tr> -<td>LoadingDialog(string)</td> -<td><em>Default: null</em> <br/> <mark>Android</mark> <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.</td> +<td>LoadingDialog(string) <br/> <mark>Android</mark></td> +<td><em>Default: null</em> <br/> If set, displays a dialog with the specified title and message, and a spinner, when loading the first page of an application. The title and message are separated by a comma in this value string, and that comma is removed before the dialog is displayed.</td> </tr> <tr> -<td>LogLevel(string)</td> -<td><em>Default: ERROR</em> <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> <mark>Android</mark> <br/> Sets the minimum log level through which log messages from your application will be filtered.</td> +<td>LogLevel(string) <br/> <mark>Android</mark></td> +<td><em>Default: ERROR</em> <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> Sets the minimum log level through which log messages from your application will be filtered.</td> </tr> <tr> -<td>MediaPlaybackAllowsAirPlay(boolean)</td> -<td><em>Default: true</em> <br/> <mark>iOS</mark> <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.</td> +<td>MediaPlaybackAllowsAirPlay(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: true</em> <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView.</td> </tr> <tr> -<td>MediaPlaybackRequiresUserAction(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.</td> +<td>MediaPlaybackRequiresUserAction(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript.</td> </tr> <tr> -<td>Min/Max Version(Regex)</td> -<td><mark>Windows</mark> <br/> Allowed values: <strong>/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i</strong> <br/> Identifies the ecosystems and their min/max versions the app is compatible with. There are three parts to each value: the <strong>SDK</strong>, the <strong>version restriction</strong>, and the <strong>version value</strong>. These preferences are detected by beginning with <code>Windows</code> or <code>Microsoft</code> and ending in <code>-MinVersion</code> or <code>-MaxVersionTested</code>: <ul><li>The <strong>SDK</strong> defines what specialized platform you want to target. The default is <code>Windows.Universal</code>. Valid values for these are defined in the AppxManifest schema, in the <code>Package/Depednencies/TargetPlatform</code> elements.</li><li>The <strong>version restriction</strong> defines application compatibility rules. For example, if the <code>-MinVersion</code> is set to 10.1.0.0, then OS versions which don't sup port at least 10.1.0.0 of the corresponding SDK won't be able to load it. Similarly you can also use <code>-MaxVersionTested</code> which specifies the highest-tested version of the SDK. If a new version of the corresponding SDK is released, it will run in compatibility mode for the specified version.</li><li>The <strong>version value</strong> is a 4-integer tuple in the form of <em>major.minor.build.qfe</em>.</li></ul> If no preferences of these types are specified in your config.xml file, then Windows.Universal version 10.0.0.0 will be chosen by default. <br/> <strong>Note:</strong> These preferences are only set in the appxmanifest files of the desired target-platform and not in the jsproj files.</td> +<td>Min/Max Version(Regex) <br/> <mark>Windows</mark></td> +<td>Allowed values: <strong>/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i</strong> <br/> Identifies the ecosystems and their min/max versions the app is compatible with. There are three parts to each value: the <strong>SDK</strong>, the <strong>version restriction</strong>, and the <strong>version value</strong>. These preferences are detected by beginning with <code>Windows</code> or <code>Microsoft</code> and ending in <code>-MinVersion</code> or <code>-MaxVersionTested</code>: <ul><li>The <strong>SDK</strong> defines what specialized platform you want to target. The default is <code>Windows.Universal</code>. Valid values for these are defined in the AppxManifest schema, in the <code>Package/Depednencies/TargetPlatform</code> elements.</li><li>The <strong>version restriction</strong> defines application compatibility rules. For example, if the <code>-MinVersion</code> is set to 10.1.0.0, then OS versions which don't support at least 10.1.0.0 of t he corresponding SDK won't be able to load it. Similarly you can also use <code>-MaxVersionTested</code> which specifies the highest-tested version of the SDK. If a new version of the corresponding SDK is released, it will run in compatibility mode for the specified version.</li><li>The <strong>version value</strong> is a 4-integer tuple in the form of <em>major.minor.build.qfe</em>.</li></ul> If no preferences of these types are specified in your config.xml file, then Windows.Universal version 10.0.0.0 will be chosen by default. <br/> <strong>Note:</strong> These preferences are only set in the appxmanifest files of the desired target-platform and not in the jsproj files.</td> </tr> <tr> <td>Orientation(string)</td> -<td><em>Default: default</em> <br/> Allowed values: default, landscape, portait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> <strong>NOTE:</strong> The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.</td> +<td><em>Default: default</em> <br/> Allowed values: default, landscape, portrait <br/> Allows you to lock orientation and prevent the interface from rotating in response to changes in orientation. <br/> <strong>NOTE:</strong> The default value means Cordova will strip the orientation preference entry from the platform's manifest/configuration file allowing the platform to fallback to its default behavior. For iOS, to specify both portrait & landscape mode you would use the platform specific value 'all'.</td> </tr> <tr> -<td>OSXLocalStoragePath(string)</td> -<td><mark>OS X <strong>4.0.0</strong></mark> <br/> <em>Default: <code>~/Library/Application Support/{bundle.id}</code></em> <br/> Sets the directory for the local storage path.</td> +<td>OSXLocalStoragePath(string) <br/> <mark>OS X</mark></td> +<td><em>Default: <code>~/Library/Application Support/{bundle.id}</code></em> <br/> <strong>(OS X 4.0.0+)</strong> Sets the directory for the local storage path.</td> </tr> <tr> -<td>OverrideUserAgent(string)</td> -<td><mark>Android</mark> <br/> If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.</td> +<td>OverrideUserAgent(string) <br/> <mark>Android</mark></td> +<td>If set, the value will replace the old UserAgent of webview. It is helpful to identify the request from app/browser when requesting remote pages. Use with caution, this may causes compitiable issue with web servers. For most cases, use AppendUserAgent instead.</td> </tr> <tr> -<td>PageLength(float)</td> -<td><em>Default: 0</em> <br/> <mark>iOS</mark> <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.</td> +<td>PageLength(float) <br/> <mark>iOS</mark></td> +<td><em>Default: 0</em> <br/> The size of each page, in points, in the direction that the pages flow. When PaginationMode is right to left or left to right, this property represents the width of each page. When PaginationMode is topToBottom or bottomToTop, this property represents the height of each page. The default value is 0, which means the layout uses the size of the viewport to determine the dimensions of the page.</td> </tr> <tr> -<td>PaginationBreakingMode(string)</td> -<td><em>Default: page</em> <br/> Allowed values: page, column <br/> <mark>iOS</mark> <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.</td> +<td>PaginationBreakingMode(string) <br/> <mark>iOS</mark></td> +<td><em>Default: page</em> <br/> Allowed values: page, column <br/> Valid values are page and column.The manner in which column- or page-breaking occurs. This property determines whether certain CSS properties regarding column- and page-breaking are honored or ignored. When this property is set to column, the content respects the CSS properties related to column-breaking in place of page-breaking.</td> </tr> <tr> -<td>PaginationMode(string)</td> -<td><em>Default: unpaginated</em> <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> <mark>iOS</mark> <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.</td> +<td>PaginationMode(string) <br/> <mark>iOS</mark></td> +<td><em>Default: unpaginated</em> <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> This property determines whether content in the web view is broken up into pages that fill the view one screen at a time,or shown as one long scrolling view. If set to a paginated form, this property toggles a paginated layout on the content, causing the web view to use the values of PageLength and GapBetweenPages to relayout its content.</td> </tr> <tr> -<td>PopupBlocker(string)</td> -<td><em>Default: enable</em> <br/> <mark>BlackBerry</mark> <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.</td> +<td>PopupBlocker(string) <br/> <mark>BlackBerry</mark></td> +<td><em>Default: enable</em> <br/> Enables the popup blocker, which prevents calls to window.open(). By default, popups display in a child browser window. Setting the preference to enable prevents it from displaying at all.</td> </tr> <tr> -<td>SetFullscreen(boolean)</td> -<td><em>Default: false</em> <br/> <mark>Android</mark> <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.</td> +<td>SetFullscreen(boolean) <br/> <mark>Android</mark></td> +<td><em>Default: false</em> <br/> Same as the Fullscreen parameter in the global configuration of this xml file. This Android-specific element is deprecated in favor of the global Fullscreen element, and will be removed in a future version.</td> </tr> <tr> -<td>ShowTitle(boolean)</td> -<td><em>Default: false</em> <br/> <mark>Android</mark> <br/> Show the title at the top of the screen.</td> +<td>ShowTitle(boolean) <br/> <mark>Android</mark></td> +<td><em>Default: false</em> <br/> Show the title at the top of the screen.</td> </tr> <tr> -<td>SplashScreenBackgroundColor</td> -<td><em>Default: #464646</em> <br/> <mark>Windows</mark> <br/> Sets the splashscreen background color. Supports a CSS color name or a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. <br/> The alpha channel is ignored although <code>transparent</code> value will cause black/white background color in case of Dark/Light theme accordingly.</td> +<td>SplashScreenBackgroundColor <br/> <mark>Windows</mark></td> +<td><em>Default: #464646</em> <br/> Sets the splashscreen background color. Supports a CSS color name or a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. <br/> The alpha channel is ignored although <code>transparent</code> value will cause black/white background color in case of Dark/Light theme accordingly.</td> </tr> <tr> -<td>Suppresses3DTouchGesture(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.</td> +<td>Suppresses3DTouchGesture(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to avoid 3D Touch capable iOS devices rendering a magnifying glass widget when the user applies force while longpressing the webview. Test your app thoroughly since this disables onclick handlers, but plays nice with ontouchend. If this setting is true, SuppressesLongPressGesture will effectively be true as well.</td> </tr> <tr> -<td>SuppressesIncrementalRendering(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to wait until all content has been received before it renders to the screen.</td> +<td>SuppressesIncrementalRendering(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to wait until all content has been received before it renders to the screen.</td> </tr> <tr> -<td>SuppressesLongPressGesture(boolean)</td> -<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.</td> +<td>SuppressesLongPressGesture(boolean) <br/> <mark>iOS</mark></td> +<td><em>Default: false</em> <br/> Set to true to avoid iOS9+ rendering a magnifying glass widget when the user longpresses the webview. Test your app thoroughly since this may interfere with text selection capabilities.</td> </tr> <tr> -<td>TopActivityIndicator(string)</td> -<td><em>Default: gray</em> <br/> Allowed values: whiteLarge, white, gray. <br/> <mark>iOS</mark> <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.</td> +<td>TopActivityIndicator(string) <br/> <mark>iOS</mark></td> +<td><em>Default: gray</em> <br/> Allowed values: whiteLarge, white, gray. <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity.</td> </tr> <tr> -<td>uap-target-min-version(string)</td> -<td><mark>Windows</mark> <br/> This property sets the MinTargetVersion for the Windows UAP. If not specified, this is set to the initial release version 10.0.10240.0 <br/> <strong>Note:</strong> This preference is set in the jsproj file and not in the appxmanifest file. So users with OS version lower than this value would not be able to run the app.</td> +<td>uap-target-min-version(string) <br/> <mark>Windows</mark></td> +<td>This property sets the MinTargetVersion for the Windows UAP. If not specified, this is set to the initial release version 10.0.10240.0 <br/> <strong>Note:</strong> This preference is set in the jsproj file and not in the appxmanifest file. So users with OS version lower than this value would not be able to run the app.</td> </tr> <tr> -<td>UIWebViewDecelerationSpeed(string)</td> -<td><em>Default: normal</em> <br/> Allowed values: normal, fast <br/> <mark>iOS</mark> <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.</td> +<td>UIWebViewDecelerationSpeed(string) <br/> <mark>iOS</mark></td> +<td><em>Default: normal</em> <br/> Allowed values: normal, fast <br/> This property controls the deceleration speed of momentum scrolling. normal is the default speed for most native apps, and fast is the default for Mobile Safari.</td> </tr> <tr> -<td>WebSecurity(string)</td> -<td><em>Default: enable</em> <br/> <mark>BlackBerry</mark> <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.</td> +<td>WebSecurity(string) <br/> <mark>BlackBerry</mark></td> +<td><em>Default: enable</em> <br/> Set to disable to override web security settings, allowing access to remote content from unknown sources. This preference is intended as a development convenience only, so remove it before packaging the app for distribution. For the released app, all URIs should be known and whitelisted using the <access> element, described in the Domain Whitelist Guide.</td> </tr> <tr> -<td>WindowSize(string)</td> -<td><em>Default: auto</em> <br/> <mark>OS X <strong>4.0.0</strong></mark> <br/> Sets the size of the application window. <br/> Accepts the format <code>WxH</code> for a specific width and height or the special values <code>auto</code> and <code>fullscreen</code>. The latter will open a borderless window spanning the entire desktop area. Please note, that this is different from the <em>normal</em> OS X fullscreen mode, which would never span multiple displays. <br/> <strong>Note</strong>: The global cordova <code>fullscreen</code> preference has no effect in OS X.</td> +<td>WindowSize(string) <br/> <mark>OS X</mark></td> +<td><em>Default: auto</em> <br/> <strong>(OS X 4.0.0+)</strong> Sets the size of the application window. <br/> Accepts the format <code>WxH</code> for a specific width and height or the special values <code>auto</code> and <code>fullscreen</code>. The latter will open a borderless window spanning the entire desktop area. Please note, that this is different from the <em>normal</em> OS X fullscreen mode, which would never span multiple displays. <br/> <strong>Note</strong>: The global cordova <code>fullscreen</code> preference has no effect in OS X.</td> </tr> <tr> -<td>WindowsDefaultUriPrefix(string)</td> -<td><mark>Windows</mark> <br/> Allowed values: <code>ms-appx://</code>, <code>ms-appx-web://</code> <br/> Identifies whether you want your app to target the local context or remote context as its startup URI. When building for Windows 10, the default is the remote context (<code>ms-appx-web://</code>). <br/> In order to have a local-mode application that is not impacted by Remote Mode capability restrictions, you must set this preference to <code>ms-appx://</code> and not declare any <code><access></code> elements with remote URIs. The local mode is the default for Windows 8.1</td> +<td>WindowsDefaultUriPrefix(string) <br/> <mark>Windows</mark></td> +<td>Allowed values: <code>ms-appx://</code>, <code>ms-appx-web://</code> <br/> Identifies whether you want your app to target the local context or remote context as its startup URI. When building for Windows 10, the default is the remote context (<code>ms-appx-web://</code>). <br/> In order to have a local-mode application that is not impacted by Remote Mode capability restrictions, you must set this preference to <code>ms-appx://</code> and not declare any <code><access></code> elements with remote URIs. The local mode is the default for Windows 8.1</td> </tr> <tr> -<td>WindowsStoreDisplayName(string)</td> -<td><mark>Windows</mark> <br/> A friendly name for the publisher that can be displayed to users.</td> +<td>WindowsStoreDisplayName(string) <br/> <mark>Windows</mark></td> +<td>A friendly name for the publisher that can be displayed to users.</td> </tr> <tr> -<td>WindowsStoreIdentityName(string)</td> -<td><mark>Windows</mark> <br/> Identity name used for Windows store. The identity defines a globally unique identifier for a package. A package identity is represented as a tuple of attributes of the package. See the <a href="https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx";>identity page on the package manifest schema reference</a> for further details.</td> +<td>WindowsStoreIdentityName(string) <br/> <mark>Windows</mark></td> +<td>Identity name used for Windows store. The identity defines a globally unique identifier for a package. A package identity is represented as a tuple of attributes of the package. See the <a href="https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx";>identity page on the package manifest schema reference</a> for further details.</td> </tr> <tr> -<td>WindowsStorePublisherName(string)</td> -<td><mark>Windows</mark> <br/> Publisher Display Name.</td> +<td>WindowsStorePublisherName(string) <br/> <mark>Windows</mark></td> +<td>Publisher Display Name.</td> </tr> <tr> -<td>WindowsToastCapable(boolean)</td> -<td><em>Default: false</em> <br/> <mark>Windows</mark> <br/> A value of <code>true</code> indicates that the app is allowed to provide 'toast notifications'.</td> +<td>WindowsToastCapable(boolean) <br/> <mark>Windows</mark></td> +<td><em>Default: false</em> <br/> A value of <code>true</code> indicates that the app is allowed to provide 'toast notifications'.</td> </tr> <tr> -<td>deployment-target(string)</td> -<td><mark>iOS</mark> <br/> This sets the IPHONEOS<em>DEPLOYMENT</em>TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings</td> +<td>deployment-target(string) <br/> <mark>iOS</mark></td> +<td>This sets the IPHONEOS<em>DEPLOYMENT</em>TARGET in the build, which ultimately tranlsates to the MinimumOSVersion in the ipa. For more details please refer to Apple's documentation on Deployment Target Settings</td> </tr> <tr> -<td>target-device(string)</td> -<td><em>Default: universal</em> <br/> Allowed values: handset, tablet, universal <br/> <mark>iOS</mark> <br/> This property maps directly to TARGETED<em>DEVICE</em>FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.</td> +<td>target-device(string) <br/> <mark>iOS</mark></td> +<td><em>Default: universal</em> <br/> Allowed values: handset, tablet, universal <br/> This property maps directly to TARGETED<em>DEVICE</em>FAMILY in the xcode project. Note that if you target universal (which is the default) you will need to supply screen shots for both iPhone and iPad or your app may be rejected.</td> </tr> <tr> -<td>windows-phone-target-version(string)</td> -<td><mark>Windows</mark> <br/> Sets the version of Windows Phone for which the package (resulting from <code>cordova build</code>) will target. If none is specified, it will be set to the same version as <code>windows-target-version</code> (if found).</td> +<td>windows-phone-target-version(string) <br/> <mark>Windows</mark></td> +<td>Sets the version of Windows Phone for which the package (resulting from <code>cordova build</code>) will target. If none is specified, it will be set to the same version as <code>windows-target-version</code> (if found).</td> </tr> <tr> -<td>windows-target-version(string)</td> -<td><mark>Windows</mark> <br/> Sets the version of Windows for which the package (resulting from <code>cordova build</code>) will target. If none is specified, it will be set to '8.1'.</td> +<td>windows-target-version(string) <br/> <mark>Windows</mark></td> +<td>Sets the version of Windows for which the package (resulting from <code>cordova build</code>) will target. If none is specified, it will be set to '8.1'.</td> </tr> </tbody></table> <p>Examples:</p> -<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"DisallowOverscroll"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Fullscreen"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"BackgroundColor"</span> <span class="na">value=</span><span class="s">"0xff0000ff"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"HideKeyboardFormAccessoryBar"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Orientation"</span> <span class="na">value=</span><span class="s">"landscape"</span> <span class="nt">/></span> - - <span class="c"><!-- iOS only preferences --></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"EnableViewportScale"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"MediaPlaybackAllowsAirPlay"</span> <span class="na">value=</span><span class="s">"false"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"MediaPlaybackRequiresUserAction"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AllowInlineMediaPlayback"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"BackupWebStorage"</span> <span class="na">value=</span><span class="s">"local"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"TopActivityIndicator"</span> <span class="na">value=</span><span class="s">"white"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"SuppressesIncrementalRendering"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"GapBetweenPages"</span> <span class="na">value=</span><span class="s">"0"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PageLength"</span> <span class="na">value=</span><span class="s">"0"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PaginationBreakingMode"</span> <span class="na">value=</span><span class="s">"page"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PaginationMode"</span> <span class="na">value=</span><span class="s">"unpaginated"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"UIWebViewDecelerationSpeed"</span> <span class="na">value=</span><span class="s">"fast"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ErrorUrl"</span> <span class="na">value=</span><span class="s">"myErrorPage.html"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OverrideUserAgent"</span> <span class="na">value=</span><span class="s">"Mozilla/5.0 My Browser"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AppendUserAgent"</span> <span class="na">value=</span><span class="s">"My Browser"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"target-device"</span> <span class="na">value=</span><span class="s">"universal"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"deployment-target"</span> <span class="na">value=</span><span class="s">"7.0"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"CordovaWebViewEngine"</span> <span class="na">value=</span><span class="s">"CDVUIWebViewEngine"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"SuppressesLongPressGesture"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Suppresses3DTouchGesture"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> - - <span class="c"><!-- Android only preferences --></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"KeepRunning"</span> <span class="na">value=</span><span class="s">"false"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LoadUrlTimeoutValue"</span> <span class="na">value=</span><span class="s">"10000"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"InAppBrowserStorageEnabled"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LoadingDialog"</span> <span class="na">value=</span><span class="s">"My Title,My Message"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ErrorUrl"</span> <span class="na">value=</span><span class="s">"myErrorPage.html"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ShowTitle"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LogLevel"</span> <span class="na">value=</span><span class="s">"VERBOSE"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AndroidLaunchMode"</span> <span class="na">value=</span><span class="s">"singleTop"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"DefaultVolumeStream"</span> <span class="na">value=</span><span class="s">"call"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OverrideUserAgent"</span> <span class="na">value=</span><span class="s">"Mozilla/5.0 My Browser"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AppendUserAgent"</span> <span class="na">value=</span><span class="s">"My Browser"</span> <span class="nt">/></span> - - <span class="c"><!-- Windows only preferences --></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"windows-phone-target-version"</span> <span class="na">value=</span><span class="s">"8.1"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"windows-target-version"</span> <span class="na">value=</span><span class="s">"8.1"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Universal"</span> <span class="na">value=</span><span class="s">"10.0.10240.0"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsDefaultUriPrefix"</span> <span class="na">value=</span><span class="s">"ms-appx://"</span><span class="err">"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Mobile-MaxVersionTested"</span> <span class="na">value=</span><span class="s">"10.0.10031.0"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Universal-MinVersion"</span> <span class="na">value=</span><span class="s">"10.0.0.0"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsStoreIdentityName"</span> <span class="na">value=</span><span class="s">"Cordova.Example.ApplicationDataSample"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsStorePublisherName"</span> <span class="na">value=</span><span class="s">"CN=Contoso Corp, O=Contoso Corp, L=Redmond, S=Washington, C=US"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsToastCapable"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"uap-target-min-version"</span> <span class="na">value=</span><span class="s">"10.0.10586.0"</span> <span class="nt">/></span> - - <span class="c"><!-- BlackBerry only preferences --></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ChildBrowser"</span> <span class="na">value=</span><span class="s">"disable"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PopupBlocker"</span> <span class="na">value=</span><span class="s">"enable"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WebSecurity"</span> <span class="na">value=</span><span class="s">"disable"</span><span class="nt">/></span> - - <span class="c"><!-- OS X only preferences --></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"HideMousePointer"</span> <span class="na">value=</span><span class="s">"5"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OSXLocalStoragePath"</span> <span class="na">value=</span><span class="s">"~/.myapp/database"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowSize"</span> <span class="na">value=</span><span class="s">"800x400"</span><span class="nt">/></span> - <span class="nt"><preference</span> <span class="na">name=</span><span class="s">"EnableWebGL"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><preference</span> <span class="na">name=</span><span class="s">"DisallowOverscroll"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Fullscreen"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"BackgroundColor"</span> <span class="na">value=</span><span class="s">"0xff0000ff"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"HideKeyboardFormAccessoryBar"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Orientation"</span> <span class="na">value=</span><span class="s">"landscape"</span> <span class="nt">/></span> + +<span class="c"><!-- iOS only preferences --></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"EnableViewportScale"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"MediaPlaybackAllowsAirPlay"</span> <span class="na">value=</span><span class="s">"false"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"MediaPlaybackRequiresUserAction"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AllowInlineMediaPlayback"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"BackupWebStorage"</span> <span class="na">value=</span><span class="s">"local"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"TopActivityIndicator"</span> <span class="na">value=</span><span class="s">"white"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"SuppressesIncrementalRendering"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"GapBetweenPages"</span> <span class="na">value=</span><span class="s">"0"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PageLength"</span> <span class="na">value=</span><span class="s">"0"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PaginationBreakingMode"</span> <span class="na">value=</span><span class="s">"page"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PaginationMode"</span> <span class="na">value=</span><span class="s">"unpaginated"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"UIWebViewDecelerationSpeed"</span> <span class="na">value=</span><span class="s">"fast"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ErrorUrl"</span> <span class="na">value=</span><span class="s">"myErrorPage.html"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OverrideUserAgent"</span> <span class="na">value=</span><span class="s">"Mozilla/5.0 My Browser"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AppendUserAgent"</span> <span class="na">value=</span><span class="s">"My Browser"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"target-device"</span> <span class="na">value=</span><span class="s">"universal"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"deployment-target"</span> <span class="na">value=</span><span class="s">"7.0"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"CordovaWebViewEngine"</span> <span class="na">value=</span><span class="s">"CDVUIWebViewEngine"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"SuppressesLongPressGesture"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Suppresses3DTouchGesture"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> + +<span class="c"><!-- Android only preferences --></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"KeepRunning"</span> <span class="na">value=</span><span class="s">"false"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LoadUrlTimeoutValue"</span> <span class="na">value=</span><span class="s">"10000"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"InAppBrowserStorageEnabled"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LoadingDialog"</span> <span class="na">value=</span><span class="s">"My Title,My Message"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ErrorUrl"</span> <span class="na">value=</span><span class="s">"myErrorPage.html"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ShowTitle"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"LogLevel"</span> <span class="na">value=</span><span class="s">"VERBOSE"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AndroidLaunchMode"</span> <span class="na">value=</span><span class="s">"singleTop"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"DefaultVolumeStream"</span> <span class="na">value=</span><span class="s">"call"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OverrideUserAgent"</span> <span class="na">value=</span><span class="s">"Mozilla/5.0 My Browser"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"AppendUserAgent"</span> <span class="na">value=</span><span class="s">"My Browser"</span> <span class="nt">/></span> + +<span class="c"><!-- Windows only preferences --></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"windows-phone-target-version"</span> <span class="na">value=</span><span class="s">"8.1"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"windows-target-version"</span> <span class="na">value=</span><span class="s">"8.1"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Universal"</span> <span class="na">value=</span><span class="s">"10.0.10240.0"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsDefaultUriPrefix"</span> <span class="na">value=</span><span class="s">"ms-appx://"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Mobile-MaxVersionTested"</span> <span class="na">value=</span><span class="s">"10.0.10031.0"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"Windows.Universal-MinVersion"</span> <span class="na">value=</span><span class="s">"10.0.0.0"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsStoreIdentityName"</span> <span class="na">value=</span><span class="s">"Cordova.Example.ApplicationDataSample"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsStorePublisherName"</span> <span class="na">value=</span><span class="s">"CN=Contoso Corp, O=Contoso Corp, L=Redmond, S=Washington, C=US"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowsToastCapable"</span> <span class="na">value=</span><span class="s">"true"</span> <span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"uap-target-min-version"</span> <span class="na">value=</span><span class="s">"10.0.10586.0"</span> <span class="nt">/></span> + +<span class="c"><!-- BlackBerry only preferences --></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"ChildBrowser"</span> <span class="na">value=</span><span class="s">"disable"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"PopupBlocker"</span> <span class="na">value=</span><span class="s">"enable"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WebSecurity"</span> <span class="na">value=</span><span class="s">"disable"</span><span class="nt">/></span> + +<span class="c"><!-- OS X only preferences --></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"HideMousePointer"</span> <span class="na">value=</span><span class="s">"5"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"OSXLocalStoragePath"</span> <span class="na">value=</span><span class="s">"~/.myapp/database"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"WindowSize"</span> <span class="na">value=</span><span class="s">"800x400"</span><span class="nt">/></span> +<span class="nt"><preference</span> <span class="na">name=</span><span class="s">"EnableWebGL"</span> <span class="na">value=</span><span class="s">"true"</span><span class="nt">/></span> </code></pre></div> <h2>feature</h2> <p>If you use the CLI to build applications, you use the plugin command to enable device APIs. This does not modify the top-level config.xml file, so the <feature> element does not apply to your workflow. If you work directly in an SDK and using the platform-specific config.xml file as source, you use the <feature> tag to enable device-level APIs and external plugins. They often appear with custom values in platform-specific config.xml files. See the API Reference for details on how to specify each feature. See - the <a href="../guide/hybrid/plugins/index.html">Plugin Development Guide</a> for more information on plugins. - NOTE: Most of the time, you do NOT want to set this directly.</p> +the <a href="../guide/hybrid/plugins/index.html">Plugin Development Guide</a> for more information on plugins. +NOTE: Most of the time, you do NOT want to set this directly.</p> <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> @@ -3253,37 +3290,37 @@ platform. See <a href="images.html">Cust <table><thead> <tr> -<th>Attributes(type)</th> +<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th> <th>Description</th> </tr> </thead><tbody> <tr> -<td>name(string)</td> -<td><em>Required</em> <br/> Allowed values: android-package, ios-package, osx-package, onload. <br/> <mark>iOS</mark> <mark>OS X</mark> <mark>Android</mark> <br/> 'ios-package', 'osx-package' and 'android-package' are used to specify the name of the package (as specified by the 'value' attribute) to be used to initialize the plugin code, while 'onload' is used to specify whether the corresponding plugin (as specified in the 'value' attribute) is to be instantiated when the controller is initialized.</td> +<td>name(string) <br/> <mark>iOS</mark> <mark>OS X</mark> <mark>Android</mark></td>
[... 147 lines stripped ...] --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org
