You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2016/03/19 10:36:22 UTC
[06/15] docs commit: Snapshotting dev to 6.x.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e3751865/www/docs/en/6.x/reference/cordova-cli/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-cli/index.md b/www/docs/en/6.x/reference/cordova-cli/index.md
new file mode 100644
index 0000000..23d0abb
--- /dev/null
+++ b/www/docs/en/6.x/reference/cordova-cli/index.md
@@ -0,0 +1,589 @@
+---
+edit_link: 'https://github.com/apache/cordova-cli/blob/master/doc/readme.md'
+title: CLI Reference
+description: Learn how to use Cordova CLI commands and their options.
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!--
+#
+# 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.
+#
+-->
+
+# Cordova Command-line-interface (CLI) Reference
+
+## Syntax
+
+```bash
+cordova <command> [options] -- [platformOpts]
+```
+
+## Global Command List
+
+These commands are available at all times.
+
+| Command | Description
+|----------|--------------
+| create | Create a project
+| help <command> | Get help for a command
+
+## Project Command List
+
+These commands are supported when the current working directory is a valid Cordova project.
+
+| Command | Description
+|--------------|--------------
+| info | Generate project information
+| requirements | Checks and print out all the installation requirements for platforms specified
+| platform | Manage project platforms
+| plugin | Manage project plugins
+| prepare | Copy files into platform(s) for building
+| compile | Build platform(s)
+| clean | Cleanup project from build artifacts
+| run | Run project (including prepare && compile)
+| serve | Run project with a local webserver (including prepare)
+
+## Common options
+
+These options apply to all cordova-cli commands.
+
+| Option | Description
+|----------------------|------------------------
+| -d or --verbose | Pipe out more verbose output to your shell. You can also subscribe to `log` and `warn` events if you are consuming `cordova-cli` as a node module by calling `cordova.on('log', function() {})` or `cordova.on('warn', function() {})`.
+| -v or --version | Print out the version of your `cordova-cli` install.
+| --no-update-notifier | Will disable updates check. Alternatively set `"optOut": true` in `~/.config/configstore/update-notifier-cordova.json` or set `NO_UPDATE_NOTIFIER` environment variable with any value (see details in [update-notifier docs](https://www.npmjs.com/package/update-notifier#user-settings)).
+|--nohooks | Suppress executing hooks (taking RegExp hook patterns as parameters)
+
+## Platform-specific options
+
+Certain commands have options (`platformOpts`) that are specific to a particular platform. They can be provided to the cordova-cli with a '--' separator that stops the command parsing within the cordova-lib module and passes through rest of the options for platforms to parse.
+
+## Examples
+- This example demonstrates how cordova-cli can be used to create a project with the `camera` plugin and run it for `android` platform. In particular, platform specific options like `--keystore` can be provided:
+
+ # Create a cordova project
+ cordova create myApp com.myCompany.myApp myApp
+ cd myApp
+ # Add camera plugin to the project and remember that in config.xml
+ cordova plugin add cordova-plugin-camera --save
+ # Add android platform to the project and remember that in config.xml
+ cordova platform add android --save
+ # Check to see if your system is configured for building android platform.
+ cordova requirements android
+ # Build the android and emit verbose logs.
+ cordova build android --verbose
+ # Run the project on the android platform.
+ cordova run android
+ # Build for android platform in release mode with specified signing parameters.
+ cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
+
+## cordova create command
+
+### Synopsis
+
+Create the directory structure for the Cordova project in the specified path.
+
+### Syntax
+
+```
+cordova create path [id [name [config]]] [options]
+```
+
+| Value | Description |
+|-------|---------------|
+| path | Directory which should not already exist. Cordova will create this directory. For more details on the directory structure, see below. |
+| id | _Default_: `io.cordova.hellocordova` <br/> Reverse domain-style identifier that maps to `id` attirbute of `widget` element in `config.xml`. This can be changed but there may be code generated using this value, such as Java package names. It is recommended that you select an appropriate value. |
+| name | _Default_: `HelloCordova` <br/> Application's display title that maps `name` element in `config.xml` file. This can be changed but there may be code generated using this value, such as Java class names. The default value is `HelloCordova`, but it is recommended that you select an appropriate value. |
+| config | JSON string whose key/values will be included in `<path>`/.cordova/config.json |
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| --template | Use a custom template located locally, in NPM, or GitHub. |
+| --copy-from\|--src | _Deprecated_ <br/> Use --template instead. Specifies a directory from which to copy the current Cordova project. |
+|--link-to | Symlink to specified `www` directory without creating a copy. |
+
+### Directory structure
+
+A Cordova application created with `cordova-cli` will have the following directory structure:
+
+```
+myapp/
+|-- config.xml
+|-- hooks/
+|-- merges/
+| | |-- android/
+| | |-- windows/
+| | |-- ios/
+|-- www/
+|-- platforms/
+| |-- android/
+| |-- windows/
+| |-- ios/
+|-- plugins/
+ |--cordova-plugin-camera/
+```
+
+#### config.xml
+
+Configures your application and allows you to customize the behavior of your project. See also [config.xml reference documentation][config.xml ref]
+
+#### www/
+
+Contains the project's web artifacts, such as .html, .css and .js files. As a cordova application developer, most of your code and assets will go here. They will be copied on a `cordova prepare` to each platform's www directory. The www source directory is reproduced within each platform's subdirectory, appearing for example in `platforms/ios/www` or `platforms/android/assets/www`. Because the CLI constantly copies over files from the source www folder, you should only edit these files and not the ones located under the platforms subdirectories. If you use version control software, you should add this source www folder, along with the merges folder, to your version control system.
+
+#### platforms/
+
+Contains all the source code and build scripts for the platforms that you add to your project.
+
+> **WARNING:** When using the CLI to build your application, you should not edit any files in the /platforms/ directory unless you know what you are doing, or if documentation specifies otherwise. The files in this directory are routinely overwritten when preparing applications for building, or when plugins are re-installed.
+
+#### plugins/
+
+Any added plugins will be extracted or copied into this directory.
+
+#### hooks/
+
+This directory may contains scripts used to customize cordova-cli commands. Any scripts you add to these directories will be executed before and after the commands corresponding to the directory name. Useful for integrating your own build systems or integrating with version control systems.
+
+Refer to [Hooks Guide] for more information.
+
+#### merges/
+
+Platform-specific web assets (HTML, CSS and JavaScript files) are contained within appropriate subfolders in this directory. These are deployed during a `prepare` to the appropriate native directory. Files placed under `merges/` will override matching files in the `www/` folder for the relevant platform. A quick example, assuming a project structure of:
+
+```
+merges/
+|-- ios/
+| -- app.js
+|-- android/
+| -- android.js
+www/
+-- app.js
+```
+
+After building the Android and iOS projects, the Android application will contain both `app.js` and `android.js`. However, the iOS application will only contain an `app.js`, and it will be the one from `merges/ios/app.js`, overriding the "common" `app.js` located inside `www/`.
+
+#### Version control
+
+It is recommended not to check in `platforms/` and `plugins/` directories into version control as they are considered a build artifact. Instead, you should save the platform/plugin spec in the `config.xml` and they will be downloaded when on the machine when `cordova prepare` is invoked.
+
+### Examples
+
+- Create a Cordova project in `myapp` directory using the specified ID and display name:
+
+ cordova create myapp com.mycompany.myteam.myapp MyApp
+
+- Create a Cordova project with a symlink to an existing `www` directory. This can be useful if you have a custom build process or existing web assets that you want to use in your Cordova app:
+
+ cordova create myapp --link-to=../www
+
+
+## cordova platform command
+
+### Synopsis
+
+Manage cordova platforms - allowing you to add, remove, update, list and check for updates. Running commands to add or remove platforms affects the contents of the project's platforms directory.
+
+### Syntax
+
+```bash
+cordova {platform | platforms} [
+ add <platform-spec> [...] {--save | link=<path> } |
+ {remove | rm} platform [...] |
+ {list | ls} |
+ check |
+ save ]
+```
+
+| Sub-command | Option | Description |
+------------------------|-------------|------|
+| add `<platform-spec>` [...] | | Add specified platforms |
+| | --save | Save `<platform-spec>` into `config.xml` after installing them using `<engine>` tag |
+| | --link=`<path>` | When `<platform-spec>` is a local path, links the platform library directly instead of making a copy of it (support varies by platform; useful for platform development)
+| remove `<platform>` [...] | | Remove specified platforms |
+| | --save | Delete specified platforms from `config.xml` after removing them |
+| update `platform` [...] | | Update specified platforms |
+| | --save | Updates the version specified in `config.xml` |
+| list | | List all installed and available platforms |
+| check | | List platforms which can be updated by `cordova-cli platform update` |
+| save | | Save `<platform-spec>` of all platforms added to config.xml |
+
+### Platform-spec
+
+There are a number of ways to specify a platform:
+
+```
+<platform-spec> : platform[@version] | path | url[#commit-ish]
+```
+
+| Value | Description |
+|-----------|-------------|
+| platform | Platform name e.g. android, ios, windows etc. to be added to the project. Every release of cordova CLI pins a version for each platform. When no version is specified this version is used to add the platform. |
+| version | Major.minor.patch version specifier using semver |
+| path | Path to a directory or tarball containing a platform |
+| url | URL to a git repository or tarball containing a platform |
+| commit-ish | Commit/tag/branch reference. If none is specified, 'master' is used |
+
+### Supported Platforms
+
+- Android
+- iOS
+- Windows (8.1, Phone 8.1, UWP - Windows 10)
+- Blackberry10
+- Ubuntu
+- Browser
+
+### Deprecated Platforms
+
+- Amazon-fireos (use Android platform instead)
+- WP8 (use Windows platform instead)
+- Windows 8.0 (use older versions of cordova)
+- Firefox OS (use older versions of cordova)
+
+### Examples
+
+- Add pinned version of the `android` and `ios` platform and save the downloaded version to `config.xml`:
+
+ cordova platform add android ios --save
+
+- Add `android` platform with [semver](http://semver.org/) version ^5.0.0 and save it to `config.xml`:
+
+ cordova platform add android@^5.0.0 --save
+
+- Add platform by cloning the specified git repo and checkout to the `4.0.0` tag:
+
+ cordova platform add https://github.com/myfork/cordova-android.git#4.0.0
+
+- Add platform using a local directory named `android`:
+
+ cordova platform add ../android
+
+- Add platform using the specified tarball:
+
+ cordova platform add ../cordova-android.tgz
+
+- Remove `android` platform from the project and from `config.xml`:
+
+ cordova platform rm android --save
+
+- List available and installed platforms with version numbers. This is useful to find version numbers when reporting issues:
+
+ cordova platform ls
+
+- Save versions of all platforms currently added to the project to `config.xml`.
+
+ cordova platform save
+
+## cordova plugin command
+
+### Synopsis
+
+Manage project plugins
+
+### Syntax
+
+```bash
+cordova {plugin | plugins} [
+ add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force} |
+ {remove | rm} {<pluginid> | <name>} --save |
+ {list | ls} |
+ search [<keyword>] |
+ save |
+]
+```
+
+| Sub-command | Option | Description
+|------------------------|-------------|------
+| add `<plugin-spec>` [...] | | Add specified plugins
+| |--searchpath `<directory>` | When looking up plugins by ID, look in this directory and each of its subdirectories before hitting the registry. Multiple search paths can be specified. Use ':' as a separator in *nix based systems and ';' for Windows.
+| |--noregistry | Don't search the registry for plugins.
+| |--link | When installing from a local path, creates a symbolic link instead of copying files. The extent to which files are linked varies by platform. Useful for plugin development.
+| |--save | Save the `<plugin-spec>` as part of the `plugin` element into `config.xml`.
+| |--browserify | Compile plugin JS at build time using browserify instead of runtime.
+| |--force | _Introduced in version 6.1._ Forces copying source files from the plugin even if the same file already exists in the target directory.
+| remove `<pluginid>|<name>` [...]| | Remove plugins with the given IDs/name.
+| |--save | Remove the specified plugin from config.xml
+|list | | List currently installed plugins
+|search `[<keyword>]` [...] | | Search http://plugins.cordova.io for plugins matching the keywords
+|save | | Save `<plugin-spec>` of all plugins currently added to the project
+
+### Plugin-spec
+
+There are a number of ways to specify a plugin:
+
+ <plugin-spec> : pluginID[@version]|directory|url[#commit-ish][:subdir]
+
+| Value | Description
+|-------------|--------------------
+| plugin | Plugin id (id of plugin in npm registry or in --searchPath)
+| version | Major.minor.patch version specifier using semver
+| directory | Directory containing plugin.xml
+| url | Url to a git repository containing a plugin.xml
+| commit-ish | Commit/tag/branch reference. If none is specified, 'master' is used
+| subdir | Sub-directory to find plugin.xml for the specified plugin.
+
+### Examples
+
+- Add `cordova-plugin-camera` and `cordova-plugin-file` to the project and save it to `config.xml`. Use `../plugins` directory to search for the plugins.
+
+ cordova plugin add cordova-plugin-camera cordova-plugin-file --save --searchpath ../plugins
+
+- Add `cordova-plugin-camera` with [semver](http://semver.org/) version ^2.0.0 and save it to `config.xml`:
+
+ cordova plugin add cordova-plugin-camera@^2.0.0 --save
+
+- Clone the specified git repo, checkout to tag `2.1.0`, look for plugin.xml in the `plugin` directory, and add it to the project. Save the `plugin-spec` to `config.xml`:
+
+ cordova plugin add https://github.com/apache/cordova-plugin-camera.git#2.1.0:plugin --save
+
+- Add the plugin from the specified local directory:
+
+ cordova plugin add ../cordova-plugin-camera
+
+- Add the plugin from the specified tarball file:
+
+ cordova plugin add ../cordova-plugin-camera.tgz --save
+
+- Remove the plugin from the project and the `config.xml`:
+
+ cordova plugin rm camera --save
+
+- List all plugins installed in the project:
+
+ cordova plugin ls
+
+## cordova prepare command
+
+### Synopsis
+
+Transforms config.xml metadata to platform-specific manifest files, copies icons & splashscreens,
+copies plugin files for specified platforms so that the project is ready to build with each native SDK.
+
+### Syntax
+
+```
+cordova prepare [<platform> [..]]
+ [--browserify]
+```
+
+###Options
+
+| Option | Description
+|------------|------------------
+| `<platform> [..]` | Platform name(s) to prepare. If not specified, all platforms are built.
+|--browserify | Compile plugin JS at build time using browserify instead of runtime.
+
+## cordova compile command
+
+### Synopsis
+
+`cordova compile` is a subset of the [cordova build command](#cordova-build-command).
+It only performs the compilation step without doing prepare. It's common to invoke `cordova build` instead of this command - however, this stage is useful to allow extending using [hooks][Hooks guide].
+
+###Syntax
+
+```bash
+cordova build [<platform> [...]]
+ [--debug|--release]
+ [--device|--emulator|--target=<targetName>]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+For detailed documentation see [cordova build command](#cordova-build-command) docs below.
+
+## cordova build command
+
+### Synopsis
+
+Shortcut for `cordova prepare` + `cordova compile` for all/the specified platforms. Allows you to build the app for the specified platform.
+
+### Syntax
+
+```bash
+cordova build [<platform> [...]]
+ [--debug|--release]
+ [--device|--emulator]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+
+| Option | Description
+|------------|------------------
+| `<platform> [..]` | Platform name(s) to build. If not specified, all platforms are built.
+| --debug | Perform a debug build. This typically translates to debug mode for the underlying platform being built.
+| --release | Perform a release build. This typically translates to release mode for the underlying platform being built.
+| --device | Build it for a device
+| --emulator | Build it for an emulator. In particular, the platform architecture might be different for a device Vs emulator.
+| --buildConfig=`<configFile>` | Default: build.json in cordova root directory. <br/> Use the specified build configuration file. `build.json` file is used to specify paramaters to customize the app build process esecially related to signing the package.
+| --browserify | Compile plugin JS at build time using browserify instead of runtime
+| `<platformOpts>` | To provide platform specific options, you must include them after `--` separator. Review platform guide docs for more details.
+
+### Examples
+
+- Build for `android` and `windows` platform in `debug` mode for deployment to device:
+
+ cordova build android windows --debug --device
+
+- Build for `android` platform in `release` mode and use the specified build configuration:
+
+ cordova build android --release --buildConfig=..\myBuildConfig.json
+
+- Build for `android` platform in release mode and pass custom platform options to android build process:
+
+ cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
+
+## cordova run command
+
+### Synopsis
+
+Prepares, builds (unless `--nobuild` is specified) and deploys app on specified platform devices/emulators. If a device is connected it will be used, unless an eligible emulator is already running.
+
+###Syntax
+
+```bash
+cordova run [<platform> [...]]
+ [--list | --nobuild ]
+ [--device|--emulator|--target=<targetName>]
+ [--buildConfig=<configfile>]
+ [--browserify]
+ [-- <platformOpts>]
+```
+
+| Option | Description
+|------------|------------------
+| `<platform> [..]` | Platform name(s) to run. If not specified, all platforms are run.
+|--nobuild | Skip building
+|--debug | Deploy a debug build. This is the default behavior unless `--release` is specified.
+|--release | Deploy a release build
+|--device | Deploy to a device
+|--emulator | Deploy to an emulator
+|--target | Deploy to a specific target emulator/device. Use `--list` to display target options
+| --list | Lists available targets. Displays both device and emulator deployment targets unless specified
+| --buildConfig=`<configFile>` | Default: build.json in cordova root directory. <br/> Use the specified build configuration file. `build.json` file is used to specify paramaters to customize the app build process esecially related to signing the package.
+| --browserify | Compile plugin JS at build time using browserify instead of runtime
+| `<platformOpts>` | To provide platform specific options, you must include them after `--` separator. Review platform guide docs for more details.
+
+###Examples
+
+- Run a release build of current cordova project on `android` platform emulator named `Nexus_5_API_23_x86`. Use the spcified build configuration when running:
+
+ cordova run android --release --buildConfig=..\myBuildConfig.json --target=Nexus_5_API_23_x86
+
+- Run a debug build of current cordova project on `android` platform using a device or emulator (if no device is connected). Skip doing the build:
+
+ cordova run android --nobuild
+
+- Run a debug build of current cordova project on an `ios` device:
+
+ cordova run ios --device
+
+- Enumerate names of all the connected devices and available emulators that can be used to run this app:
+
+ cordova run ios --list
+
+
+## cordova emulate command
+
+### Synopsis
+
+Alias for `cordova run --emulator`. Launches the emulator instead of device.
+See [cordova run command docs](#cordova-run-command) for more details.
+
+## cordova clean command
+
+### Synopsis
+
+Cleans the build artifacts for the specified platform, or all platforms by running platform-specific build cleanup.
+
+### Syntax
+
+```
+cordova clean [<platform> [...]]
+```
+
+### Example
+
+- Clean `android` platform build artifiacts:
+
+ cordova clean android
+
+
+## cordova requirements command
+
+### Synopsis
+
+Checks and print out all the requirements for platforms specified (or all platforms added
+to project if none specified). If all requirements for each platform are met, exits with code 0
+otherwise exits with non-zero code.
+
+This can be useful when setting up a machine for building a particular platform.
+
+### Syntax
+
+```
+cordova requirements android
+```
+
+## cordova info command
+
+### Synopsis
+
+Print out useful information helpful for submitting bug
+reports and getting help. Creates an info.txt file at the
+base of your project.
+
+### Syntax
+
+```
+cordova info
+```
+
+## cordova serve command
+
+### Synopsis
+
+Run a local web server for www/ assets using specified `port` or default of 8000. Access projects at: `http://HOST_IP:PORT/PLATFORM/www`
+
+### Syntax
+
+```
+cordova serve [port]
+```
+
+## cordova help command
+
+### Synopsis
+
+Show syntax summary, or the help for a specific command.
+
+### Syntax
+
+```
+cordova help [command]
+cordova [command] -h
+cordova -h [command]
+```
+
+[Hooks guide]: http://cordova.apache.org/docs/en/latest/guide_appdev_hooks_index.md.html
+[config.xml ref]: http://cordova.apache.org/docs/en/latest/config_ref/index.html
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e3751865/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md b/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
new file mode 100644
index 0000000..74a9818
--- /dev/null
+++ b/www/docs/en/6.x/reference/cordova-plugin-battery-status/index.md
@@ -0,0 +1,140 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-battery-status/blob/master/README.md'
+title: cordova-plugin-battery-status
+plugin_name: cordova-plugin-battery-status
+plugin_version: master
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!--
+# 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.
+-->
+
+[](https://travis-ci.org/apache/cordova-plugin-battery-status)
+
+# cordova-plugin-battery-status
+
+This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. It adds the following three events to the `window` object:
+
+* batterystatus
+* batterycritical
+* batterylow
+
+Applications may use `window.addEventListener` to attach an event listener for any of the above events after the `deviceready` event fires.
+
+## Installation
+
+ cordova plugin add cordova-plugin-battery-status
+
+## Status object
+
+All events in this plugin return an object with the following properties:
+
+- __level__: The battery charge percentage (0-100). _(Number)_
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+## batterystatus event
+
+Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+
+ function onBatteryStatus(status) {
+ console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Windows Phone 7 and 8
+- Windows (Windows Phone 8.1 only)
+- Firefox OS
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Android & Amazon Fire OS
+
+**Warning**: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.
+
+### Quirks: Windows Phone 7 & Windows Phone 8
+
+The `level` property is _not_ supported on Windows Phone 7 because the OS does not provide native APIs to determine battery level. The `isPlugged` parameter _is_ supported.
+
+### Quirks: Windows Phone 8.1
+
+The `isPlugged` parameter is _not_ supported on Windows Phone 8.1. The `level` parameter _is_ supported.
+
+## batterylow event
+
+Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterylow", onBatteryLow, false);
+
+ function onBatteryLow(status) {
+ alert("Battery Level Low " + status.level + "%");
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Firefox OS
+- Windows (Windows Phone 8.1 only)
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Windows Phone 8.1
+
+The `batterylow` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
+
+## batterycritical event
+
+Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
+
+### Example
+
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+
+ function onBatteryCritical(status) {
+ alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
+ }
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Firefox OS
+- Windows (Windows Phone 8.1 only)
+- Browser (Chrome, Firefox, Opera)
+
+### Quirks: Windows Phone 8.1
+
+The `batterycritical` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
+
+[w3c_spec]: http://www.w3.org/TR/2011/WD-battery-status-20110915/
+[status_object]: #status-object
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e3751865/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-camera/index.md b/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
new file mode 100644
index 0000000..a6c91d7
--- /dev/null
+++ b/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
@@ -0,0 +1,537 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-camera/blob/master/README.md'
+title: cordova-plugin-camera
+plugin_name: cordova-plugin-camera
+plugin_version: master
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!---
+# 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.
+-->
+
+[](https://travis-ci.org/apache/cordova-plugin-camera)
+
+# cordova-plugin-camera
+
+This plugin defines a global `navigator.camera` object, which provides an API for taking pictures and for choosing images from
+the system's image library.
+
+Although the object is attached to the global scoped `navigator`, it is not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log(navigator.camera);
+ }
+
+
+## Installation
+
+This requires cordova 5.0+
+
+ cordova plugin add cordova-plugin-camera
+Older versions of cordova can still install via the __deprecated__ id
+
+ cordova plugin add org.apache.cordova.camera
+It is also possible to install via repo url directly ( unstable )
+
+ cordova plugin add https://github.com/apache/cordova-plugin-camera.git
+
+
+## How to Contribute
+
+Contributors are welcome! And we need your contributions to keep the project moving forward. You can [report bugs](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened)%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Camera%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC), improve the documentation, or [contribute code](https://github.com/apache/cordova-plugin-camera/pulls).
+
+There is a specific [contributor workflow](http://wiki.apache.org/cordova/ContributorWorkflow) we recommend. Start reading there. More information is available on [our wiki](http://wiki.apache.org/cordova).
+
+:warning: **Found an issue?** File it on [JIRA issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Reopened)%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Camera%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC).
+
+**Have a solution?** Send a [Pull Request](https://github.com/apache/cordova-plugin-camera/pulls).
+
+In order for your changes to be accepted, you need to sign and submit an Apache [ICLA](http://www.apache.org/licenses/#clas) (Individual Contributor License Agreement). Then your name will appear on the list of CLAs signed by [non-committers](https://people.apache.org/committer-index.html#unlistedclas) or [Cordova committers](http://people.apache.org/committers-by-project.html#cordova).
+
+**And don't forget to test and document your code.**
+
+
+## This documentation is generated by a tool
+
+:warning: Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
+[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
+Documentation consists of template and API docs produced from the plugin JS code and should be regenerated before each commit (done automatically via [husky](https://github.com/typicode/husky), running `npm run gen-docs` script as a `precommit` hook - see `package.json` for details).
+
+
+---
+
+# API Reference
+
+
+* [camera](#module_camera)
+ * [.getPicture(successCallback, errorCallback, options)](#module_camera.getPicture)
+ * [.cleanup()](#module_camera.cleanup)
+ * [.onError](#module_camera.onError) : <code>function</code>
+ * [.onSuccess](#module_camera.onSuccess) : <code>function</code>
+ * [.CameraOptions](#module_camera.CameraOptions) : <code>Object</code>
+
+
+* [Camera](#module_Camera)
+ * [.DestinationType](#module_Camera.DestinationType) : <code>enum</code>
+ * [.EncodingType](#module_Camera.EncodingType) : <code>enum</code>
+ * [.MediaType](#module_Camera.MediaType) : <code>enum</code>
+ * [.PictureSourceType](#module_Camera.PictureSourceType) : <code>enum</code>
+ * [.PopoverArrowDirection](#module_Camera.PopoverArrowDirection) : <code>enum</code>
+ * [.Direction](#module_Camera.Direction) : <code>enum</code>
+
+* [CameraPopoverHandle](#module_CameraPopoverHandle)
+* [CameraPopoverOptions](#module_CameraPopoverOptions)
+
+---
+
+<a name="module_camera"></a>
+## camera
+<a name="module_camera.getPicture"></a>
+### camera.getPicture(successCallback, errorCallback, options)
+Takes a photo using the camera, or retrieves a photo from the device's
+image gallery. The image is passed to the success callback as a
+Base64-encoded `String`, or as the URI for the image file.
+
+The `camera.getPicture` function opens the device's default camera
+application that allows users to snap pictures by default - this behavior occurs,
+when `Camera.sourceType` equals [`Camera.PictureSourceType.CAMERA`](#module_Camera.PictureSourceType).
+Once the user snaps the photo, the camera application closes and the application is restored.
+
+If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
+`Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
+that allows users to select an existing image. The
+`camera.getPicture` function returns a [`CameraPopoverHandle`](#module_CameraPopoverHandle) object,
+which can be used to reposition the image selection dialog, for
+example, when the device orientation changes.
+
+The return value is sent to the [`cameraSuccess`](#module_camera.onSuccess) callback function, in
+one of the following formats, depending on the specified
+`cameraOptions`:
+
+- A `String` containing the Base64-encoded photo image.
+
+- A `String` representing the image file location on local storage (default).
+
+You can do whatever you want with the encoded image or URI, for
+example:
+
+- Render the image in an `<img>` tag, as in the example below
+
+- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc.)
+
+- Post the data to a remote server
+
+__NOTE__: Photo resolution on newer devices is quite good. Photos
+selected from the device's gallery are not downscaled to a lower
+quality, even if a `quality` parameter is specified. To avoid common
+memory problems, set `Camera.destinationType` to `FILE_URI` rather
+than `DATA_URL`.
+
+__Supported Platforms__
+
+- Android
+- BlackBerry
+- Browser
+- Firefox
+- FireOS
+- iOS
+- Windows
+- WP8
+- Ubuntu
+
+More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPicture-quirks).
+
+**Kind**: static method of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| successCallback | <code>[onSuccess](#module_camera.onSuccess)</code> | |
+| errorCallback | <code>[onError](#module_camera.onError)</code> | |
+| options | <code>[CameraOptions](#module_camera.CameraOptions)</code> | CameraOptions |
+
+**Example**
+```js
+navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
+```
+<a name="module_camera.cleanup"></a>
+### camera.cleanup()
+Removes intermediate image files that are kept in temporary storage
+after calling [`camera.getPicture`](#module_camera.getPicture). Applies only when the value of
+`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
+`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
+
+__Supported Platforms__
+
+- iOS
+
+**Kind**: static method of <code>[camera](#module_camera)</code>
+**Example**
+```js
+navigator.camera.cleanup(onSuccess, onFail);
+
+function onSuccess() {
+ console.log("Camera cleanup success.")
+}
+
+function onFail(message) {
+ alert('Failed because: ' + message);
+}
+```
+<a name="module_camera.onError"></a>
+### camera.onError : <code>function</code>
+Callback function that provides an error message.
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>string</code> | The message is provided by the device's native code. |
+
+<a name="module_camera.onSuccess"></a>
+### camera.onSuccess : <code>function</code>
+Callback function that provides the image data.
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+
+| Param | Type | Description |
+| --- | --- | --- |
+| imageData | <code>string</code> | Base64 encoding of the image data, _or_ the image file URI, depending on [`cameraOptions`](#module_camera.CameraOptions) in effect. |
+
+**Example**
+```js
+// Show image
+//
+function cameraCallback(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+}
+```
+<a name="module_camera.CameraOptions"></a>
+### camera.CameraOptions : <code>Object</code>
+Optional parameters to customize the camera settings.
+* [Quirks](#CameraOptions-quirks)
+
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| quality | <code>number</code> | <code>50</code> | Quality of the saved image, expressed as a range of 0-100, where 100 is typically full resolution with no loss from file compression. (Note that information about the camera's resolution is unavailable.) |
+| destinationType | <code>[DestinationType](#module_Camera.DestinationType)</code> | <code>FILE_URI</code> | Choose the format of the return value. |
+| sourceType | <code>[PictureSourceType](#module_Camera.PictureSourceType)</code> | <code>CAMERA</code> | Set the source of the picture. |
+| allowEdit | <code>Boolean</code> | <code>true</code> | Allow simple editing of image before selection. |
+| encodingType | <code>[EncodingType](#module_Camera.EncodingType)</code> | <code>JPEG</code> | Choose the returned image file's encoding. |
+| targetWidth | <code>number</code> | | Width in pixels to scale image. Must be used with `targetHeight`. Aspect ratio remains constant. |
+| targetHeight | <code>number</code> | | Height in pixels to scale image. Must be used with `targetWidth`. Aspect ratio remains constant. |
+| mediaType | <code>[MediaType](#module_Camera.MediaType)</code> | <code>PICTURE</code> | Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. |
+| correctOrientation | <code>Boolean</code> | | Rotate the image to correct for the orientation of the device during capture. |
+| saveToPhotoAlbum | <code>Boolean</code> | | Save the image to the photo album on the device after capture. |
+| popoverOptions | <code>[CameraPopoverOptions](#module_CameraPopoverOptions)</code> | | iOS-only options that specify popover location in iPad. |
+| cameraDirection | <code>[Direction](#module_Camera.Direction)</code> | <code>BACK</code> | Choose the camera to use (front- or back-facing). |
+
+---
+
+<a name="module_Camera"></a>
+## Camera
+<a name="module_Camera.DestinationType"></a>
+### Camera.DestinationType : <code>enum</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| DATA_URL | <code>number</code> | <code>0</code> | Return base64 encoded string. DATA_URL can be very memory intensive and cause app crashes or out of memory errors. Use FILE_URI or NATIVE_URI if possible |
+| FILE_URI | <code>number</code> | <code>1</code> | Return file uri (content://media/external/images/media/2 for Android) |
+| NATIVE_URI | <code>number</code> | <code>2</code> | Return native uri (eg. asset-library://... for iOS) |
+
+<a name="module_Camera.EncodingType"></a>
+### Camera.EncodingType : <code>enum</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| JPEG | <code>number</code> | <code>0</code> | Return JPEG encoded image |
+| PNG | <code>number</code> | <code>1</code> | Return PNG encoded image |
+
+<a name="module_Camera.MediaType"></a>
+### Camera.MediaType : <code>enum</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| PICTURE | <code>number</code> | <code>0</code> | Allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType |
+| VIDEO | <code>number</code> | <code>1</code> | Allow selection of video only, ONLY RETURNS URL |
+| ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types |
+
+<a name="module_Camera.PictureSourceType"></a>
+### Camera.PictureSourceType : <code>enum</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from picture library (same as SAVEDPHOTOALBUM for Android) |
+| CAMERA | <code>number</code> | <code>1</code> | Take picture from camera |
+| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
+
+<a name="module_Camera.PopoverArrowDirection"></a>
+### Camera.PopoverArrowDirection : <code>enum</code>
+Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
+
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default |
+| --- | --- | --- |
+| ARROW_UP | <code>number</code> | <code>1</code> |
+| ARROW_DOWN | <code>number</code> | <code>2</code> |
+| ARROW_LEFT | <code>number</code> | <code>4</code> |
+| ARROW_RIGHT | <code>number</code> | <code>8</code> |
+| ARROW_ANY | <code>number</code> | <code>15</code> |
+
+<a name="module_Camera.Direction"></a>
+### Camera.Direction : <code>enum</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| BACK | <code>number</code> | <code>0</code> | Use the back-facing camera |
+| FRONT | <code>number</code> | <code>1</code> | Use the front-facing camera |
+
+---
+
+<a name="module_CameraPopoverOptions"></a>
+## CameraPopoverOptions
+iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library
or album.
Note that the size of the popover may change to adjust to the
direction of the arrow and orientation of the screen. Make sure to
account for orientation changes when specifying the anchor element
location.
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [x] | <code>Number</code> | <code>0</code> | x pixel coordinate of screen element onto which to anchor the popover. |
+| [y] | <code>Number</code> | <code>32</code> | y pixel coordinate of screen element onto which to anchor the popover. |
+| [width] | <code>Number</code> | <code>320</code> | width, in pixels, of the screen element onto which to anchor the popover. |
+| [height] | <code>Number</code> | <code>480</code> | height, in pixels, of the screen element onto which to anchor the popover. |
+| [arrowDir] | <code>[PopoverArrowDirection](#module_Camera.PopoverArrowDirection)</code> | <code>ARROW_ANY</code> | Direction the arrow on the popover should point. |
+
+---
+
+<a name="module_CameraPopoverHandle"></a>
+## CameraPopoverHandle
+A handle to an image picker popover.
+
+__Supported Platforms__
+
+- iOS
+
+**Example**
+```js
+var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
+{
+ destinationType: Camera.DestinationType.FILE_URI,
+ sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
+ popoverOptions: new CameraPopoverOptions(300, 300, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY)
+});
+
+// Reposition the popover if the orientation changes.
+window.onorientationchange = function() {
+ var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
+ cameraPopoverHandle.setPosition(cameraPopoverOptions);
+}
+```
+---
+
+
+## `camera.getPicture` Errata
+
+#### Example <a name="camera-getPicture-examples"></a>
+
+Take a photo and retrieve the image's file location:
+
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
+
+ function onSuccess(imageURI) {
+ var image = document.getElementById('myImage');
+ image.src = imageURI;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+Take a photo and retrieve it as a Base64-encoded image:
+
+ /**
+ * Warning: Using DATA_URL is not recommended! The DATA_URL destination
+ * type is very memory intensive, even with a low quality setting. Using it
+ * can result in out of memory errors and application crashes. Use FILE_URI
+ * or NATIVE_URI instead.
+ */
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 25,
+ destinationType: Camera.DestinationType.DATA_URL
+ });
+
+ function onSuccess(imageData) {
+ var image = document.getElementById('myImage');
+ image.src = "data:image/jpeg;base64," + imageData;
+ }
+
+ function onFail(message) {
+ alert('Failed because: ' + message);
+ }
+
+#### Preferences (iOS)
+
+- __CameraUsesGeolocation__ (boolean, defaults to false). For capturing JPEGs, set to true to get geolocation data in the EXIF header. This will trigger a request for geolocation permissions if set to true.
+
+ <preference name="CameraUsesGeolocation" value="false" />
+
+#### Amazon Fire OS Quirks <a name="camera-getPicture-quirks"></a>
+
+Amazon Fire OS uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the image may not appear when the Cordova activity is restored.
+
+#### Android Quirks
+
+Android uses intents to launch the camera activity on the device to capture
+images, and on phones with low memory, the Cordova activity may be killed. In this
+scenario, the result from the plugin call will be delivered via the resume event.
+See [the Android Lifecycle guide][android_lifecycle]
+for more information. The `pendingResult.result` value will contain the value that
+would be passed to the callbacks (either the URI/URL or an error message). Check
+the `pendingResult.pluginStatus` to determine whether or not the call was
+successful.
+
+#### Browser Quirks
+
+Can only return photos as Base64-encoded image.
+
+#### Firefox OS Quirks
+
+Camera plugin is currently implemented using [Web Activities][web_activities].
+
+#### iOS Quirks
+
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
+
+ setTimeout(function() {
+ // do your thing here!
+ }, 0);
+
+#### Windows Phone 7 Quirks
+
+Invoking the native camera application while the device is connected
+via Zune does not work, and triggers an error callback.
+
+#### Tizen Quirks
+
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
+
+
+## `CameraOptions` Errata <a name="CameraOptions-quirks"></a>
+
+#### Amazon Fire OS Quirks
+
+- Any `cameraDirection` value results in a back-facing photo.
+
+- Ignores the `allowEdit` parameter.
+
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
+
+#### Android Quirks
+
+- Any `cameraDirection` value results in a back-facing photo.
+
+- **`allowEdit` is unpredictable on Android and it should not be used!** The Android implementation of this plugin tries to find and use an application on the user's device to do image cropping. The plugin has no control over what application the user selects to perform the image cropping and it is very possible that the user could choose an incompatible option and cause the plugin to fail. This sometimes works because most devices come with an application that handles cropping in a way that is compatible with this plugin (Google Plus Photos), but it is unwise to rely on that being the case. If image editing is essential to your application, consider seeking a third party library or plugin that provides its own image editing utility for a more robust solution.
+
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
+
+- Ignores the `encodingType` parameter if the image is unedited (i.e. `quality` is 100, `correctOrientation` is false, and no `targetHeight` or `targetWidth` are specified). The `CAMERA` source will always return the JPEG file given by the native camera and the `PHOTOLIBRARY` and `SAVEDPHOTOALBUM` sources will return the selected file in its existing encoding.
+
+#### BlackBerry 10 Quirks
+
+- Ignores the `quality` parameter.
+
+- Ignores the `allowEdit` parameter.
+
+- `Camera.MediaType` is not supported.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+#### Firefox OS Quirks
+
+- Ignores the `quality` parameter.
+
+- `Camera.DestinationType` is ignored and equals `1` (image file URI)
+
+- Ignores the `allowEdit` parameter.
+
+- Ignores the `PictureSourceType` parameter (user chooses it in a dialog window)
+
+- Ignores the `encodingType`
+
+- Ignores the `targetWidth` and `targetHeight`
+
+- `Camera.MediaType` is not supported.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+#### iOS Quirks
+
+- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. The contents of the application's temporary directory is deleted when the application ends.
+
+- When using `destinationType.NATIVE_URI` and `sourceType.CAMERA`, photos are saved in the saved photo album regardless on the value of `saveToPhotoAlbum` parameter.
+
+#### Tizen Quirks
+
+- options not supported
+
+- always returns a FILE URI
+
+#### Windows Phone 7 and 8 Quirks
+
+- Ignores the `allowEdit` parameter.
+
+- Ignores the `correctOrientation` parameter.
+
+- Ignores the `cameraDirection` parameter.
+
+- Ignores the `saveToPhotoAlbum` parameter. IMPORTANT: All images taken with the WP8/8 Cordova camera API are always copied to the phone's camera roll. Depending on the user's settings, this could also mean the image is auto-uploaded to their OneDrive. This could potentially mean the image is available to a wider audience than your app intended. If this is a blocker for your application, you will need to implement the CameraCaptureTask as [documented on MSDN][msdn_wp8_docs]. You may also comment or up-vote the related issue in the [issue tracker][wp8_bug].
+
+- Ignores the `mediaType` property of `cameraOptions` as the Windows Phone SDK does not provide a way to choose videos from PHOTOLIBRARY.
+
+[android_lifecycle]: http://cordova.apache.org/docs/en/dev/guide/platforms/android/lifecycle.html
+[web_activities]: https://hacks.mozilla.org/2013/01/introducing-web-activities/
+[wp8_bug]: https://issues.apache.org/jira/browse/CB-2083
+[msdn_wp8_docs]: http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh394006.aspx
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e3751865/www/docs/en/6.x/reference/cordova-plugin-console/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-console/index.md b/www/docs/en/6.x/reference/cordova-plugin-console/index.md
new file mode 100644
index 0000000..127a041
--- /dev/null
+++ b/www/docs/en/6.x/reference/cordova-plugin-console/index.md
@@ -0,0 +1,109 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-console/blob/master/README.md'
+title: cordova-plugin-console
+plugin_name: cordova-plugin-console
+plugin_version: master
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!---
+# 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.
+-->
+
+[](https://travis-ci.org/apache/cordova-plugin-console)
+
+# cordova-plugin-console
+
+This plugin is meant to ensure that console.log() is as useful as it can be.
+It adds additional function for iOS, Ubuntu, Windows Phone 8, and Windows. If
+you are happy with how console.log() works for you, then you probably
+don't need this plugin.
+
+This plugin defines a global `console` object.
+
+Although the object is in the global scope, features provided by this plugin
+are not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log("console.log works well");
+ }
+
+## Installation
+
+ cordova plugin add cordova-plugin-console
+
+### Android Quirks
+
+On some platforms other than Android, console.log() will act on multiple
+arguments, such as console.log("1", "2", "3"). However, Android will act only
+on the first argument. Subsequent arguments to console.log() will be ignored.
+This plugin is not the cause of that, it is a limitation of Android itself.
+
+## Supported Methods
+
+The plugin support following methods of the `console` object:
+
+- `console.log`
+- `console.error`
+- `console.exception`
+- `console.warn`
+- `console.info`
+- `console.debug`
+- `console.assert`
+- `console.dir`
+- `console.dirxml`
+- `console.time`
+- `console.timeEnd`
+- `console.table`
+
+## Partially supported Methods
+
+Methods of the `console` object which implemented, but behave different from browser implementation:
+
+- `console.group`
+- `console.groupCollapsed`
+
+The grouping methods are just log name of the group and don't actually indicate grouping for later
+calls to `console` object methods.
+
+## Not supported Methods
+
+Methods of the `console` object which are implemented, but do nothing:
+
+- `console.clear`
+- `console.trace`
+- `console.groupEnd`
+- `console.timeStamp`
+- `console.profile`
+- `console.profileEnd`
+- `console.count`
+
+## Supported formatting
+
+The following formatting options available:
+
+Format chars:
+
+* `%j` - format arg as JSON
+* `%o` - format arg as JSON
+* `%c` - format arg as `''`. No color formatting could be done.
+* `%%` - replace with `'%'`
+
+Any other char following `%` will format its arg via `toString()`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e3751865/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md b/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md
new file mode 100644
index 0000000..26c89ad
--- /dev/null
+++ b/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md
@@ -0,0 +1,841 @@
+---
+edit_link: 'https://github.com/apache/cordova-plugin-contacts/blob/master/README.md'
+title: cordova-plugin-contacts
+plugin_name: cordova-plugin-contacts
+plugin_version: master
+---
+
+<!-- WARNING: This file is generated. See fetch_docs.js. -->
+
+<!---
+# 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.
+-->
+
+[](https://travis-ci.org/apache/cordova-plugin-contacts)
+
+# cordova-plugin-contacts
+
+This plugin defines a global `navigator.contacts` object, which provides access to the device contacts database.
+
+Although the object is attached to the global scoped `navigator`, it is not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log(navigator.contacts);
+ }
+
+__WARNING__: Collection and use of contact data raises
+important privacy issues. Your app's privacy policy should discuss
+how the app uses contact data and whether it is shared with any other
+parties. Contact information is considered sensitive because it
+reveals the people with whom a person communicates. Therefore, in
+addition to the app's privacy policy, you should strongly consider
+providing a just-in-time notice before the app accesses or uses
+contact data, if the device operating system doesn't do so
+already. That notice should provide the same information noted above,
+as well as obtaining the user's permission (e.g., by presenting
+choices for __OK__ and __No Thanks__). Note that some app
+marketplaces may require the app to provide a just-in-time notice and
+obtain the user's permission before accessing contact data. A
+clear and easy-to-understand user experience surrounding the use of
+contact data helps avoid user confusion and perceived misuse of
+contact data. For more information, please see the [Privacy Guide](http://cordova.apache.org/docs/en/latest/guide/appdev/privacy/index.html).
+
+Report issues with this plugin on the [Apache Cordova issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Contacts%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
+
+## Installation
+
+This requires cordova 5.0+ ( current stable v1.0.0 )
+
+ cordova plugin add cordova-plugin-contacts
+Older versions of cordova can still install via the __deprecated__ id ( stale v0.2.16 )
+
+ cordova plugin add org.apache.cordova.contacts
+It is also possible to install via repo url directly ( unstable )
+
+ cordova plugin add https://github.com/apache/cordova-plugin-contacts.git
+
+
+### Firefox OS Quirks
+
+Create __www/manifest.webapp__ as described in
+[Manifest Docs](https://developer.mozilla.org/en-US/Apps/Developing/Manifest).
+Add relevant permisions.
+There is also a need to change the webapp type to "privileged" - [Manifest Docs](https://developer.mozilla.org/en-US/Apps/Developing/Manifest#type).
+__WARNING__: All privileged apps enforce [Content Security Policy](https://developer.mozilla.org/en-US/Apps/CSP) which forbids inline script. Initialize your application in another way.
+
+ "type": "privileged",
+ "permissions": {
+ "contacts": {
+ "access": "readwrite",
+ "description": "Describe why there is a need for such permission"
+ }
+ }
+
+### Windows Quirks
+
+**Prior to Windows 10:** Any contacts returned from `find` and `pickContact` methods are readonly, so your application cannot modify them.
+`find` method available only on Windows Phone 8.1 devices.
+
+**Windows 10 and above:** Contacts may be saved and will be saved to app-local contacts storage. Contacts may also be deleted.
+
+### Windows 8 Quirks
+
+Windows 8 Contacts are readonly. Via the Cordova API Contacts are not queryable/searchable, you should inform the user to pick a contact as a call to contacts.pickContact which will open the 'People' app where the user must choose a contact.
+Any contacts returned are readonly, so your application cannot modify them.
+
+## navigator.contacts
+
+### Methods
+
+- navigator.contacts.create
+- navigator.contacts.find
+- navigator.contacts.pickContact
+
+### Objects
+
+- Contact
+- ContactName
+- ContactField
+- ContactAddress
+- ContactOrganization
+- ContactFindOptions
+- ContactError
+- ContactFieldType
+
+## navigator.contacts.create
+
+The `navigator.contacts.create` method is synchronous, and returns a new `Contact` object.
+
+This method does not retain the Contact object in the device contacts
+database, for which you need to invoke the `Contact.save` method.
+
+### Supported Platforms
+
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+
+### Example
+
+ var myContact = navigator.contacts.create({"displayName": "Test User"});
+
+## navigator.contacts.find
+
+The `navigator.contacts.find` method executes asynchronously, querying the
+device contacts database and returning an array of `Contact` objects.
+The resulting objects are passed to the `contactSuccess` callback
+function specified by the __contactSuccess__ parameter.
+
+The __contactFields__ parameter specifies the fields to be used as a
+search qualifier. A zero-length __contactFields__ parameter is invalid and results in
+`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
+`"*"` searches all contact fields.
+
+The __contactFindOptions.filter__ string can be used as a search
+filter when querying the contacts database. If provided, a
+case-insensitive, partial value match is applied to each field
+specified in the __contactFields__ parameter. If there's a match for
+_any_ of the specified fields, the contact is returned. Use __contactFindOptions.desiredFields__
+parameter to control which contact properties must be returned back.
+
+Supported values for both __contactFields__ and __contactFindOptions.desiredFields__ parameters are enumerated in [`ContactFieldType`](#contactfieldtype) object.
+
+### Parameters
+
+- __contactFields__: Contact fields to use as a search qualifier. _(DOMString[])_ [Required]
+
+- __contactSuccess__: Success callback function invoked with the array of Contact objects returned from the database. [Required]
+
+- __contactError__: Error callback function, invoked when an error occurs. [Optional]
+
+- __contactFindOptions__: Search options to filter navigator.contacts. [Optional]
+
+ Keys include:
+
+ - __filter__: The search string used to find navigator.contacts. _(DOMString)_ (Default: `""`)
+
+ - __multiple__: Determines if the find operation returns multiple navigator.contacts. _(Boolean)_ (Default: `false`)
+
+ - __desiredFields__: Contact fields to be returned back. If specified, the resulting `Contact` object only features values for these fields. _(DOMString[])_ [Optional]
+
+ - __hasPhoneNumber__(Android only): Filters the search to only return contacts with a phone number informed. _(Boolean)_ (Default: `false`)
+
+### Supported Platforms
+
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows (Windows Phone 8.1 and Windows 10)
+
+### Example
+
+ function onSuccess(contacts) {
+ alert('Found ' + contacts.length + ' contacts.');
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ // find all contacts with 'Bob' in any name field
+ var options = new ContactFindOptions();
+ options.filter = "Bob";
+ options.multiple = true;
+ options.desiredFields = [navigator.contacts.fieldType.id];
+ options.hasPhoneNumber = true;
+ var fields = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name];
+ navigator.contacts.find(fields, onSuccess, onError, options);
+
+### Windows Quirks
+
+- `__contactFields__` is not supported and will be ignored. `find` method will always attempt to match the name, email address, or phone number of a contact.
+
+## navigator.contacts.pickContact
+
+The `navigator.contacts.pickContact` method launches the Contact Picker to select a single contact.
+The resulting object is passed to the `contactSuccess` callback
+function specified by the __contactSuccess__ parameter.
+
+### Parameters
+
+- __contactSuccess__: Success callback function invoked with the single Contact object. [Required]
+
+- __contactError__: Error callback function, invoked when an error occurs. [Optional]
+
+### Supported Platforms
+
+- Android
+- iOS
+- Windows Phone 8
+- Windows
+
+### Example
+
+ navigator.contacts.pickContact(function(contact){
+ console.log('The following contact has been selected:' + JSON.stringify(contact));
+ },function(err){
+ console.log('Error: ' + err);
+ });
+
+### Android Quirks
+
+This plugin launches an external Activity for picking contacts. See the
+[Android Lifecycle Guide](http://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html#lifecycle-guide)
+for an explanation of how this affects your application. If the plugin returns
+its result in the `resume` event, then you must first wrap the returned object
+in a `Contact` object before using it. Here is an example:
+
+```javascript
+function onResume(resumeEvent) {
+ if(resumeEvent.pendingResult) {
+ if(resumeEvent.pendingResult.pluginStatus === "OK") {
+ var contact = navigator.contacts.create(resumeEvent.pendingResult.result);
+ successCallback(contact);
+ } else {
+ failCallback(resumeEvent.pendingResult.result);
+ }
+ }
+}
+```
+
+## Contact
+
+The `Contact` object represents a user's contact. Contacts can be
+created, stored, or removed from the device contacts database.
+Contacts can also be retrieved (individually or in bulk) from the
+database by invoking the `navigator.contacts.find` method.
+
+__NOTE__: Not all of the contact fields listed above are supported on
+every device platform. Please check each platform's _Quirks_ section
+for details.
+
+
+### Properties
+
+- __id__: A globally unique identifier. _(DOMString)_
+
+- __displayName__: The name of this Contact, suitable for display to end users. _(DOMString)_
+
+- __name__: An object containing all components of a persons name. _(ContactName)_
+
+- __nickname__: A casual name by which to address the contact. _(DOMString)_
+
+- __phoneNumbers__: An array of all the contact's phone numbers. _(ContactField[])_
+
+- __emails__: An array of all the contact's email addresses. _(ContactField[])_
+
+- __addresses__: An array of all the contact's addresses. _(ContactAddress[])_
+
+- __ims__: An array of all the contact's IM addresses. _(ContactField[])_
+
+- __organizations__: An array of all the contact's organizations. _(ContactOrganization[])_
+
+- __birthday__: The birthday of the contact. _(Date)_
+
+- __note__: A note about the contact. _(DOMString)_
+
+- __photos__: An array of the contact's photos. _(ContactField[])_
+
+- __categories__: An array of all the user-defined categories associated with the contact. _(ContactField[])_
+
+- __urls__: An array of web pages associated with the contact. _(ContactField[])_
+
+### Methods
+
+- __clone__: Returns a new `Contact` object that is a deep copy of the calling object, with the `id` property set to `null`.
+
+- __remove__: Removes the contact from the device contacts database, otherwise executes an error callback with a `ContactError` object.
+
+- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows
+
+### Save Example
+
+ function onSuccess(contact) {
+ alert("Save Success");
+ };
+
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
+
+ // create a new contact object
+ var contact = navigator.contacts.create();
+ contact.displayName = "Plumber";
+ contact.nickname = "Plumber"; // specify both to support all devices
+
+ // populate some fields
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
+
+ // save to device
+ contact.save(onSuccess,onError);
+
+### Clone Example
+
+ // clone the contact object
+ var clone = contact.clone();
+ clone.name.givenName = "John";
+ console.log("Original contact name = " + contact.name.givenName);
+ console.log("Cloned contact name = " + clone.name.givenName);
+
+### Remove Example
+
+ function onSuccess() {
+ alert("Removal Success");
+ };
+
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
+
+ // remove the contact from the device
+ contact.remove(onSuccess,onError);
+
+
+### Android 2.X Quirks
+
+- __categories__: Not supported on Android 2.X devices, returning `null`.
+
+### BlackBerry 10 Quirks
+
+- __id__: Assigned by the device when saving the contact.
+
+### FirefoxOS Quirks
+
+- __categories__: Partially supported. Fields __pref__ and __type__ are returning `null`
+
+- __ims__: Not supported
+
+- __photos__: Not supported
+
+
+### iOS Quirks
+
+- __displayName__: Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
+
+- __birthday__: Must be input as a JavaScript `Date` object, the same way it is returned.
+
+- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
+
+- __categories__: This property is currently not supported, returning `null`.
+
+### Windows Phone 8 Quirks
+
+- __displayName__: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
+
+- __urls__: When creating a contact, users can input and save more than one web address, but only one is available when searching the contact.
+
+- __phoneNumbers__: The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
+
+- __emails__: The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
+
+- __addresses__: Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
+
+- __organizations__: Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
+
+- __note__: Not supported, returning `null`.
+
+- __ims__: Not supported, returning `null`.
+
+- __birthdays__: Not supported, returning `null`.
+
+- __categories__: Not supported, returning `null`.
+
+- __remove__: Method is not supported
+
+### Windows Quirks
+
+- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory.
+
+- __birthdays__: Not supported, returning `null`.
+
+- __categories__: Not supported, returning `null`.
+
+- __remove__: Method is only supported in Windows 10 or above.
+
+## ContactAddress
+
+The `ContactAddress` object stores the properties of a single address
+of a contact. A `Contact` object may include more than one address in
+a `ContactAddress[]` array.
+
+
+### Properties
+
+- __pref__: Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
+
+- __type__: A string indicating what type of field this is, _home_ for example. _(DOMString)_
+
+- __formatted__: The full address formatted for display. _(DOMString)_
+
+- __streetAddress__: The full street address. _(DOMString)_
+
+- __locality__: The city or locality. _(DOMString)_
+
+- __region__: The state or region. _(DOMString)_
+
+- __postalCode__: The zip code or postal code. _(DOMString)_
+
+- __country__: The country name. _(DOMString)_
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows
+
+### Example
+
+ // display the address information for all contacts
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].addresses.length; j++) {
+ alert("Pref: " + contacts[i].addresses[j].pref + "\n" +
+ "Type: " + contacts[i].addresses[j].type + "\n" +
+ "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
+ "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
+ "Locality: " + contacts[i].addresses[j].locality + "\n" +
+ "Region: " + contacts[i].addresses[j].region + "\n" +
+ "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
+ "Country: " + contacts[i].addresses[j].country);
+ }
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ // find all contacts
+ var options = new ContactFindOptions();
+ options.filter = "";
+ options.multiple = true;
+ var filter = ["displayName", "addresses"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+### Android 2.X Quirks
+
+- __pref__: Not supported, returning `false` on Android 2.X devices.
+
+### BlackBerry 10 Quirks
+
+- __pref__: Not supported on BlackBerry devices, returning `false`.
+
+- __type__: Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
+
+- __formatted__: Partially supported. Returns a concatenation of all BlackBerry address fields.
+
+- __streetAddress__: Supported. Returns a concatenation of BlackBerry __address1__ and __address2__ address fields.
+
+- __locality__: Supported. Stored in BlackBerry __city__ address field.
+
+- __region__: Supported. Stored in BlackBerry __stateProvince__ address field.
+
+- __postalCode__: Supported. Stored in BlackBerry __zipPostal__ address field.
+
+- __country__: Supported.
+
+### FirefoxOS Quirks
+
+- __formatted__: Currently not supported
+
+### iOS Quirks
+
+- __pref__: Not supported on iOS devices, returning `false`.
+
+- __formatted__: Currently not supported.
+
+### Windows Quirks
+
+- __pref__: Not supported
+
+
+## ContactError
+
+The `ContactError` object is returned to the user through the
+`contactError` callback function when an error occurs.
+
+### Properties
+
+- __code__: One of the predefined error codes listed below.
+
+### Constants
+
+- `ContactError.UNKNOWN_ERROR` (code 0)
+- `ContactError.INVALID_ARGUMENT_ERROR` (code 1)
+- `ContactError.TIMEOUT_ERROR` (code 2)
+- `ContactError.PENDING_OPERATION_ERROR` (code 3)
+- `ContactError.IO_ERROR` (code 4)
+- `ContactError.NOT_SUPPORTED_ERROR` (code 5)
+- `ContactError.OPERATION_CANCELLED_ERROR` (code 6)
+- `ContactError.PERMISSION_DENIED_ERROR` (code 20)
+
+
+## ContactField
+
+The `ContactField` object is a reusable component that represents
+contact fields generically. Each `ContactField` object contains a
+`value`, `type`, and `pref` property. A `Contact` object stores
+several properties in `ContactField[]` arrays, such as phone numbers
+and email addresses.
+
+In most instances, there are no pre-determined values for a
+`ContactField` object's __type__ attribute. For example, a phone
+number can specify __type__ values of _home_, _work_, _mobile_,
+_iPhone_, or any other value that is supported by a particular device
+platform's contact database. However, for the `Contact` __photos__
+field, the __type__ field indicates the format of the returned image:
+__url__ when the __value__ attribute contains a URL to the photo
+image, or _base64_ when the __value__ contains a base64-encoded image
+string.
+
+### Properties
+
+- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)_
+
+- __value__: The value of the field, such as a phone number or email address. _(DOMString)_
+
+- __pref__: Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows
+
+### Example
+
+ // create a new contact
+ var contact = navigator.contacts.create();
+
+ // store contact phone numbers in ContactField[]
+ var phoneNumbers = [];
+ phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
+ phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
+ phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
+ contact.phoneNumbers = phoneNumbers;
+
+ // save the contact
+ contact.save();
+
+### Android Quirks
+
+- __pref__: Not supported, returning `false`.
+
+### BlackBerry 10 Quirks
+
+- __type__: Partially supported. Used for phone numbers.
+
+- __value__: Supported.
+
+- __pref__: Not supported, returning `false`.
+
+### iOS Quirks
+
+- __pref__: Not supported, returning `false`.
+
+### Windows Quirks
+
+- __pref__: Not supported, returning `false`.
+
+
+## ContactName
+
+Contains different kinds of information about a `Contact` object's name.
+
+### Properties
+
+- __formatted__: The complete name of the contact. _(DOMString)_
+
+- __familyName__: The contact's family name. _(DOMString)_
+
+- __givenName__: The contact's given name. _(DOMString)_
+
+- __middleName__: The contact's middle name. _(DOMString)_
+
+- __honorificPrefix__: The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
+
+- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
+
+### Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows
+
+### Example
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ alert("Formatted: " + contacts[i].name.formatted + "\n" +
+ "Family Name: " + contacts[i].name.familyName + "\n" +
+ "Given Name: " + contacts[i].name.givenName + "\n" +
+ "Middle Name: " + contacts[i].name.middleName + "\n" +
+ "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
+ "Prefix: " + contacts[i].name.honorificSuffix);
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ var options = new ContactFindOptions();
+ options.filter = "";
+ options.multiple = true;
+ filter = ["displayName", "name"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+### Android Quirks
+
+- __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
+
+### BlackBerry 10 Quirks
+
+- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
+
+- __familyName__: Supported. Stored in BlackBerry __lastName__ field.
+
+- __givenName__: Supported. Stored in BlackBerry __firstName__ field.
+
+- __middleName__: Not supported, returning `null`.
+
+- __honorificPrefix__: Not supported, returning `null`.
+
+- __honorificSuffix__: Not supported, returning `null`.
+
+### FirefoxOS Quirks
+
+- __formatted__: Partially supported, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
+
+
+### iOS Quirks
+
+- __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
+
+### Windows Quirks
+
+- __formatted__: This is the only name property, and is identical to `displayName`, and `nickname`
+
+- __familyName__: not supported
+
+- __givenName__: not supported
+
+- __middleName__: not supported
+
+- __honorificPrefix__: not supported
+
+- __honorificSuffix__: not supported
+
+
+## ContactOrganization
+
+The `ContactOrganization` object stores a contact's organization
+properties. A `Contact` object stores one or more
+`ContactOrganization` objects in an array.
+
+### Properties
+
+- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
+
+- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)
+
+- __name__: The name of the organization. _(DOMString)_
+
+- __department__: The department the contract works for. _(DOMString)_
+
+- __title__: The contact's title at the organization. _(DOMString)_
+
+
+### Supported Platforms
+
+- Android
+- BlackBerry 10
+- Firefox OS
+- iOS
+- Windows Phone 8
+- Windows (Windows 8.1 and Windows Phone 8.1 devices only)
+
+### Example
+
+ function onSuccess(contacts) {
+ for (var i = 0; i < contacts.length; i++) {
+ for (var j = 0; j < contacts[i].organizations.length; j++) {
+ alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
+ "Type: " + contacts[i].organizations[j].type + "\n" +
+ "Name: " + contacts[i].organizations[j].name + "\n" +
+ "Department: " + contacts[i].organizations[j].department + "\n" +
+ "Title: " + contacts[i].organizations[j].title);
+ }
+ }
+ };
+
+ function onError(contactError) {
+ alert('onError!');
+ };
+
+ var options = new ContactFindOptions();
+ options.filter = "";
+ options.multiple = true;
+ filter = ["displayName", "organizations"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
+
+### Android 2.X Quirks
+
+- __pref__: Not supported by Android 2.X devices, returning `false`.
+
+### BlackBerry 10 Quirks
+
+- __pref__: Not supported by BlackBerry devices, returning `false`.
+
+- __type__: Not supported by BlackBerry devices, returning `null`.
+
+- __name__: Partially supported. The first organization name is stored in the BlackBerry __company__ field.
+
+- __department__: Not supported, returning `null`.
+
+- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
+
+### Firefox OS Quirks
+
+- __pref__: Not supported
+
+- __type__: Not supported
+
+- __department__: Not supported
+
+- Fields __name__ and __title__ stored in __org__ and __jobTitle__.
+
+### iOS Quirks
+
+- __pref__: Not supported on iOS devices, returning `false`.
+
+- __type__: Not supported on iOS devices, returning `null`.
+
+- __name__: Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
+
+- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
+
+- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
+
+### Windows Quirks
+
+- __pref__: Not supported, returning `false`.
+
+- __type__: Not supported, returning `null`.
+
+## ContactFieldType
+The `ContactFieldType` object is an enumeration of possible field types, such as `'phoneNumbers'` or `'emails'`, that could be used to control which contact properties must be returned back from `contacts.find()` method (see `contactFindOptions.desiredFields`), or to specify fields to search in (through `contactFields` parameter). Possible values are:
+
+- `navigator.contacts.fieldType.addresses`
+- `navigator.contacts.fieldType.birthday`
+- `navigator.contacts.fieldType.categories`
+- `navigator.contacts.fieldType.country`
+- `navigator.contacts.fieldType.department`
+- `navigator.contacts.fieldType.displayName`
+- `navigator.contacts.fieldType.emails`
+- `navigator.contacts.fieldType.familyName`
+- `navigator.contacts.fieldType.formatted`
+- `navigator.contacts.fieldType.givenName`
+- `navigator.contacts.fieldType.honorificPrefix`
+- `navigator.contacts.fieldType.honorificSuffix`
+- `navigator.contacts.fieldType.id`
+- `navigator.contacts.fieldType.ims`
+- `navigator.contacts.fieldType.locality`
+- `navigator.contacts.fieldType.middleName`
+- `navigator.contacts.fieldType.name`
+- `navigator.contacts.fieldType.nickname`
+- `navigator.contacts.fieldType.note`
+- `navigator.contacts.fieldType.organizations`
+- `navigator.contacts.fieldType.phoneNumbers`
+- `navigator.contacts.fieldType.photos`
+- `navigator.contacts.fieldType.postalCode`
+- `navigator.contacts.fieldType.region`
+- `navigator.contacts.fieldType.streetAddress`
+- `navigator.contacts.fieldType.title`
+- `navigator.contacts.fieldType.urls`
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org