Moving dev to 6.x. This closes #537
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/28d8c235 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/28d8c235 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/28d8c235 Branch: refs/heads/master Commit: 28d8c2354bddfee0eb975832a1d9e4458428fc07 Parents: f11e92b Author: Raghav Katyal <[email protected]> Authored: Thu Mar 3 14:58:34 2016 -0800 Committer: Raghav Katyal <[email protected]> Committed: Mon Mar 7 16:04:42 2016 -0800 ---------------------------------------------------------------------- www/_data/redirects.yml | 17 +- www/_data/toc/en-6-x-manual.yml | 160 ++- .../de/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/de/6.x/guide/platforms/wp8/home.md | 27 + www/docs/en/6.x/config_ref/images.md | 265 ++--- www/docs/en/6.x/config_ref/index.md | 499 +++++--- .../en/6.x/cordova/events/events.backbutton.md | 84 -- .../en/6.x/cordova/events/events.deviceready.md | 92 -- .../6.x/cordova/events/events.endcallbutton.md | 81 -- www/docs/en/6.x/cordova/events/events.md | 380 +++++- .../en/6.x/cordova/events/events.menubutton.md | 83 -- www/docs/en/6.x/cordova/events/events.pause.md | 104 -- www/docs/en/6.x/cordova/events/events.resume.md | 117 -- .../6.x/cordova/events/events.searchbutton.md | 82 -- .../cordova/events/events.startcallbutton.md | 82 -- .../cordova/events/events.volumedownbutton.md | 83 -- .../6.x/cordova/events/events.volumeupbutton.md | 83 -- www/docs/en/6.x/cordova/plugins/pluginapis.md | 96 -- www/docs/en/6.x/cordova/storage/storage.md | 23 +- .../en/6.x/gen/cordova-plugin-battery-status.md | 183 +++ www/docs/en/6.x/gen/cordova-plugin-camera.md | 531 +++++++++ www/docs/en/6.x/gen/cordova-plugin-console.md | 109 ++ www/docs/en/6.x/gen/cordova-plugin-contacts.md | 839 ++++++++++++++ .../en/6.x/gen/cordova-plugin-device-motion.md | 186 +++ .../gen/cordova-plugin-device-orientation.md | 220 ++++ www/docs/en/6.x/gen/cordova-plugin-device.md | 293 +++++ www/docs/en/6.x/gen/cordova-plugin-dialogs.md | 283 +++++ .../en/6.x/gen/cordova-plugin-file-transfer.md | 320 ++++++ www/docs/en/6.x/gen/cordova-plugin-file.md | 547 +++++++++ .../en/6.x/gen/cordova-plugin-geolocation.md | 305 +++++ .../en/6.x/gen/cordova-plugin-globalization.md | 941 +++++++++++++++ .../en/6.x/gen/cordova-plugin-inappbrowser.md | 403 +++++++ .../6.x/gen/cordova-plugin-legacy-whitelist.md | 37 + .../en/6.x/gen/cordova-plugin-media-capture.md | 640 +++++++++++ www/docs/en/6.x/gen/cordova-plugin-media.md | 525 +++++++++ .../gen/cordova-plugin-network-information.md | 220 ++++ .../en/6.x/gen/cordova-plugin-splashscreen.md | 181 +++ www/docs/en/6.x/gen/cordova-plugin-statusbar.md | 313 +++++ www/docs/en/6.x/gen/cordova-plugin-vibration.md | 187 +++ www/docs/en/6.x/gen/cordova-plugin-whitelist.md | 158 +++ www/docs/en/6.x/gen/cordova.md | 586 ++++++++++ www/docs/en/6.x/guide/appdev/hooks/index.md | 374 ++++-- www/docs/en/6.x/guide/appdev/whitelist/index.md | 44 +- www/docs/en/6.x/guide/cli/index.md | 494 ++------ www/docs/en/6.x/guide/hybrid/plugins/index.md | 97 +- www/docs/en/6.x/guide/hybrid/webviews/index.md | 3 +- www/docs/en/6.x/guide/next/index.md | 54 +- www/docs/en/6.x/guide/overview/index.md | 148 +-- .../6.x/guide/platforms/amazonfireos/config.md | 84 -- .../6.x/guide/platforms/amazonfireos/index.md | 195 ---- .../6.x/guide/platforms/amazonfireos/plugin.md | 103 -- .../6.x/guide/platforms/amazonfireos/webview.md | 130 --- .../en/6.x/guide/platforms/android/config.md | 125 -- .../en/6.x/guide/platforms/android/index.md | 762 ++++++++++--- .../en/6.x/guide/platforms/android/lifecycle.md | 323 ------ .../en/6.x/guide/platforms/android/plugin.md | 162 +-- .../en/6.x/guide/platforms/android/tools.md | 224 ---- .../en/6.x/guide/platforms/android/upgrade.md | 76 +- .../en/6.x/guide/platforms/blackberry10/home.md | 29 + .../6.x/guide/platforms/blackberry10/index.md | 6 +- .../en/6.x/guide/platforms/firefoxos/index.md | 79 -- www/docs/en/6.x/guide/platforms/index.md | 102 -- www/docs/en/6.x/guide/platforms/ios/config.md | 173 --- www/docs/en/6.x/guide/platforms/ios/index.md | 255 ++--- www/docs/en/6.x/guide/platforms/ios/plugin.md | 42 +- www/docs/en/6.x/guide/platforms/ios/tools.md | 104 -- www/docs/en/6.x/guide/platforms/ios/upgrade.md | 2 +- www/docs/en/6.x/guide/platforms/osx/config.md | 80 ++ www/docs/en/6.x/guide/platforms/osx/index.md | 139 +++ www/docs/en/6.x/guide/platforms/osx/plugin.md | 27 + www/docs/en/6.x/guide/platforms/win8/index.md | 330 +++--- .../en/6.x/guide/platforms/win8/packaging.md | 120 -- www/docs/en/6.x/guide/platforms/win8/plugin.md | 118 +- www/docs/en/6.x/guide/platforms/win8/upgrade.md | 13 +- .../6.x/guide/platforms/win8/win10-support.md | 129 --- www/docs/en/6.x/guide/platforms/wp8/home.md | 27 + www/docs/en/6.x/guide/platforms/wp8/plugin.md | 7 +- www/docs/en/6.x/guide/support/index.md | 92 +- www/docs/en/6.x/index.md | 4 - www/docs/en/6.x/plugin_ref/plugman.md | 86 +- www/docs/en/6.x/plugin_ref/spec.md | 1078 +++++++----------- .../es/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/es/6.x/guide/platforms/wp8/home.md | 27 + .../fr/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/fr/6.x/guide/platforms/wp8/home.md | 27 + .../it/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/it/6.x/guide/platforms/wp8/home.md | 27 + .../ja/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/ja/6.x/guide/platforms/wp8/home.md | 27 + .../ko/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/ko/6.x/guide/platforms/wp8/home.md | 27 + .../pl/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/pl/6.x/guide/platforms/wp8/home.md | 27 + .../ru/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/ru/6.x/guide/platforms/wp8/home.md | 27 + .../sl/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/sl/6.x/guide/platforms/wp8/home.md | 27 + .../zh/6.x/guide/platforms/blackberry10/home.md | 29 + www/docs/zh/6.x/guide/platforms/wp8/home.md | 27 + 99 files changed, 12007 insertions(+), 5331 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/_data/redirects.yml ---------------------------------------------------------------------- diff --git a/www/_data/redirects.yml b/www/_data/redirects.yml index a5397c8..7a60869 100644 --- a/www/_data/redirects.yml +++ b/www/_data/redirects.yml @@ -14,15 +14,14 @@ docs: - {old: "dev/guide/platforms/win8/packaging.html", new: "dev/guide/platforms/win8/index.html#signing-an-app"} - {old: "dev/guide/platforms/win8/win10-support.html", new: "dev/guide/platforms/win8/index.html"} - # To be uncommented when 6.x is released - #- {old: "latest/guide/platforms/android/tools.html", new: "latest/guide/platforms/android/index.html"} - #- {old: "latest/guide/platforms/android/lifecycle.html", new: "latest/guide/platforms/android/index.html#lifecycle-guide"} - #- {old: "latest/guide/platforms/android/config.html", new: "latest/config_ref/index.html"} - #- {old: "latest/guide/platforms/ios/tools.html", new: "latest/guide/platforms/ios/index.html"} - #- {old: "latest/guide/platforms/ios/config.html", new: "latest/config_ref/index.html"} - #- {old: "latest/guide/platforms/win8/packaging.html", new: "latest/guide/platforms/win8/index.html#signing-an-app"} - #- {old: "latest/guide/platforms/win8/win10-support.html", new: "latest/guide/platforms/win8/index.html"} - #- {old: "latest/cordova/plugins/pluginapis.html", new: "deprecated.html"} + - {old: "latest/guide/platforms/android/tools.html", new: "latest/guide/platforms/android/index.html"} + - {old: "latest/guide/platforms/android/lifecycle.html", new: "latest/guide/platforms/android/index.html#lifecycle-guide"} + - {old: "latest/guide/platforms/android/config.html", new: "latest/config_ref/index.html"} + - {old: "latest/guide/platforms/ios/tools.html", new: "latest/guide/platforms/ios/index.html"} + - {old: "latest/guide/platforms/ios/config.html", new: "latest/config_ref/index.html"} + - {old: "latest/guide/platforms/win8/packaging.html", new: "latest/guide/platforms/win8/index.html#signing-an-app"} + - {old: "latest/guide/platforms/win8/win10-support.html", new: "latest/guide/platforms/win8/index.html"} + - {old: "latest/cordova/plugins/pluginapis.html", new: "deprecated.html"} # redirects paths relative to /docs/XX/YYY/ docs-global: http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/_data/toc/en-6-x-manual.yml ---------------------------------------------------------------------- diff --git a/www/_data/toc/en-6-x-manual.yml b/www/_data/toc/en-6-x-manual.yml index c5ff268..8574e97 100644 --- a/www/_data/toc/en-6-x-manual.yml +++ b/www/_data/toc/en-6-x-manual.yml @@ -1,20 +1,140 @@ -- {name: !!python/unicode 'Guides', url: !!python/unicode ''} -- {name: !!python/unicode 'Overview', url: !!python/unicode 'guide/overview/index.html'} -- {name: !!python/unicode 'Platform Support', url: !!python/unicode 'guide/support/index.html'} -- {name: !!python/unicode 'The Command-Line Interface', url: !!python/unicode 'guide/cli/index.html'} -- {name: !!python/unicode 'Platform Guides', url: !!python/unicode 'guide/platforms/index.html'} -- {name: !!python/unicode 'Using Plugman to Manage Plugins', url: !!python/unicode 'plugin_ref/plugman.html'} -- {name: !!python/unicode 'The config.xml File', url: !!python/unicode 'config_ref/index.html'} -- {name: !!python/unicode 'Icons and Splash Screens', url: !!python/unicode 'config_ref/images.html'} -- {name: !!python/unicode 'Embedding WebViews', url: !!python/unicode 'guide/hybrid/webviews/index.html'} -- {name: !!python/unicode 'Plugin Development Guide', url: !!python/unicode 'guide/hybrid/plugins/index.html'} -- {name: !!python/unicode 'Plugin Specification', url: !!python/unicode 'plugin_ref/spec.html'} -- {name: !!python/unicode 'Privacy Guide', url: !!python/unicode 'guide/appdev/privacy/index.html'} -- {name: !!python/unicode 'Security Guide', url: !!python/unicode 'guide/appdev/security/index.html'} -- {name: !!python/unicode 'Platforms and Plugins Version Management', url: !!python/unicode 'platform_plugin_versioning_ref/index.html'} -- {name: !!python/unicode 'Whitelist Guide', url: !!python/unicode 'guide/appdev/whitelist/index.html'} -- {name: !!python/unicode 'Storage', url: !!python/unicode 'cordova/storage/storage.html'} -- {name: !!python/unicode 'Hooks Guide', url: !!python/unicode 'guide/appdev/hooks/index.html'} -- {name: !!python/unicode 'Next Steps', url: !!python/unicode 'guide/next/index.html'} -- {name: !!python/unicode 'Events', url: !!python/unicode 'cordova/events/events.html'} -- {name: !!python/unicode 'Plugin APIs', url: !!python/unicode 'cordova/plugins/pluginapis.html'} +- name: "Introduction" + children: + - name: "Overview" + url: "guide/overview/index.html" +# - name: "Runtime Architecture" +# url: +# - name: "Tooling Architecture" +# url: +- name: "Create apps" + children: + - name: "Create your first app" + url: "guide/cli/index.html" + - name: "Platform support" + url: "guide/support/index.html" + - name: "Develop for platforms" + children: + - name: "Android" + url: "guide/platforms/android/index.html" + - name: "Blackberry 10" + url: "guide/platforms/blackberry10/home.html" + - name: "iOS" + url: "guide/platforms/ios/index.html" + - name: "OS X" + url: "guide/platforms/osx/index.html" + - name: "Ubuntu" + url: "guide/platforms/ubuntu/index.html" + - name: "Windows" + url: "guide/platforms/win8/index.html" + - name: "WP8" + url: "guide/platforms/wp8/home.html" + - name: "Manage versions and platforms" + url: "platform_plugin_versioning_ref/index.html" + - name: "Debug and test" + url: + - name: "Customize icons" + url: "config_ref/images.html" + - name: "Automate Tasks" + url: + - name: "Store data" + url: "cordova/storage/storage.html" + - name: "Manage privacy" + url: "guide/appdev/privacy/index.html" + - name: "Manage security" + url: "guide/appdev/security/index.html" + - name: "Whitelisting" + url: "guide/appdev/whitelist/index.html" + - name: "Publish" + url: +- name: "Create plugins" + children: + - name: "Create a plugin" + url: "guide/hybrid/plugins/index.html" + - name: "Register with NPM" + url: + - name: "Develop for platforms" + children: + - name: "Android" + url: "guide/platforms/android/plugin.html" + - name: "Blackberry 10" + url: "guide/platforms/blackberry10/plugin.html" + - name: "iOS" + url: "guide/platforms/ios/plugin.html" + - name: "Windows" + url: "guide/platforms/win8/plugin.html" + - name: "WP8" + url: "guide/platforms/wp8/plugin.html" + - name: "Use Plugman" + url: "plugin_ref/plugman.html" + - name: "Debug and test" + url: +- name: "Advanced Topics" + children: + - name: "Embed Cordova in native apps" + url: "guide/hybrid/webviews/index.html" + - name: "Pass data from Cordova app to host" + url: + - name: "Next Steps" + url: "guide/next/index.html" +- name: "Reference" + children: + - name: "Config.xml" + url: "config_ref/index.html" + - name: "Events" + url: "cordova/events/events.html" + - name: "CLI" + url: "cordova-cli/index.html" + - name: "Hooks" + url: "guide/appdev/hooks/index.html" + - name: "Plugin.xml" + url: "plugin_ref/spec.html" + - name: "Plugin APIs" + children: + - name: Battery Status + url: "cordova-plugin-battery-status/index.html" + - name: Camera + url: "cordova-plugin-camera/index.html" + - name: Console + url: "cordova-plugin-console/index.html" + - name: Contacts + url: "cordova-plugin-contacts/index.html" + - name: Device + url: "cordova-plugin-device/index.html" + - name: Device Motion + url: "cordova-plugin-device-motion/index.html" + - name: Device Orientation + url: "cordova-plugin-device-orientation/index.html" + - name: Dialogs + url: "cordova-plugin-dialogs/index.html" + - name: File + url: "cordova-plugin-file/index.html" + - name: File Transfer + url: "cordova-plugin-file-transfer/index.html" + - name: Geolocation + url: "cordova-plugin-geolocation/index.html" + - name: Globalization + url: "cordova-plugin-globalization/index.html" + - name: Inappbrowser + url: "cordova-plugin-inappbrowser/index.html" + - name: Media + url: "cordova-plugin-media/index.html" + - name: Media Capture + url: "cordova-plugin-media-capture/index.html" + - name: Network Information + url: "cordova-plugin-network-information/index.html" + - name: Splashscreen + url: "cordova-plugin-splashscreen/index.html" + - name: Vibration + url: "cordova-plugin-vibration/index.html" + - name: Statusbar + url: "cordova-plugin-statusbar/index.html" + - name: Whitelist + url: "cordova-plugin-whitelist/index.html" + - name: Legacy Whitelist + url: "cordova-plugin-legacy-whitelist/index.html" +# - name: "Tutorials" +# children: +# - name: "Share your app in source control" +# url: +- name: "Sample Apps" + url: http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/de/6.x/guide/platforms/blackberry10/home.md ---------------------------------------------------------------------- diff --git a/www/docs/de/6.x/guide/platforms/blackberry10/home.md b/www/docs/de/6.x/guide/platforms/blackberry10/home.md new file mode 100644 index 0000000..bae3ba2 --- /dev/null +++ b/www/docs/de/6.x/guide/platforms/blackberry10/home.md @@ -0,0 +1,29 @@ +--- +license: > + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +title: Blackberry 10 Guides +--- + +# Blackberry 10 Guides + +* [BlackBerry 10 Platform Guide](index.html) +* [BlackBerry 10 Shell Tool Guide](tools.html) +* [BlackBerry 10 Configuration](config.html) +* [BlackBerry 10 Plugins](plugin.html) +* [Upgrading BlackBerry 10](upgrade.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/de/6.x/guide/platforms/wp8/home.md ---------------------------------------------------------------------- diff --git a/www/docs/de/6.x/guide/platforms/wp8/home.md b/www/docs/de/6.x/guide/platforms/wp8/home.md new file mode 100644 index 0000000..226958c --- /dev/null +++ b/www/docs/de/6.x/guide/platforms/wp8/home.md @@ -0,0 +1,27 @@ +--- +license: > + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +title: WP8 Guides +--- + +# WP8 Guides + +* [Windows Phone 8 Platform Guide](index.html) +* [Windows Phone 8 Plugins](plugin.html) +* [Upgrading Windows Phone 8](upgrade.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/en/6.x/config_ref/images.md ---------------------------------------------------------------------- diff --git a/www/docs/en/6.x/config_ref/images.md b/www/docs/en/6.x/config_ref/images.md index 5d81eca..22722d1 100644 --- a/www/docs/en/6.x/config_ref/images.md +++ b/www/docs/en/6.x/config_ref/images.md @@ -17,190 +17,135 @@ license: > specific language governing permissions and limitations under the License. -title: Icons and Splash Screens +title: Customize app icons +description: Learn how to customize icons for your Cordova app --- -# Icons and Splash Screens +# Customize Icons -This section shows how to configure an app's icon and optional splash -screen for various platforms, both when working in the Cordova CLI -(described in The Command-Line Interface) or using platform-specific -SDK tools (detailed in the Platform Guides). +This section shows how to configure an app's icon for various platforms. Support for splash screen has moved to a Cordova plugin of its own. The configuration options can be found in the [Splashscreen plugin docs][splashscreen_plugin]. ## Configuring Icons in the CLI When working in the CLI you can define app icon(s) via `<icon>` element (`config.xml`). If you do not specify an icon then the Apache Cordova logo is used. - <icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" /> +```xml + <icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" /> +``` -src: (required) specifies the location of the image file, relative to your project directory +Attributes | Description +--------------|-------------------------------------------------------------------------------- +src | *Required* <br/> Location of the image file, relative to your project directory +platform | *Optional* <br/> Target platform +width | *Optional* <br/> Icon width in pixels +height | *Optional* <br/> Icon height in pixels +density | *Optional* <br/> Specified icon density (Android Specific) -platform: (optional) target platform - -width: (optional) icon width in pixels - -height: (optional) icon height in pixels - -density: (optional) android specific, specifies icon density The following configuration can be used to define single default icon which will be used for all platforms. - - <icon src="res/icon.png" /> - +```xml + <icon src="res/icon.png" /> +``` For each platform you can also define a pixel-perfect icons set to fit different screen resolutions. -Amazon Fire OS - - <platform name="amazon-fireos"> - <icon src="res/android/ldpi.png" density="ldpi" /> - <icon src="res/android/mdpi.png" density="mdpi" /> - <icon src="res/android/hdpi.png" density="hdpi" /> - <icon src="res/android/xhdpi.png" density="xhdpi" /> - </platform> - -Android - - <platform name="android"> - <icon src="res/android/ldpi.png" density="ldpi" /> - <icon src="res/android/mdpi.png" density="mdpi" /> - <icon src="res/android/hdpi.png" density="hdpi" /> - <icon src="res/android/xhdpi.png" density="xhdpi" /> - </platform> - -BlackBerry10 - - <platform name="blackberry10"> - <icon src="res/bb10/icon-86.png" /> - <icon src="res/bb10/icon-150.png" /> - </platform> - -See BlackBerry's documentation for targeting multiple sizes and locales. -[http://developer.blackberry.com/html5/documentation/icon_element.html] - -Firefox OS - - <platform name="firefoxos"> - <icon src="res/ff/logo.png" width="60" height="60" /> - </platform> - -iOS - - <platform name="ios"> - <!-- iOS 8.0+ --> - <!-- iPhone 6 Plus --> - <icon src="res/ios/[email protected]" width="180" height="180" /> - <!-- iOS 7.0+ --> - <!-- iPhone / iPod Touch --> - <icon src="res/ios/icon-60.png" width="60" height="60" /> - <icon src="res/ios/[email protected]" width="120" height="120" /> - <!-- iPad --> - <icon src="res/ios/icon-76.png" width="76" height="76" /> - <icon src="res/ios/[email protected]" width="152" height="152" /> - <!-- iOS 6.1 --> - <!-- Spotlight Icon --> - <icon src="res/ios/icon-40.png" width="40" height="40" /> - <icon src="res/ios/[email protected]" width="80" height="80" /> - <!-- iPhone / iPod Touch --> - <icon src="res/ios/icon.png" width="57" height="57" /> - <icon src="res/ios/[email protected]" width="114" height="114" /> - <!-- iPad --> - <icon src="res/ios/icon-72.png" width="72" height="72" /> - <icon src="res/ios/[email protected]" width="144" height="144" /> - <!-- iPhone Spotlight and Settings Icon --> - <icon src="res/ios/icon-small.png" width="29" height="29" /> - <icon src="res/ios/[email protected]" width="58" height="58" /> - <!-- iPad Spotlight and Settings Icon --> - <icon src="res/ios/icon-50.png" width="50" height="50" /> - <icon src="res/ios/[email protected]" width="100" height="100" /> - </platform> - -Windows Phone8 - - <platform name="wp8"> - <icon src="res/wp/ApplicationIcon.png" width="99" height="99" /> - <!-- tile image --> - <icon src="res/wp/Background.png" width="159" height="159" /> - </platform> - -Windows8 - - <platform name="windows8"> - <icon src="res/windows8/logo.png" width="150" height="150" /> - <icon src="res/windows8/smalllogo.png" width="30" height="30" /> - <icon src="res/windows8/storelogo.png" width="50" height="50" /> - </platform> - -## Configuring Splash Screens in the CLI - -In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here. - -# Example configuration - -Please notice that the value of the "src" attribute is relative to the project directory and not to the www directory. -You can name the source image whatever you like. The internal name in the app are determined by Cordova. - +##Android +```xml <platform name="android"> - <!-- you can use any density that exists in the Android project --> - <splash src="res/screen/android/splash-land-hdpi.png" density="land-hdpi"/> - <splash src="res/screen/android/splash-land-ldpi.png" density="land-ldpi"/> - <splash src="res/screen/android/splash-land-mdpi.png" density="land-mdpi"/> - <splash src="res/screen/android/splash-land-xhdpi.png" density="land-xhdpi"/> - - <splash src="res/screen/android/splash-port-hdpi.png" density="port-hdpi"/> - <splash src="res/screen/android/splash-port-ldpi.png" density="port-ldpi"/> - <splash src="res/screen/android/splash-port-mdpi.png" density="port-mdpi"/> - <splash src="res/screen/android/splash-port-xhdpi.png" density="port-xhdpi"/> + <!-- + ldpi : 36x36 px + mdpi : 48x48 px + hdpi : 72x72 px + xhdpi : 96x96 px + xxhdpi : 144x144 px + xxxhdpi : 192x192 px + --> + <icon src="res/android/ldpi.png" density="ldpi" /> + <icon src="res/android/mdpi.png" density="mdpi" /> + <icon src="res/android/hdpi.png" density="hdpi" /> + <icon src="res/android/xhdpi.png" density="xhdpi" /> + <icon src="res/android/xxhdpi.png" density="xxhdpi" /> + <icon src="res/android/xxxhdpi.png" density="xxxhdpi" /> </platform> +``` +###See Also +- [Android icon guide](https://www.google.com/design/spec/style/icons.html) +- [Android - Supporting multiple screens](http://developer.android.com/guide/practices/screens_support.html) - <platform name="ios"> - <!-- images are determined by width and height. The following are supported --> - <splash src="res/screen/ios/Default~iphone.png" width="320" height="480"/> - <splash src="res/screen/ios/Default@2x~iphone.png" width="640" height="960"/> - <splash src="res/screen/ios/Default-Portrait~ipad.png" width="768" height="1024"/> - <splash src="res/screen/ios/Default-Portrait@2x~ipad.png" width="1536" height="2048"/> - <splash src="res/screen/ios/Default-Landscape~ipad.png" width="1024" height="768"/> - <splash src="res/screen/ios/Default-Landscape@2x~ipad.png" width="2048" height="1536"/> - <splash src="res/screen/ios/Default-568h@2x~iphone.png" width="640" height="1136"/> - <splash src="res/screen/ios/Default-667h.png" width="750" height="1334"/> - <splash src="res/screen/ios/Default-736h.png" width="1242" height="2208"/> - <splash src="res/screen/ios/Default-Landscape-736h.png" width="2208" height="1242"/> +##BlackBerry10 +```xml + <platform name="blackberry10"> + <icon src="res/bb10/icon-86.png" /> + <icon src="res/bb10/icon-150.png" /> </platform> +``` +###See Also +- [BlackBerry's documentation][blackberry_icon] for targeting multiple sizes and locales. - <platform name="wp8"> - <!-- images are determined by width and height. The following are supported --> - <splash src="res/screen/wp8/SplashScreenImage.jpg" width="768" height="1280"/> +##iOS +```xml + <platform name="ios"> + <!-- iOS 8.0+ --> + <!-- iPhone 6 Plus --> + <icon src="res/ios/[email protected]" width="180" height="180" /> + <!-- iOS 7.0+ --> + <!-- iPhone / iPod Touch --> + <icon src="res/ios/icon-60.png" width="60" height="60" /> + <icon src="res/ios/[email protected]" width="120" height="120" /> + <!-- iPad --> + <icon src="res/ios/icon-76.png" width="76" height="76" /> + <icon src="res/ios/[email protected]" width="152" height="152" /> + <!-- iOS 6.1 --> + <!-- Spotlight Icon --> + <icon src="res/ios/icon-40.png" width="40" height="40" /> + <icon src="res/ios/[email protected]" width="80" height="80" /> + <!-- iPhone / iPod Touch --> + <icon src="res/ios/icon.png" width="57" height="57" /> + <icon src="res/ios/[email protected]" width="114" height="114" /> + <!-- iPad --> + <icon src="res/ios/icon-72.png" width="72" height="72" /> + <icon src="res/ios/[email protected]" width="144" height="144" /> + <!-- iPhone Spotlight and Settings Icon --> + <icon src="res/ios/icon-small.png" width="29" height="29" /> + <icon src="res/ios/[email protected]" width="58" height="58" /> + <!-- iPad Spotlight and Settings Icon --> + <icon src="res/ios/icon-50.png" width="50" height="50" /> + <icon src="res/ios/[email protected]" width="100" height="100" /> </platform> - - <platform name="windows8"> - <!-- images are determined by width and height. The following are supported --> - <splash src="res/screen/windows8/splashscreen.png" width="620" height="300"/> +``` +###See Also +- [App icon and image size guidelines](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/MobileHIG/IconMatrix.html) + +##Windows +```xml + <platform name="windows"> + <icon src="res/windows/logo.png" width="150" height="150" /> + <icon src="res/windows/smalllogo.png" width="30" height="30" /> + <icon src="res/windows/storelogo.png" width="50" height="50" /> + <icon src="res/Windows/Square44x44Logo.scale-100.png" width="44" height="44" /> + <icon src="res/Windows/Square44x44Logo.scale-240.png" width="106" height="106" /> + <icon src="res/Windows/Square70x70Logo.scale-100.png" width="70" height="70" /> + <icon src="res/Windows/Square71x71Logo.scale-100.png" width="71" height="71" /> + <icon src="res/Windows/Square71x71Logo.scale-240.png" width="170" height="170" /> + <icon src="res/Windows/Square150x150Logo.scale-240.png" width="360" height="360" /> + <icon src="res/Windows/Square310x310Logo.scale-100.png" width="310" height="310" /> + <icon src="res/Windows/Wide310x150Logo.scale-100.png" width="310" height="150" /> + <icon src="res/Windows/Wide310x150Logo.scale-240.png" width="744" height="360" /> </platform> +``` +###See Also: +- [Windows platform guidelines for icons](https://msdn.microsoft.com/en-us/library/windows/apps/mt412102.aspx). - <platform name="blackberry10"> - <!-- Add a rim:splash element for each resolution and locale you wish --> - <!-- http://developer.blackberry.com/html5/documentation/rim_splash_element.html --> - <rim:splash src="res/screen/windows8/splashscreen.png"/> +##Windows Phone 8 (WP8 Platform) +```xml + <platform name="wp8"> + <icon src="res/wp/ApplicationIcon.png" width="99" height="99" /> + <!-- tile image --> + <icon src="res/wp/Background.png" width="159" height="159" /> </platform> +``` - - <preference name="SplashScreenDelay" value="10000" /> - -# Supported platforms - -As of now (Cordova 3.5.0 July 2014) the following platforms support splash screens. - - android - ios - wp8 - windows8 - blackberry10 - -# Splashscreen Plugin - - Apache Cordova also offers special splash screen plugin which could be used to programmatically display and hide a splash screen during application launch - https://github.com/apache/cordova-plugin-splashscreen - - +[blackberry_icon]: http://developer.blackberry.com/html5/documentation/icon_element.html +[splashscreen_plugin]: ../cordova-plugin-splashscreen/ \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/en/6.x/config_ref/index.md ---------------------------------------------------------------------- diff --git a/www/docs/en/6.x/config_ref/index.md b/www/docs/en/6.x/config_ref/index.md index 9371315..7f7bd38 100644 --- a/www/docs/en/6.x/config_ref/index.md +++ b/www/docs/en/6.x/config_ref/index.md @@ -17,20 +17,20 @@ license: > specific language governing permissions and limitations under the License. -title: The config.xml File +title: Config.xml --- -# The config.xml File +# Config.xml -Many aspects of an app's behavior can be controlled with a global -configuration file, `config.xml`. This +Config.xml is a global configuration file that controls many aspects +of a cordova application's behavior. This platform-agnostic XML file is arranged based on the W3C's [Packaged Web Apps (Widgets)](http://www.w3.org/TR/widgets/) specification, and extended to specify core Cordova API features, plugins, and platform-specific settings. -For projects created with the Cordova CLI (described in The -Command-Line Interface), this file can be found in the top-level +For projects created with the Cordova CLI (described in [The +Command-Line Interface](../guide/cli/index.html)), this file can be found in the top-level directory: app/config.xml @@ -39,222 +39,383 @@ Note that before version 3.3.1-0.2.0, the file existed at `app/www/config.xml`, and that having it here is still supported. When using the CLI to build a project, versions of this file are -passively copied into various `platforms/` subdirectories, for example: +passively copied into various `platforms/` subdirectories. +For example: app/platforms/ios/AppName/config.xml app/platforms/blackberry10/www/config.xml app/platforms/android/res/xml/config.xml -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 can also configure an application's core set of images for each target -platform. See [Icons and Splash Screens](images.html) for more information. +platform. See [Customize icons topic](images.html) for more information. -## Core Configuration Elements +# widget + Root element of the config.xml document. -This example shows the default `config.xml` generated by the CLI's -`create` command, described in [The Command-Line Interface](../guide/cli/index.html): + Attributes(type) | Description + ---------------- | ------------ + id(string) | *Required* <br/> Specifies the app's reverse-domain identifier, and the `version` its full version number expressed in major/minor/patch notation. + version(string) | *Required* <br/> Full version number expressed in major/minor/patch notation. + versionCode(string) | ==Android== <br/> Alternative version for Android. For further details, see [Android versioning](http://developer.android.com/tools/publishing/versioning.html) + ios-CFBundleVersion(string) | ==iOS== <br/> Alternative version for iOS. For further details, see [iOS versioning](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). + osx-CFBundleVersion(string) | ==OS X== <br/> Alternative version for OS X. For further details, see [OS X versioning](https://developer.apple.com/library/prerelease/mac/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). + packageVersion(string) | ==Windows== <br/> Alternative version for Windows. For futher details, see [Windows versioning](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx) + packageName(string) | *Default: Cordova.Example* <br/> ==Windows== <br/> Package name for Windows. + xmlns(string) | *Required* <br/> Namespace for the config.xml document. + xmlns:cdv(string) | *Required* <br/> Namespace prefix. - <widget id="com.example.hello" version="0.0.1"> - <name>HelloWorld</name> - <description> - A sample Apache Cordova application that responds to the deviceready event. - </description> - <author email="[email protected]" href="http://cordova.io";> - Apache Cordova Team - </author> - <content src="index.html" /> - <access origin="*" /> - </widget> + Examples: -The following configuration elements appear in the top-level -`config.xml` file, and are supported across all supported Cordova -platforms: + <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets"; xmlns:cdv="http://cordova.apache.org/ns/1.0";> + </widget> -- The `<widget>` element's `id` attribute provides the app's - reverse-domain identifier, and the `version` its full version number - expressed in major/minor/patch notation. + <!-- Android --> + <widget versionCode="0.1.3"> + </widget> - The widget tag can also have attributes that specify alternative versions, - namely `versionCode` for Android, `CFBundleVersion` for iOS, and - `packageVersion` for Windows. See the Additional Versioning section below - for details. + <!-- iOS --> + <widget ios-CFBundleVersion="0.1.3"> + </widget> -- The `<name>` element specifies the app's formal name, as it appears - on the device's home screen and within app-store interfaces. + <!-- Windows --> + <widget packageVersion="0.1.3"> + </widget> -- The `<description>` and `<author>` elements specify metadata and - contact information that may appear within app-store listings. + <!-- OS X --> + <widget osx-CFBundleVersion="0.1.3"> + </widget> -- The optional `<content>` element 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 - `www` directory. +## name + Specifies the app's formal name, as it appears on the device's home screen and within app-store interfaces. -- `<access>` elements define 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 [Whitelist Guide](../guide/appdev/whitelist/index.html) for details. + Examples: -- The `<preference>` tag sets various options as pairs of - `name`/`value` attributes. Each preference's `name` is - case-insensitive. Many preferences are unique to specific - platforms, as listed at the top of this page. The following sections - detail preferences that apply to more than one platform. + <widget ...> + <name>HelloCordova</name> + </widget> -### Additional Versioning +## description + Specifies metadata that may appear within app-store listings. -Android, iOS, and Windows support a second version string (or number) in -addition to the one visible in app stores: + Examples: -- [versionCode](http://developer.android.com/tools/publishing/versioning.html) - for Android -- [CFBundleVersion](http://stackoverflow.com/questions/4933093/cfbundleversion-in-the-info-plist-upload-error) - for iOS -- [packageVersion](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx) - for Windows + <widget ...> + <description>A sample Apache Cordova application</description> + </widget> -Below is an example that explicitly sets these properties: - <widget id="io.cordova.hellocordova" - version="0.0.1" - android-versionCode="7" - ios-CFBundleVersion="3.3.3" - windows-packageVersion="1.0.1.2"> +## author + Specifies contact information that may appear within app-store lisitngs. -If alternative version is not specified, the following -defaults will be used: + Attributes(type) | Description + ----------------- | ------------ + email(string) | *Required* <br/> Email of the author. + href(string) | *Required* <br/> Website of the author. - // assuming version = MAJOR.MINOR.PATCH-whatever - versionCode = PATCH + MINOR * 100 + MAJOR * 10000 - CFBundleVersion = "MAJOR.MINOR.PATCH" - packageVersion = "MAJOR.MINOR.PATCH.0" + Examples: -## Global Preferences + <widget ...> + <author email="[email protected]" href="http://cordova.io";></author> + </widget> -The following global preferences apply to all platforms: -- `Fullscreen` allows you to hide the status bar at the top of the - screen. The default value is `false`. Example: +## content + 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 ```www``` directory. - <preference name="Fullscreen" value="true" /> + Attributes(type) | Description + ----------------- | ------------ + src(string) | *Required* <br/> 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 ```www``` directory. -## Multi-Platform Preferences + Examples: -The following preferences apply to more than one platform, but not to -all of them: + <widget ...> + <content src="startPage.html"></content> + </widget> -- `DisallowOverscroll` (boolean, defaults to `false`): set to `true` - if you don't want the interface to display any feedback when users - scroll past the beginning or end of content. - <preference name="DisallowOverscroll" value="true"/> +## access + 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 [Whitelist Guide](../guide/appdev/whitelist/index.html) for details. + + Attributes(type) | Description + ----------------- | ------------ + origin(string) | *Required* <br/> 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 [Whitelist Guide](../guide/appdev/whitelist/index.html) for details. + + Examples: + + <widget ...> + <access origin="*"></content> + </widget> + + <widget ...> + <access origin="http://google.com";></content> + </widget> + + +## allow-navigation + Controls which URLs the WebView itself can be navigated to. Applies to top-level navigations only. + + Attributes(type) | Description + ----------------- | ------------ + href(string) | *Required* <br/> Defines the set of external domains the WebView is allowed to navigate to. + See the cordova-plugin-whitelist [cordova-plugin-whitelist](../cordova-plugin-whitelist/index.html#navigation-whitelist) for details. + + Examples: + + <!-- Allow links to example.com --> + <allow-navigation href="http://example.com/*"; /> + + <!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path --> + <allow-navigation href="*://*.example.com/*" /> + +## allow-intent + Controls which URLs the app is allowed to ask the system to open. By default, no external URLs are allowed. + + Attributes(type) | Description + ----------------- | ------------ + href(string) | *Required* <br/> Defines which URLs the app is allowed to ask the system to open. + See the cordova-plugin-whitelist [cordova-plugin-whitelist](../cordova-plugin-whitelist/index.html#intent-whitelist) for details. + + Examples: + + <allow-intent href="http://*/*"; /> + <allow-intent href="https://*/*"; /> + <allow-intent href="tel:*" /> + <allow-intent href="sms:*" /> + +## engine + Specifies what platform to restore during a prepare. For more details, see the [Platforms & Plugins Version Management](../platform_plugin_versioning_ref/index.html). + + Attributes(type) | Description + ----------------- | ------------ + name(string) | *Required* <br/> Name of the platform to be restored + spec(string) | *Required* <br/> Version of the platform to be restored + + Examples: + + <engine name="android" spec="^4.0.0" /> + +## preference + 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. + + Attributes(type) | Description + ----------------- | ------------ + AllowInlineMediaPlayback(boolean) | *Default: false* <br/> ==iOS== <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 ```<video>``` elements. + AndroidLaunchMode(string) | *Default: singleTop* <br/> Allowed values: standard, singleTop, singleTask, singleInstance <br/> ==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. + android-maxSdkVersion(integer) | *Default: Not Specified* <br/> ==Android== <br/> Sets the `maxSdkVersion` attribute of the `<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]). + android-minSdkVersion(integer) | *Default: Dependent on cordova-android Version* <br/> ==Android== <br/> Sets the `minSdkVersion` attribute of the `<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]). + android-targetSdkVersion(integer) | *Default: Dependent on cordova-android Version* <br/> ==Android== <br/> Sets the `targetSdkVersion` attribute of the `<uses-sdk>` tag in the project's `AndroidManifest.xml` (see [here][uses-sdk]). + AppendUserAgent(string) | ==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. + AppendUserAgent(string) | ==iOS== <br/> If set, the value will append to the end of old UserAgent of webview. When using with OverrideUserAgent, this value will be ignored. + BackgroundColor(string) | ==Android== ==BlackBerry== ==Windows== <br/> Supports a four-byte hex value, with the first byte representing the alpha channel, and standard RGB values for the following three bytes. + BackupWebStorage(string) | *Default: cloud* <br/> Allowed values: none, local, cloud. <br/> ==iOS== <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. + ChildBrowser(string) | *Default: enable* <br/> ==BlackBerry== <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. + CordovaWebViewEngine(string) | *Default: CDVUIWebViewEngine* <br/> ==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. + DefaultVolumeStream(string) | *Default: default* <br/> ==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. + DisallowOverscroll(boolean) | *Default: false* <br/> ==iOS== ==Android== <br/> Set to **true** 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/> + EnableViewportScale(boolean) | *Default: false* <br/> ==iOS== <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/> ```<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />``` + EnableWebGL(boolean) | *Default: false* <br/> ==OS X **4.0.0**== <br/> Set to true to enable WebGL on the web view. + ErrorUrl(URL) | *Default: null* <br/> ==Android== <br/> If set, will display the referenced page upon an error in the application instead of a dialog with the title "Application Error". + ErrorUrl(string) | ==iOS== <br/> If set, will display the referenced local page upon an error in the application. + FullScreen(boolean) | *Default: false* <br/> Allows you to hide the status bar at the top of the screen. + GapBetweenPages(float) | *Default: 0* <br/> ==iOS== <br/> The size of the gap, in points, between pages. + HideKeyboardFormAccessoryBar(boolean) | *Default: false* <br/> ==BlackBerry== <br/> Set to true to hide the additional toolbar that appears above the keyboard, helping users navigate from one form input to another. + HideMousePointer(integer) | *Default: -1* <br/> ==OS X **4.0.0**== <br/> Sets the timeout for hiding the mouse pointer. Set to 0 for immediate, set to -1 for never. + InAppBrowserStorageEnabled (boolean) | *Default: true* <br/> ==Android== <br/> Controls whether pages opened within an InAppBrowser can access the same localStorage and WebSQL storage as pages opened with the default browser. + KeepRunning(boolean) | *Default: true* <br/> ==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 background. + KeyboardDisplayRequiresUserAction(boolean) | *Default: true* <br/> ==iOS== <br/> Set to false to allow the keyboard to appear when calling focus() on form inputs. + LoadUrlTimeoutValue(number in milliseconds) | *Default: 20000, 20 seconds* <br/> ==Android== <br/> When loading a page, the amount of time to wait before throwing a timeout error. + LoadingDialog(string) | *Default: null* <br/> ==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. + LogLevel(string) | *Default: ERROR* <br/> Allowed values: ERROR, WARN, INFO, DEBUG, VERBOSE <br/> ==Android== <br/> Sets the minimum log level through which log messages from your application will be filtered. + MediaPlaybackAllowsAirPlay(boolean) | *Default: true* <br/> ==iOS== <br/> Set to false to prevent Air Play from being used in this view. Available in default UIWebView and WKWebView. + MediaPlaybackRequiresUserAction(boolean) | *Default: false* <br/> ==iOS== <br/> Set to true to prevent HTML5 videos or audios from playing automatically with the autoplay attribute or via JavaScript. + Min/Max Version(Regex) | ==Windows== <br/> Allowed values: **/(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i** <br/> Identifies the ecosystems and their min/max versions the app is compatible with. There are three parts to each value: the **SDK**, the **version restriction**, and the **version value**. These preferences are detected by beginning with `Windows` or `Microsoft` and ending in `-MinVersion` or `-MaxVersionTested`: <ul><li>The **SDK** defines what specialized platform you want to target. The default is `Windows.Universal`. Valid values for these are defined in the AppxManifest schema, in the `Package/Depednencies/TargetPlatform` elements.</li><li>The **version restriction** defines application compatibility rules. For example, if the `-MinVersion` is set to 10.1.0.0, then OS versions which don't support at least 10.1.0.0 of the corresponding SDK won't be able to load it. Similarly you can also use `-MaxVersionTested` which specifies the hig hest-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 **version value** is a 4-integer tuple in the form of *major.minor.build.qfe*.</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. + Orientation(string) | *Default: default* <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/> **NOTE:** 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'. + OSXLocalStoragePath(string) | ==OS X **4.0.0**== <br/> *Default: `~/Library/Application Support/{bundle.id}`* <br/> Sets the directory for the local storage path. + OverrideUserAgent(string) | ==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. + PageLength(float) | *Default: 0* <br/> ==iOS== <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. + PaginationBreakingMode(string) | *Default: page* <br/> Allowed values: page, column <br/> ==iOS== <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. + PaginationMode(string) | *Default: unpaginated* <br/> Allowed values: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft <br/> ==iOS== <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. + PopupBlocker(string) | *Default: enable* <br/> ==BlackBerry== <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. + SetFullscreen(boolean) | *Default: false* <br/> ==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. + ShowTitle(boolean) | *Default: false* <br/> ==Android== <br/> Show the title at the top of the screen. + Suppresses3DTouchGesture(boolean) | *Default: false* <br/> ==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. + SuppressesIncrementalRendering(boolean) | *Default: false* <br/> ==iOS== <br/> Set to true to wait until all content has been received before it renders to the screen. + SuppressesLongPressGesture(boolean) | *Default: false* <br/> ==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. + TopActivityIndicator(string) | *Default: gray* <br/> Allowed values: whiteLarge, white, gray. <br/> ==iOS== <br/> <br/> Controls the appearance of the small spinning icon in the status bar that indicates significant processor activity. + UIWebViewDecelerationSpeed(string) | *Default: normal* <br/> Allowed values: normal, fast <br/> ==iOS== <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. + WebSecurity(string) | *Default: enable* <br/> ==BlackBerry== <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. + WindowSize(string) | *Default: auto* <br/> ==OS X **4.0.0**== <br/> Sets the size of the application window. <br/> Accepts the format `WxH` for a specific width and height or the special values `auto` and `fullscreen`. The latter will open a borderless window spanning the entire desktop area. Please note, that this is different from the _normal_ OS X fullscreen mode, which would never span multiple displays. <br/> **Note**: The global cordova `fullscreen` preference has no effect in OS X. + deployment-target(string) | ==iOS== <br/> This sets the IPHONEOS_DEPLOYMENT_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 + target-device(string) | *Default: universal* <br/> Allowed values: handset, tablet, universal <br/> ==iOS== <br/> This property maps directly to TARGETED_DEVICE_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. + windows-phone-target-version(string) | ==Windows== <br/> Sets the version of Windows Phone for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to the same version as ```windows-target-version``` (if found). + windows-target-version(string) | ==Windows== <br/> Sets the version of Windows for which the package (resulting from ```cordova build```) will target. If none is specified, it will be set to '8.1'. + WindowsDefaultUriPrefix(string) | ==Windows== <br/> Allowed values: `ms-appx://`, `ms-appx-web://` <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 (`ms-appx-web://`). <br/> In order to have a local-mode application that is not impacted by Remote Mode capability restrictions, you must set this preference to `ms-appx://` and not declare any `<access>` elements with remote URIs. The local mode is the default for Windows 8.1 + + Examples: + + <preference name="DisallowOverscroll" value="true"/> + <preference name="Fullscreen" value="true" /> + <preference name="BackgroundColor" value="0xff0000ff"/> + <preference name="HideKeyboardFormAccessoryBar" value="true"/> + <preference name="Orientation" value="landscape" /> + + <!-- iOS only preferences --> + <preference name="EnableViewportScale" value="true"/> + <preference name="MediaPlaybackAllowsAirPlay" value="false"/> + <preference name="MediaPlaybackRequiresUserAction" value="true"/> + <preference name="AllowInlineMediaPlayback" value="true"/> + <preference name="BackupWebStorage" value="local"/> + <preference name="TopActivityIndicator" value="white"/> + <preference name="SuppressesIncrementalRendering" value="true"/> + <preference name="GapBetweenPages" value="0"/> + <preference name="PageLength" value="0"/> + <preference name="PaginationBreakingMode" value="page"/> + <preference name="PaginationMode" value="unpaginated"/> + <preference name="UIWebViewDecelerationSpeed" value="fast" /> + <preference name="ErrorUrl" value="myErrorPage.html"/> + <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" /> + <preference name="AppendUserAgent" value="My Browser" /> + <preference name="target-device" value="universal" /> + <preference name="deployment-target" value="7.0" /> + <preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" /> + <preference name="SuppressesLongPressGesture" value="true" /> + <preference name="Suppresses3DTouchGesture" value="true" /> + + <!-- Android only preferences --> + <preference name="KeepRunning" value="false"/> + <preference name="LoadUrlTimeoutValue" value="10000"/> + <preference name="InAppBrowserStorageEnabled" value="true"/> + <preference name="LoadingDialog" value="My Title,My Message"/> + <preference name="ErrorUrl" value="myErrorPage.html"/> + <preference name="ShowTitle" value="true"/> + <preference name="LogLevel" value="VERBOSE"/> + <preference name="AndroidLaunchMode" value="singleTop"/> + <preference name="DefaultVolumeStream" value="call" /> + <preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" /> + <preference name="AppendUserAgent" value="My Browser" /> + + <!-- Windows only preferences --> + <preference name="windows-phone-target-version" value="8.1" /> + <preference name="windows-target-version" value="8.1" /> + <preference name="Windows.Universal" value="10.0.10240.0" /> + <preference name="WindowsDefaultUriPrefix" value="ms-appx://"" /> + <preference name="Windows.Mobile-MaxVersionTested" value="10.0.10031.0" /> + <preference name="Windows.Universal-MinVersion" value="10.0.0.0" /> + + <!-- BlackBerry only preferences --> + <preference name="ChildBrowser" value="disable"/> + <preference name="PopupBlocker" value="enable"/> + <preference name="WebSecurity" value="disable"/> + + <!-- OS X only preferences --> + <preference name="HideMousePointer" value="5"/> + <preference name="OSXLocalStoragePath" value="~/.myapp/database"/> + <preference name="WindowSize" value="800x400"/> + <preference name="EnableWebGL" value="true"/> + +## 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. + NOTE: Most of the time, you do NOT want to set this directly. - Applies to Android and iOS. 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. + Attributes(type) | Description + ----------------- | ------------ + name(string) | *Required* <br/> The name of the plugin to enable. -- `BackgroundColor`: Set 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. This - example specifies blue: - <preference name="BackgroundColor" value="0xff0000ff"/> +### param + Used to specify what certain plugin parameters such as: what package to retrieve the plugin code from, and whether the plugin code is to be initialized during the Webview's initialization. - Windows Quirk: CSS Color names are also supported: + Attributes(type) | Description + ----------------- | ------------ + name(string) | *Required* <br/> Allowed values: android-package, ios-package, osx-package, onload. <br/> ==iOS== ==OS X== ==Android== <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. + value(string or boolean) | *Required* <br/> ==iOS== ==OS X== ==Android== <br/> Specifies the name of the package to be used to initialize the plugin code (when the 'name' attribute is android-package, ios-package or osx-package), specifies the name of the plugin to be loaded during controller initialization (when 'name' attribute is set to 'onload'). - ``` - <platform name="windows"> - <preference name="BackgroundColor" value="turquoise"/> - </platform> - ``` - __NOTE__: `transparent` value will cause black/white background color in case of Dark/Light theme accordingly. - Applies to Android and BlackBerry. Overrides CSS otherwise available - across _all_ platforms, for example: `body{background-color:blue}`. + Examples: -- `HideKeyboardFormAccessoryBar` (boolean, defaults to `false`): set - to `true` to hide the additional toolbar that appears above the - keyboard, helping users navigate from one form input to another. + <!-- Here is how to specify the Device API for Android projects --> + <feature name="Device"> + <param name="android-package" value="org.apache.cordova.device.Device" /> + </feature> - <preference name="HideKeyboardFormAccessoryBar" value="true"/> + <!-- Here's how the element appears for iOS projects --> + <feature name="Device"> + <param name="ios-package" value="CDVDevice" /> + <param name="onload" value="true" /> + </feature> - Applies to BlackBerry. - -- `Orientation` (string, defaults to `default`): allows you to lock - orientation and prevent the interface from rotating in response to - changes in orientation. Possible values are `default`, `landscape` - or `portrait`. Example: + <!-- Here's how the element appears for OS X projects --> + <feature name="Device"> + <param name="osx-package" value="CDVDevice" /> + <param name="onload" value="true" /> + </feature> - <preference name="Orientation" value="landscape" /> - - Additionally, you can specify any platform-specific orientation value - if you place the `<preference>` element within a `<platform>` element: - - <platform name="android"> - <preference name="Orientation" value="sensorLandscape" /> - </platform> - - Applies to Android, iOS, WP8, Amazon Fire OS and Firefox OS. - - __NOTE__: 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`: +## platform + When using the CLI to build applications, it is sometimes necessary to specify preferences or other elements specific to a particular platform. Use the <platform> element to specify configuration that should only appear in a single platform-specific config.xml file. - <platform name="ios"> - <preference name="Orientation" value="all" /> - </platform> + Attributes(type) | Description + ----------------- | ------------ + name(string) | *Required* <br/> The platform whose preferences are being defined. -## The _feature_ Element + Examples: -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. For example, here is how to specify the -Device API for Android projects: - - <feature name="Device"> - <param name="android-package" value="org.apache.cordova.device.Device" /> - </feature> - -Here is how the element appears for iOS projects: - - <feature name="Device"> - <param name="ios-package" value="CDVDevice" /> - </feature> + <platform name="android"> + <preference name="Fullscreen" value="true" /> + </platform> -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. +## hook + Represents your custom script which will be called by Cordova when + certain action occurs (for example, after plugin is added or platform + prepare logic is invoked). This is useful when you need to extend + default Cordova functionality. See [Hooks Guide](../guide/appdev/hooks/index.html) for more information. + Attributes(type) | Description + ----------------- | ------------ + type(string) | *Required* <br/> Specifies the action during which the custom script is to be called. + src(string) | *Required* <br/> Specifies the location of the script to be called when a specific action occurs. -## The _platform_ Element + Examples: -When using the CLI to build applications, it is sometimes necessary to specify -preferences or other elements specific to a particular platform. Use the `<platform>` -element to specify configuration that should only appear in a single platform-specific -`config.xml` file. For example, here is how to specify that only android should use the -Fullscreen preference: + <hook type="after_plugin_install" src="scripts/afterPluginInstall.js" /> +# Sample config.xml + Below is a sample config.xml file: + + <?xml version='1.0' encoding='utf-8'?> + <widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets"; xmlns:cdv="http://cordova.apache.org/ns/1.0";> + <name>HelloCordova</name> + <description> + A sample Apache Cordova application that responds to the deviceready event. + </description> + <author email="[email protected]" href="http://cordova.io";> + Apache Cordova Team + </author> + <content src="index.html" /> + <plugin name="cordova-plugin-whitelist" version="1" /> + <access origin="*" /> + <allow-intent href="http://*/*"; /> + <allow-intent href="https://*/*"; /> + <allow-intent href="tel:*" /> + <allow-intent href="sms:*" /> + <allow-intent href="mailto:*"; /> + <allow-intent href="geo:*" /> <platform name="android"> - <preference name="Fullscreen" value="true" /> + <allow-intent href="market:*" /> </platform> + <platform name="ios"> + <allow-intent href="itms:*" /> + <allow-intent href="itms-apps:*" /> + </platform> + </widget> -## The _hook_ Element - -Represents your custom script which will be called by Cordova when -certain action occurs (for example, after plugin is added or platform -prepare logic is invoked). This is useful when you need to extend -default Cordova functionality. See [Hooks Guide](../guide/appdev/hooks/index.html) for more information. - <hook type="after_plugin_install" src="scripts/afterPluginInstall.js" /> +[uses-sdk]: http://developer.android.com/guide/topics/manifest/uses-sdk-element.html http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/en/6.x/cordova/events/events.backbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/6.x/cordova/events/events.backbutton.md b/www/docs/en/6.x/cordova/events/events.backbutton.md deleted file mode 100644 index 1e29e95..0000000 --- a/www/docs/en/6.x/cordova/events/events.backbutton.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -license: > - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -title: backbutton ---- - -# backbutton - -The event fires when the user presses the back button. - - document.addEventListener("backbutton", yourCallbackFunction, false); - -## Details - -To override the default back-button behavior, register an event -listener for the `backbutton` event, typically by calling -`document.addEventListener` once you receive the `[deviceready](events.deviceready.html)` event. -It is no longer necessary to call any other method to override the -back-button behavior. - -## Supported Platforms - -- Amazon Fire OS -- Android -- BlackBerry 10 -- Windows Phone 8 - -## Quick Example - - document.addEventListener("backbutton", onBackKeyDown, false); - - function onBackKeyDown() { - // Handle the back button - } - -## Full Example - - <!DOCTYPE html> - <html> - <head> - <title>Back Button Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // device APIs are available - // - function onDeviceReady() { - // Register the event listener - document.addEventListener("backbutton", onBackKeyDown, false); - } - - // Handle the back button - // - function onBackKeyDown() { - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/en/6.x/cordova/events/events.deviceready.md ---------------------------------------------------------------------- diff --git a/www/docs/en/6.x/cordova/events/events.deviceready.md b/www/docs/en/6.x/cordova/events/events.deviceready.md deleted file mode 100644 index 58dc99a..0000000 --- a/www/docs/en/6.x/cordova/events/events.deviceready.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -license: > - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -title: deviceready ---- - -# deviceready - -The event fires when Cordova is fully loaded. - - document.addEventListener("deviceready", yourCallbackFunction, false); - -## Details - -This event is essential to any application. It signals that Cordova's -device APIs have loaded and are ready to access. - -Cordova consists of two code bases: native and JavaScript. While the -native code loads, a custom loading image displays. However, -JavaScript only loads once the DOM loads. This means the web app may -potentially call a Cordova JavaScript function before the -corresponding native code becomes available. - -The `deviceready` event fires once Cordova has fully loaded. Once the -event fires, you can safely make calls to Cordova APIs. Applications -typically attach an event listener with `document.addEventListener` -once the HTML document's DOM has loaded. - -The `deviceready` event behaves somewhat differently from others. Any -event handler registered after the `deviceready` event fires has its -callback function called immediately. - -## Supported Platforms - -- Amazon Fire OS -- Android -- BlackBerry 10 -- iOS -- Windows Phone 8 -- Windows 8 - -## Quick Example - - document.addEventListener("deviceready", onDeviceReady, false); - - function onDeviceReady() { - // Now safe to use device APIs - } - -## Full Example - - <!DOCTYPE html> - <html> - <head> - <title>Device Ready Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // device APIs are available - // - function onDeviceReady() { - // Now safe to use device APIs - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/28d8c235/www/docs/en/6.x/cordova/events/events.endcallbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/6.x/cordova/events/events.endcallbutton.md b/www/docs/en/6.x/cordova/events/events.endcallbutton.md deleted file mode 100644 index 7a98fa4..0000000 --- a/www/docs/en/6.x/cordova/events/events.endcallbutton.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -license: > - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. - -title: endcallbutton ---- - -# endcallbutton - -This event fires when the user presses the end call button. - - document.addEventListener("endcallbutton", yourCallbackFunction, false); - -## Details - -The event overrides the default end call behavior. - -Applications typically should use `document.addEventListener` to -attach an event listener once the `[deviceready](events.deviceready.html)` event fires. - -## Supported Platforms - -- BlackBerry 10 - -## Quick Example - - document.addEventListener("endcallbutton", onEndCallKeyDown, false); - - function onEndCallKeyDown() { - // Handle the end call button - } - -## Full Example - - <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd";> - <html> - <head> - <title>End Call Button Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - function onLoad() { - document.addEventListener("deviceready", onDeviceReady, false); - } - - // device APIs are available - // - function onDeviceReady() { - // Register the event listener - document.addEventListener("endcallbutton", onEndCallKeyDown, false); - } - - // Handle the end call button - // - function onEndCallKeyDown() { - } - - </script> - </head> - <body onload="onLoad()"> - </body> - </html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
