cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [05/11] docs commit: Added Android specific preferences
Date Tue, 02 Feb 2016 21:05:38 GMT
Added Android specific preferences


Branch: refs/heads/master
Commit: 72722ff2571db0055fb7ad1e7086dd83b77480fb
Parents: d7099df
Author: Omar Mefire <>
Authored: Wed Jan 27 10:29:55 2016 -0800
Committer: Omar Mefire <>
Committed: Tue Feb 2 12:50:33 2016 -0800

 www/docs/en/dev/config_ref/ | 38 +++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 8 deletions(-)
diff --git a/www/docs/en/dev/config_ref/ b/www/docs/en/dev/config_ref/
index 6a57e0c..9e1fe8e 100644
--- a/www/docs/en/dev/config_ref/
+++ b/www/docs/en/dev/config_ref/
@@ -45,11 +45,6 @@ passively copied into various `platforms/` subdirectories, for example:
-This section details global and cross-platform configuration options.
-See the following sections for platform-specific options:
-- [iOS Configuration](../guide/platforms/ios/config.html)
-- [Android Configuration](../guide/platforms/android/config.html)
 - [BlackBerry 10 Configuration](../guide/platforms/blackberry10/config.html)
 In addition to the various configuration options detailed below, you
@@ -214,8 +209,20 @@ This example shows the default `config.xml` generated by the CLI's
    CordovaWebViewEngine (string) | *Default: CDVUIWebViewEngine* <br/> **Platforms
supported: iOS** <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.
    SuppressesLongPressGesture (boolean) | *Default: false* <br/> **Platforms supported:
iOS** <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.
    Suppresses3DTouchGesture (boolean) | *Default: false* <br/> **Platforms supported:
iOS** <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.
+   KeepRunning (boolean) | *Default: true* <br/> **Platforms supported: Android** <br/>
Determines whether the application stays running in the background even after a [pause](../../../cordova/events/events.pause.html)
event fires. Setting this to false does not kill the app after a [pause](../../../cordova/events/events.pause.html)
event, but simply halts execution of code within the cordova webview while the app is in the
+   LoadUrlTimeoutValue (number in milliseconds) | *Default: 20000, 20 seconds* <br/>
**Platforms supported: Android** <br/> hen loading a page, the amount of time to wait
before throwing a timeout error. 
+   SplashScreen (string) | *Default: splash* <br/> **Platforms supported: Android**
<br/> The name of the file minus its extension in the res/drawable directory. Various
assets must share this common name in various subdirectories.
+   SplashScreenDelay (number in milliseconds) | *Default: 3000, 3 seconds* <br/> **Platforms
supported: Android** <br/> The amount of time the splash screen image displays.
+   InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> **Platforms supported:
Android** <br/> Controls whether pages opened within an InAppBrowser can access the
same localStorage and WebSQL storage as pages opened with the default browser.
+   LoadingDialog (string) | *Default: null* <br/> **Platforms supported: Android**
<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.
+   ErrorUrl (URL) | *Default: null* <br/> **Platforms supported: Android** <br/>
If set, will display the referenced page upon an error in the application instead of a dialog
with the title "Application Error".
+   ShowTitle (boolean) | *Default: false* <br/> **Platforms supported: Android** <br/>
Show the title at the top of the screen.
+   LogLevel (string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG,
VERBOSE <br/> **Platforms supported: Android** <br/> Sets the minimum log level
through which log messages from your application will be filtered.
+   SetFullscreen (boolean) | *Default: false* <br/> **Platforms supported: Android**
<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.
+   AndroidLaunchMode (string) | *Default: singleTop* <br/> Allowed values: standard,
singleTop, singleTask, singleInstance <br/> **Platforms supported: Android** <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. 
+   DefaultVolumeStream (string) | *Default: default* <br/> **Platforms supported: Android**<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.
+   OverrideUserAgent (string) | **Platforms supported: Android** <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.
+   AppendUserAgent (string) | **Platforms supported: Android** <br/> If set, the value
will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this
value will be ignored.
@@ -225,7 +232,7 @@ This example shows the default `config.xml` generated by the CLI's
     <preference name="HideKeyboardFormAccessoryBar" value="true"/>
     <preference name="Orientation" value="landscape" />
-    <!-- iOS only settings -->
+    <!-- iOS only preferences -->
     <preference name="EnableViewportScale" value="true"/>
     <preference name="MediaPlaybackAllowsAirPlay" value="false"/>
     <preference name="MediaPlaybackRequiresUserAction" value="true"/>
@@ -247,6 +254,21 @@ This example shows the default `config.xml` generated by the CLI's
     <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="SplashScreen" value="mySplash"/>
+    <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="DefaultVolumeStream" value="call" />
+    <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
+    <preference name="AppendUserAgent" value="My Browser" />
 ## feature
    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 [Plugin Development Guide](../guide/hybrid/plugins/index.html) for more information
on plugins.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message