You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2016/08/23 06:04:03 UTC
[1/6] docs commit: Added android ios release blog post
Repository: cordova-docs
Updated Branches:
refs/heads/master f8faa21e7 -> 73e80e450
Added android ios release blog post
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/0d1574f4
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/0d1574f4
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/0d1574f4
Branch: refs/heads/master
Commit: 0d1574f4ef4b42d4128ed937f4609269a9105ec4
Parents: f8faa21
Author: Steve Gill <st...@gmail.com>
Authored: Mon Aug 22 17:43:42 2016 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Mon Aug 22 18:19:52 2016 -0700
----------------------------------------------------------------------
www/_posts/2016-08-22-android-ios-release.md | 48 +++++++++++++++++++++++
1 file changed, 48 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/0d1574f4/www/_posts/2016-08-22-android-ios-release.md
----------------------------------------------------------------------
diff --git a/www/_posts/2016-08-22-android-ios-release.md b/www/_posts/2016-08-22-android-ios-release.md
new file mode 100644
index 0000000..cae2e70
--- /dev/null
+++ b/www/_posts/2016-08-22-android-ios-release.md
@@ -0,0 +1,48 @@
+---
+layout: post
+author:
+ name: Steve Gill
+ url: https://twitter.com/stevesgill
+title: "Cordova Android 5.2.2 & Cordova iOS 4.2.1 Released!"
+categories: announcements
+tags: news releases
+---
+
+We are happy to announce patch releases for`Cordova Android 5.2.2` & `Cordova iOS 4.2.1` have been released! We have also updated and released `Cordova Common 1.4.1`.
+
+These release fixes issues with the upcoming `edit-config` functionality coming to `plugin.xml`.
+
+To upgrade:
+
+ npm install -g cordova
+ cd my_project
+ cordova platform update android@5.2.2
+ cordova platform update ios@4.2.1
+
+To add it explicitly:
+
+ cordova platform add android@5.2.2
+ cordova platform add ios@4.2.1
+
+<!--more-->
+## What's new in Android
+
+* [CB-11615](https://issues.apache.org/jira/browse/CB-11615) updated `cordoova-common` to `1.4.0`
+
+## What's new in iOS
+
+* [CB-11627](https://issues.apache.org/jira/browse/CB-11627) updated `CDVAvailability.h` with new version
+* [CB-11627](https://issues.apache.org/jira/browse/CB-11627) added missing license header
+* [CB-11627](https://issues.apache.org/jira/browse/CB-11627) Updated checked-in `node_modules`
+* [CB-9371](https://issues.apache.org/jira/browse/CB-9371) Fix how prepare handles orientation on **ios**
+* [CB-11431](https://issues.apache.org/jira/browse/CB-11431) Document ways to update delegates, preferences and script message handlers in `WebViewEngines`
+* [CB-11475](https://issues.apache.org/jira/browse/CB-11475) Ignore unsupported 60x60 icon
+* [CB-11426](https://issues.apache.org/jira/browse/CB-11426) Hardcoded path should not be in tests project.
+
+## Cordova Common Changes
+
+* Added general purpose `ConfigParser.getAttribute` API
+* [CB-11653](https://issues.apache.org/jira/browse/CB-11653) moved `findProjectRoot` from `cordova-lib` to `cordova-common`
+* [CB-11636](https://issues.apache.org/jira/browse/CB-11636) Handle attributes with quotes correctly
+* [CB-11645](https://issues.apache.org/jira/browse/CB-11645) added check to see if `getEditConfig` exists before trying to use it
+* [CB-9825](https://issues.apache.org/jira/browse/CB-9825) framework tag spec parsing
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[6/6] docs commit: added link to release blog post
Posted by st...@apache.org.
added link to release blog post
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/73e80e45
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/73e80e45
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/73e80e45
Branch: refs/heads/master
Commit: 73e80e450b2976d1596f20b3f41fa112daf701b8
Parents: d24004a
Author: Steve Gill <st...@gmail.com>
Authored: Mon Aug 22 22:36:41 2016 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Mon Aug 22 23:03:15 2016 -0700
----------------------------------------------------------------------
www/_posts/2016-08-22-android-ios-release.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/73e80e45/www/_posts/2016-08-22-android-ios-release.md
----------------------------------------------------------------------
diff --git a/www/_posts/2016-08-22-android-ios-release.md b/www/_posts/2016-08-22-android-ios-release.md
index 5111e9a..052fc36 100644
--- a/www/_posts/2016-08-22-android-ios-release.md
+++ b/www/_posts/2016-08-22-android-ios-release.md
@@ -10,7 +10,7 @@ tags: news releases
We are happy to announce patch releases for`Cordova Android 5.2.2` & `Cordova iOS 4.2.1` have been released! We have also updated and released `Cordova Common 1.4.1`.
-These release fixes issues with the upcoming `edit-config` functionality coming to `plugin.xml`.
+These release fixes issues with the new `edit-config` functionality in `plugin.xml`. Read more about `edit-config` at [http://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#edit-config](http://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#edit-config).
**Note:** When updating **iOS**, make sure to save your plugins as current unsaved plugins may not be reinstalled otherwise. Run the following command in your project to save your currently installed plugins into `config.xml`:
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[5/6] docs commit: copied dev docsinto 6.x for english
Posted by st...@apache.org.
copied dev docsinto 6.x for english
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d24004ab
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d24004ab
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d24004ab
Branch: refs/heads/master
Commit: d24004ab3f6119fe0a62add76e4afa47260fd9ac
Parents: 52bf193
Author: Steve Gill <st...@gmail.com>
Authored: Mon Aug 22 22:26:18 2016 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Mon Aug 22 22:26:18 2016 -0700
----------------------------------------------------------------------
www/docs/en/6.x/config_ref/index.md | 5 +-
www/docs/en/6.x/cordova/events/events.md | 39 ++
www/docs/en/6.x/guide/appdev/hooks/index.md | 5 +
www/docs/en/6.x/guide/cli/index.md | 2 +
www/docs/en/6.x/guide/cli/template.md | 72 +++
www/docs/en/6.x/guide/hybrid/plugins/index.md | 48 +-
www/docs/en/6.x/guide/next/index.md | 2 +
www/docs/en/6.x/guide/platforms/ubuntu/index.md | 198 ++++++--
www/docs/en/6.x/guide/support/index.md | 29 +-
.../6.x/platform_plugin_versioning_ref/index.md | 11 +-
www/docs/en/6.x/plugin_ref/spec.md | 106 +++++
www/docs/en/6.x/reference/cordova-cli/index.md | 110 +----
.../cordova-plugin-battery-status/index.md | 3 +-
.../reference/cordova-plugin-camera/index.md | 247 +---------
.../reference/cordova-plugin-console/index.md | 3 +-
.../reference/cordova-plugin-contacts/index.md | 324 ++++++-------
.../cordova-plugin-device-motion/index.md | 5 +-
.../cordova-plugin-device-orientation/index.md | 5 +-
.../reference/cordova-plugin-device/index.md | 3 +-
.../reference/cordova-plugin-dialogs/index.md | 7 +-
.../cordova-plugin-file-transfer/index.md | 460 ++++---------------
.../6.x/reference/cordova-plugin-file/index.md | 330 +------------
.../cordova-plugin-geolocation/index.md | 459 +-----------------
.../cordova-plugin-globalization/index.md | 3 +-
.../cordova-plugin-inappbrowser/index.md | 234 +---------
.../cordova-plugin-legacy-whitelist/index.md | 3 +-
.../cordova-plugin-media-capture/index.md | 43 +-
.../6.x/reference/cordova-plugin-media/index.md | 132 +-----
.../cordova-plugin-network-information/index.md | 123 +----
.../cordova-plugin-splashscreen/index.md | 126 ++---
.../reference/cordova-plugin-statusbar/index.md | 3 +-
.../reference/cordova-plugin-vibration/index.md | 3 +-
.../reference/cordova-plugin-whitelist/index.md | 3 +-
33 files changed, 773 insertions(+), 2373 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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 62e0cd0..5cb9cf5 100644
--- a/www/docs/en/6.x/config_ref/index.md
+++ b/www/docs/en/6.x/config_ref/index.md
@@ -63,6 +63,7 @@ Attributes(type) <br/> <span class="sub-header">Only for platform:</span> | Desc
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.
android-versionCode(string) <br/> ==Android== | Alternative version for Android. Sets the [version code](http://developer.android.com/tools/publishing/versioning.html) for the application. See [the Android guide](../guide/platforms/android/index.html#setting-the-version-code) for information on how this attribute may be modified.
+defaultlocale <br /> ==iOS== | Specified the default language of the app, as an IANA language code.
ios-CFBundleVersion(string) <br/> ==iOS== | 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) <br/> ==OS X== | 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).
windows-packageVersion(string) <br/> ==Windows== | Alternative version for Windows. For futher details, see [Windows versioning](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx)
@@ -160,11 +161,11 @@ Examples:
```xml
<widget ...>
- <access origin="*"></content>
+ <access origin="*"></access>
</widget>
<widget ...>
- <access origin="http://google.com"></content>
+ <access origin="http://google.com"></access>
</widget>
```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/cordova/events/events.md b/www/docs/en/6.x/cordova/events/events.md
index 0e988bf..586e223 100644
--- a/www/docs/en/6.x/cordova/events/events.md
+++ b/www/docs/en/6.x/cordova/events/events.md
@@ -185,6 +185,15 @@ The following table lists the cordova events and the supported platforms:
<td data-col="winphone8" class="n"></td>
<td data-col="win" class="n"></td>
</tr>
+
+ <tr>
+ <th><a href="#activated">activated</a></th>
+ <td data-col="android" class="n"></td>
+ <td data-col="blackberry10" class="n"></td>
+ <td data-col="ios" class="n"></td>
+ <td data-col="winphone8" class="n"></td>
+ <td data-col="win" class="y"></td>
+ </tr>
</tbody>
</table>
@@ -433,5 +442,35 @@ function onVolumeUpKeyDown() {
}
```
+## activated
+
+The event fires when Windows Runtime activation has occurred. See [MSDN docs][MSDNActivatedEvent] for further details and activation types.
+
+### Quick Example
+
+```javascript
+document.addEventListener("activated", activated, false);
+
+function activated(args) {
+ if (args && args.kind === Windows.ApplicationModel.Activation.ActivationKind.file) {
+ // Using args.raw to get the native StorageFile object
+ Windows.Storage.FileIO.readTextAsync(args.raw.detail[0].files[0]).done(function (text) {
+ console.log(text);
+ }, function (err) {
+ console.error(err);
+ });
+ }
+}
+```
+
+### Windows Quirks
+
+* Original activated event args are available in `args.raw.detail[0]` property and can be used to get a type information or invoke methods of one of the activation arguments,
+
+* Original activated event args are also cloned to `args.detail[0]` and can be used as a fallback in case an inner args property has been lost.
+See https://issues.apache.org/jira/browse/CB-10653 for details.
+
+
[UIApplicationExitsOnSuspend]: http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html
[AndroidLifeCycleGuide]: ../../guide/platforms/android/lifecycle.html
+[MSDNActivatedEvent]: https://msdn.microsoft.com/en-us/library/windows/apps/br212679.aspx
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/appdev/hooks/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/appdev/hooks/index.md b/www/docs/en/6.x/guide/appdev/hooks/index.md
index dbd4c3f..2d52f2c 100644
--- a/www/docs/en/6.x/guide/appdev/hooks/index.md
+++ b/www/docs/en/6.x/guide/appdev/hooks/index.md
@@ -98,6 +98,11 @@ Cordova supports the following hook types:
<th data-col="aftercompile">after_compile</th>
</tr>
<tr>
+ <th data-col="beforedeploy">before_deploy</th>
+ <td data-col="code"><code>cordova emulate</code><br/><code>cordova run</code></td>
+ <td data-col="description">To be executed before deploying your application.</td>
+ </tr>
+ <tr>
<th data-col="beforebuild">before_build</th>
<td data-col="code" rowspan="2"><code>cordova build</code></td>
<td rowspan="2" data-col="description">To be executed before and after building your application.</td>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/cli/index.md b/www/docs/en/6.x/guide/cli/index.md
index c50d3db..0e0f393 100644
--- a/www/docs/en/6.x/guide/cli/index.md
+++ b/www/docs/en/6.x/guide/cli/index.md
@@ -85,6 +85,7 @@ This creates the required directory structure for your cordova app. By default,
###See Also
- [Cordova create command reference documentation][cdv_create]
- [Cordova project directory structure][cdv_dir]
+- [Cordova project templates][cdv_template]
## Add Platforms
@@ -319,6 +320,7 @@ $ cordova platform update ios --save
[DeviceReadyEvent]: ../../cordova/events/events.html#deviceready
[BackButtonEvent]: ../../cordova/events/events.html#backbutton
[Core Plugin APIs]: ../../guide/support/index.html#core-plugin-apis
+[cdv_template]: ../../guide/cli/template.html#
[CLI reference]: ../../reference/cordova-cli/index.html
[cdv_create]: ../../reference/cordova-cli/index.html#cordova-create-command
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/cli/template.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/cli/template.md b/www/docs/en/6.x/guide/cli/template.md
new file mode 100644
index 0000000..b3dd068
--- /dev/null
+++ b/www/docs/en/6.x/guide/cli/template.md
@@ -0,0 +1,72 @@
+---
+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: Cordova App Templates
+description: Learn how to find, use, and create templates in Cordova.
+toc_title: Templates for apps
+
+---
+
+# Cordova App Templates
+
+## Use a Template
+
+Templates allow you to use preexisting code to jumpstart your project.
+
+
+
+Find a template to create your app from by seaching for the keyword `cordova:template` on [npm](https://www.npmjs.com/search?q=cordova%3Atemplate). You can also use local templates on your computer, or a Git repository.
+
+After locating a template you wish to use. Create your project using that template, by specifying the `--template` flag during the `create` command, followed by your template source.
+
+Creating a cordova project from an NPM package, Git repository, or local path:
+```
+$ cordova create hello com.example.hello HelloWorld --template <npm-package-name>
+$ cordova create hello com.example.hello HelloWorld --template <git-remote-url>
+$ cordova create hello com.example.hello HelloWorld --template <path-to-template>
+```
+
+After succesfully using a template to create your project, you'll want to indicate the platforms that you intend to target with your app. Go into your project folder and [add platforms](http://cordova.apache.org/docs/en/latest/guide/cli/index.html#add-platforms).
+
+## Create a Template
+
+Begin by creating a cordova app that will become the basis for your template. Then you'll take the contents of your app and put them into the following structure. When your template is used, all of the contents within `template_src` will be used to create the new project, so be sure to include any necessary files in that folder. Reference [this example](https://github.com/carynbear/cordova-template) for details.
+
+```
+template_package/
+\u251c\u2500\u2500 package.json (optional; needed to publish template on npm)
+\u251c\u2500\u2500 index.js (required)
+\u2514\u2500\u2500 template_src/ (required)
+ \u2514\u2500\u2500 CONTENTS OF APP TEMPLATE
+```
+> __NOTE__: `index.js` should export a reference to `template_src` and `package.json` should reference `index.js`. See [the example](https://github.com/carynbear/cordova-template) for details on how that is done.
+
+To finish off your template, edit `package.json` to contain the keyword `"cordova:template"`.
+```javascript
+{
+ ...
+ "keywords": [
+ "ecosystem:cordova",
+ "cordova:template"
+ ]
+ ...
+}
+```
+
+Congrats! You've made a template for creating a Cordova project. Share your template on npm so that everyone can benefit from your hard work.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/hybrid/plugins/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/hybrid/plugins/index.md b/www/docs/en/6.x/guide/hybrid/plugins/index.md
index 650b7e8..d770265 100644
--- a/www/docs/en/6.x/guide/hybrid/plugins/index.md
+++ b/www/docs/en/6.x/guide/hybrid/plugins/index.md
@@ -87,8 +87,8 @@ are available in the [Plugin Specification](../../../plugin_ref/spec.html). This
```
The top-level `plugin` tag's `id` attribute uses the same
-reverse-domain format to identify the plugin package as the apps to
-they're added. The `js-module` tag specifies the path to the common
+reverse domain format to identify the plugin package as the apps
+they're added to. The `js-module` tag specifies the path to the common
JavaScript interface. The `platform` tag specifies a corresponding
set of native code, for the `ios` platform in this case. The
`config-file` tag encapsulates a `feature` tag that is injected into
@@ -106,8 +106,8 @@ correctly for each platform. Install `plugman` with the following
npm install -g plugman
```
-You need an valid app source directory, such as the top-level `www`
-directory included in a default CLI-generated project as described in
+You need a valid app source directory, such as the top-level `www`
+directory included in a default CLI-generated project, as described in the
[Create your first app](../../cli/index.html) guide.
Then run a command such as the following to test whether iOS
@@ -121,7 +121,7 @@ For details on `plugman` options, see [Using Plugman to Manage Plugins](../../..
## The JavaScript Interface
-The JavaScript provides the front-facing interface, making it perhaps
+The JavaScript interface provides the front-facing interface, making it perhaps
the most important part of the plugin. You can structure your
plugin's JavaScript however you like, but you need to call
`cordova.exec` to communicate with the native platform, using the
@@ -178,14 +178,14 @@ window.echo("echome", function(echoValue) {
});
```
-Look at the last three arguments to the `cordova.exec` function. The
+Look at the last three arguments passed to the `cordova.exec` function. The
first calls the `Echo` _service_, a class name. The second requests
the `echo` _action_, a method within that class. The third is an array
of arguments containing the echo string, which is the `window.echo`
-function's the first parameter.
+function's first parameter.
The success callback passed into `exec` is simply a reference to the
-callback function `window.echo` takes. If the native platform fires
+callback function of `window.echo`. If the native platform fires
the error callback, it simply calls the success callback and passes it
a default string.
@@ -203,9 +203,9 @@ listed below, and each builds on the simple Echo Plugin example above:
## Publishing Plugins
-You can publish your plugin to any `npmjs`-based registry, but the recommended one is the [NPM registry](https://www.npmjs.com). Other developers can install your plugin automatically using either `plugman` or the Cordova CLI.
+You can publish your plugin to any `npmjs`-based registry, but the recommended one is the [npm registry](https://www.npmjs.com). Other developers can install your plugin automatically using either `plugman` or the Cordova CLI.
-To publish a plugin to NPM registry you need to follow steps below:
+To publish a plugin to npm you need to follow these steps:
* install the `plugman` CLI:
@@ -213,7 +213,7 @@ To publish a plugin to NPM registry you need to follow steps below:
$ npm install -g plugman
```
- * create `package.json` file for your plugin:
+ * create a `package.json` file for your plugin:
```bash
$ plugman createpackagejson /path/to/your/plugin
@@ -226,16 +226,16 @@ To publish a plugin to NPM registry you need to follow steps below:
$ npm publish /path/to/your/plugin
```
-For more details on npm usage refer to [publishing a npm package](https://docs.npmjs.com/getting-started/publishing-npm-packages) on the NPM documentation site.
+For more details on npm usage, refer to [Publishing npm Packages](https://docs.npmjs.com/getting-started/publishing-npm-packages) on the npm documentation site.
## Integrating with Plugin Search
To surface the plugin in [Cordova Plugin Search](/plugins/), add the `ecosystem:cordova` keyword to the `package.json` file of your plugin before publishing.
-To indicate support for a particular platform add a keyword with the `<platformName>` as `**cordova-<platformName>**` to the list of keywords in package.json.
+To indicate support for a particular platform, add a keyword in the format `**cordova-<platformName>**` to the list of keywords in package.json.
Plugman's `createpackagejson` command does this for you, but if you did not use it to generate your `package.json`, you should manually edit it as shown below.
-For example, for a plugin that supports android, iOS & Windows, the keywords in package.json should include:
+For example, for a plugin that supports Android, iOS & Windows, the keywords in `package.json` should include:
```json
"keywords": [
@@ -246,13 +246,13 @@ For example, for a plugin that supports android, iOS & Windows, the keywords in
]
```
-For more detailed example of a package.json, review the [package.json file of cordova-plugin-device](https://github.com/apache/cordova-plugin-device/blob/master/package.json).
+For a more detailed example of a package.json, review the [package.json file of cordova-plugin-device](https://github.com/apache/cordova-plugin-device/blob/master/package.json).
## Specifying Cordova Dependencies
**Cordova 6.1.0** added support for specifying the Cordova-related dependencies of a plugin
as part of the plugin's `package.json` file. Plugins may list the dependencies for multiple
-releases so as to provide guidance to the Cordova CLI when it is selecting the version of a
+releases to provide guidance to the Cordova CLI when it is selecting the version of a
plugin to fetch from npm. The CLI will choose the latest release of a plugin that is
compatible with the local project's installed platforms and plugins as well as the
the local Cordova CLI version. If no releases of the plugin are compatible, the CLI will warn
@@ -268,7 +268,7 @@ allows your plugin to respond to breaking changes without fear of confusing devl
are building against old platforms and plugins.
To specify Cordova-related dependencies for a plugin, alter the `engines` element in
-`package.json` to include a `cordovaDependencies` object using the following
+`package.json` to include a `cordovaDependencies` object with the following
structure:
```javascript
@@ -284,18 +284,18 @@ engines: {
}
```
-* `PLUGIN_VERSION` specifies a version of your plugin. It should adhere the syntax for a single version as defined by [npm's semver package][npm-semver] or an upper bound (see [below](#upper-bounds))
+* `PLUGIN_VERSION` specifies the version of your plugin. It should adhere to the syntax for a single version as defined by [npm's semver package][npm-semver] or an upper bound (see [below](#upper-bounds))
* `DEPENDENCY` may be one of the following:
- * The Cordova CLI, `"cordova"`
- * A Cordova platform (e.g. `"cordova-android"`, `"cordova-ios"`, `"cordova-windows"`, etc.)
- * Another Cordova plugin (e.g. `"cordova-plugin-camera"`, etc.)
+ * The Cordova CLI: `"cordova"`
+ * A Cordova platform: `"cordova-android"`, `"cordova-ios"`, `"cordova-windows"`, etc.
+ * Another Cordova plugin: `"cordova-plugin-camera"`, etc.
* `SEMVER_RANGE` should adhere to the syntax for a range as defined by [npm's semver package][npm-semver]
**NOTE:** A Cordova platform `DEPENDENCY` refers to the Cordova platform and not
-the OS (i.e. `cordova-android` rather than the Android OS)
+the OS, i.e. `cordova-android` rather than the Android OS.
Your `cordovaDependencies` may list any number of `PLUGIN_VERSION` requirements
-and any number of `DEPENDENCY` constraints within them. Versions of your plugin
+and any number of `DEPENDENCY` constraints. Versions of your plugin
that do not have their dependencies listed will be assumed to have the same
dependency information as the highest `PLUGIN_VERSION` listed below them. For
example, consider the following entry:
@@ -320,7 +320,7 @@ In addition to a single version, a `PLUGIN_VERSION` in `cordovaDependencies`
may also specify an upper bound to amend entries for older releases
of your plugin. This is useful when a breaking change occurs in a `DEPENDENCY`
and a new constraint must be added for all older versions of a plugin that do
-not support it. These bounds should be written as, a `<` followed by a single
+not support it. These bounds should be written as a `<` followed by a single
[semver][npm-semver] version (**Not an arbitrary range!**). This will apply
whatever `DEPENDENCY` values are given to all versions of the plugin below the
specified version. For example, consider the following entry:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/next/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/next/index.md b/www/docs/en/6.x/guide/next/index.md
index 165f785..6cdc1b7 100644
--- a/www/docs/en/6.x/guide/next/index.md
+++ b/www/docs/en/6.x/guide/next/index.md
@@ -153,6 +153,8 @@ With Safari's web inspector you can debug the webview and js code in your Cordov
## Chrome Remote Debugging
Virtually the same as the Safari version, this works with Android only but can be used from any desktop operating system. It requires a minimum of Android 4.4 (KitKat), minimum API level of 19, and Chrome 30+ (on the desktop). Once connected, you get the same Chrome Dev Tools experience for your mobile applications as you do with your desktop applications. Even better, the Chrome Dev Tools have a mirror option that shows your app running on the mobile device. This is more than just a view - you can scroll and click from dev tools and it updates on the mobile device. More details on Chrome Remote Debugging may be found here: [https://developers.google.com/chrome/mobile/docs/debugging](https://developers.google.com/chrome/mobile/docs/debugging)
+If you can see your device in the inspect devices section, but you can't see the Cordova webview you may need to add `android:debuggable="true"` in the `<application>` node of your `AndroidManifest.xml`.
+
It is possible to use Chrome Dev Tools to inspect iOS apps, through a WebKit proxy: [https://github.com/google/ios-webkit-debug-proxy/](https://github.com/google/ios-webkit-debug-proxy/)
## Ripple
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/platforms/ubuntu/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/platforms/ubuntu/index.md b/www/docs/en/6.x/guide/platforms/ubuntu/index.md
index 8795b3d..9fbe1ff 100644
--- a/www/docs/en/6.x/guide/platforms/ubuntu/index.md
+++ b/www/docs/en/6.x/guide/platforms/ubuntu/index.md
@@ -23,98 +23,210 @@ toc_title: Ubuntu
# Ubuntu Platform Guide
-## Initial Release
+This guide shows how to set up a development environment for creating Cordova applications for Ubuntu.
-Welcome to the initial release of Ubuntu platform support in
-Cordova. With this release, the focus is developing on an Ubuntu
-system and using the cross-platform workflow discussed in the
-[Overview](../../overview/index.html). This includes adding the Ubuntu platform to your project,
-adding standard Cordova plugins, and building and running apps for the
-Ubuntu platform.
+You will need an Ubuntu system for building applications, either running natively or in a virtual machine. You will also need an Ubuntu phone for testing your application, though an emulator can be used for basic verifications.
-### Ubuntu SDK
+## Development Platform Requirements
-You may also want to install the Ubuntu QtCreator development environment. See
-[developer.ubuntu.com](http://developer.ubuntu.com) for more info. (The
-QtCreator SDK is not required to add Ubuntu platform support to your Cordova
-app.)
+### Minimum and Recommended Versions
-### Ubuntu Runtime Platforms
+Developing Cordova apps requires a system running Ubuntu.
-Ubuntu is well known for its Desktop environment (for laptops, PCs and such).
-Ubuntu Touch extends the Ubuntu OS onto phones and tablets. Ubuntu runtime
-platforms have varying CPU architectures (x86, armhf, etc.). App and plugin
-code must be compiled appropriately. Support for this broad area is rapidly
-evolving in Ubuntu.
+The recommended environment is Ubuntu 16.04 LTS, running NodeJS 4.2.x and NPM 2.15.x.
-### Latest Information
+Packages are still available for systems running the previous LTS release (14.04) but some components like NodeJS or phablet-shell may not support all of the latest options.
+
+The target environment is an Ubuntu phone, supporting at least the ubuntu-sdk-api-15.04 framework. All phones on the market, or development images, support that framework by default.
+
+The cordova-ubuntu platform support code requires at least cordova-cli 4.3.1. This is the minimum and recommended version at the time of this writing. cordova-ubuntu 4.3.x releases are all compatible with that tool release.
For the latest information on Cordova app support for Ubuntu runtime platforms,
see [wiki.ubuntu.com/Cordova](http://wiki.ubuntu.com/Cordova).
-## Development Platform Requirements
+## Installing the Development Environment
+
+### Install Ubuntu
+
+Installation images of Ubuntu 16.04 LTS are available at http://www.ubuntu.com/download
-For this initial release, the development platform should be an Ubuntu Desktop.
-Ubuntu 13.10 (codename \u2018saucy\u2019) or later is required to enjoy the full set of
-supported capabilities.
+The simplest option is to download an Ubuntu Desktop image.
-You can install Cordova on non-Ubuntu systems (using npm), but important
-capabilities are only provided through Ubuntu debian packages at this time.
+In any case, the Debian packaging system will ensure that all underlying dependencies for the development environment will be installed. This lets you also install a build environment from an Ubuntu server installation as well.
-## Cordova Installation
+### Ubuntu Virtual Machine (optional)
+
+Ubuntu can also be used in a virtual machine.
+
+You can get an Ubuntu instance on all of the leading public clouds. In fact, Ubuntu is the most popular cloud operating system (http://www.ubuntu.com/cloud/public-cloud). Running in the cloud will let you build your Cordova application. However you will still need to connect a local instance to a phone via USB for testing your app.
+
+You can also install Ubuntu in local VM, with Virtualbox, VMWare or Parallels on either Windows or Mac OS. That configuration lets you re-direct a USB port inside the virtual machine, to let the Ubuntu build system access the Ubuntu phone hardware and install the app for testing.
+
+Refer to the documentation for either your public cloud of choice, or the local virtual machine for the details of the installation procedure.
+
+Once you have a basic Ubuntu VM set up, you can install the rest of the required elements below.
+
+### Node and NPM
+
+Ubuntu 16.04 LTS comes with the required versions of both NodeJS and NPM. To install simlpy do:
+
+```bash
+$ sudo apt-get install nodejs npm
+$ node -v
+v.4.2.6
+$ npm -v
+2.15.6
+```
-Add the Ubuntu Cordova
+### Cordova CLI
+
+The Cordova command line interface can be installed either via npm, or you can use a pre-packaged version available specifically for Ubuntu.
+
+The recommended installation path is to use the pre-packaged version for Ubuntu, as it generally contains Ubuntu specific fixes which may not all have been merged upstream.
+
+Installing the cordova-cli deb package requires to:
+1. Add the Ubuntu Cordova
[Personal Package Archive](https://launchpad.net/~cordova-ubuntu/+archive/ppa)
-to your Ubuntu system:
+to your Ubuntu system
+1. Install the cordova-cli package (and its dependencies)
```bash
-$ sudo add-apt-repository ppa:cordova-ubuntu/ppa
+$ sudo apt-add-repository ppa:cordova-ubuntu/ppa
$ sudo apt-get update
+$ sudo apt-get install cordova-cli
```
-Install cordova-cli package (and its dependencies):
+### Add an Ubuntu "click chroot"
+
+The build environment needs to be separated from the developer's environment, to prevent unwanted side effects and provide a clean, repeatable process.
+
+Ubuntu devices currently use the click packaging system.
+
+To produce click packages, a "click chroot" is required. It is a separate build environment designed to produce binaries, by having a build tools and dependencies contained inside a chroot.
+
+Generally, a click chroot hosts cross-compilation tools which can produce binaries for a different architecture (like armhf) than the one of the developer's system (generally x86).
+
+Last, the click chroot will need to be provisionned with libraries, or more generally "frameworks", corresponding to the target environment.
+
+Ubuntu devices will support the ubuntu-sdk-15.04 framework or later versions.
+
+### Create a click chroot environment
```bash
-$ sudo apt-get install cordova-cli
+$ sudo apt-add-repository ppa:ubuntu-sdk-team/ppa
+$ sudo apt-get update
+# this will create a clean click chroot build environment
+sudo apt-get install click-dev phablet-tools ubuntu-sdk-api-15.04
```
+### Add build dependencies for Cordova
+
+```bash
+# add build dependencies inside the click chroot
+sudo click chroot -a armhf -f ubuntu-sdk-15.04 install cmake libicu-dev:armhf pkg-config qtbase5-dev:armhf qtchooser qtdeclarative5-dev:armhf qtfeedback5-dev:armhf qtlocation5-dev:armhf qtmultimedia5-dev:armhf qtpim5-dev:armhf libqt5sensors5-dev:armhf qtsystems5-dev:armhf
+```
+
+### Ubuntu IDE (optional)
+
+You may also want to install the Ubuntu QtCreator development environment. See
+[developer.ubuntu.com](http://developer.ubuntu.com) for more info. (The
+QtCreator SDK is not required to add Ubuntu platform support to your Cordova
+app.)
+
+
## Project Workflow
+To test your installation, or simply to start developing an application, you can follow the steps below.
+
### Create a project
Creates an app in a `hello` directory whose display name is
`HelloWorld`:
```bash
-$ cordova create hello com.example.hello HelloWorld
+$ cordova create helloworld helloworld.ubuntudeveloper HelloWorld
+$ cd hello
+$ cordova platform add ubuntu
```
-### Move into the Project Directory
+Note that Ubuntu applications use a pair <appname>.<username> as a naming convention.
+
+### Add a Plugin
```bash
-$ cd hello
+$ cordova plugin add cordova-plugin-camera
```
-### Add the Ubuntu Platform
+### Build for Ubuntu devices
```bash
-$ cordova platform add ubuntu
+$ cordova build --device
```
-### Build for Ubuntu
+You can see detailed build logs with the following options:
+```bash
+$ cordova -d build --device -- --verbose
+```
+You can build your app for a different target framework by specifying the option below:
```bash
-$ cordova build ubuntu
+$ cordova -d build --device -- --framework=ubuntu-sdk-16.04
```
-### Run the App
+Note that for the latter to work, you will need to have a corresponding click chroot installed on your build system.
+
+### Run the App on an Ubuntu device
```bash
-$ cordova run ubuntu
+$ cordova run --device
```
-### Add the Camera Plugin
+This will:
+1. build the app for the device target
+1. package it using the click packaging system
+1. transfer the app on the device
+1. stop the app if it was already running
+1. install the app
+1. start the app
+
+
+## Debugging
+
+You can enable chrome devtools support to debug your app, by adding the --debug flag:
```bash
-$ cordova plugin add cordova-plugin-camera
-``
+$ cordova run --device --debug
+```
+
+Then simply connect to the URL mentioned in the logs.
+
+## Publishing your app
+
+Once you have finished developing and testing your app, you can publish it on the Ubuntu App Store.
+
+### Generate and verify the package
+
+Your app is already packaged in a format compatible with the app store. Just find the .click package generate by the cordova-ubuntu build system:
+
+```bash
+$ cordova build --device
+$ find -name "*.click"
+```
+
+You can manually verify that the package passes all verification steps enforced by the Ubuntu App Store system, by using the click-reviewer-tools:
+
+```bash
+$ click review -v <click file>
+```
+
+Note: this step is done automatically by the build system as well.
+
+### Sign up and upload to the app store
+
+You need to first create a free developer account on the Ubuntu App Store.
+
+Then you will be able to upload your package to the store and make it available to all users of Ubuntu devices.
+
+The full process is documented online at https://developer.ubuntu.com/en/publish/
+
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/guide/support/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/guide/support/index.md b/www/docs/en/6.x/guide/support/index.md
index 7e36376..a7a5928 100644
--- a/www/docs/en/6.x/guide/support/index.md
+++ b/www/docs/en/6.x/guide/support/index.md
@@ -43,6 +43,7 @@ CLI's shorthand names.
<th>Ubuntu</th>
<th>wp8<br/>(Windows Phone 8)</th>
<th>windows<br/>(8.1, 10,<br/>Phone 8.1)</th>
+ <th>OS X</th>
</tr>
</thead>
@@ -56,6 +57,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y">Ubuntu</td>
<td data-col="winphone8" class="y">Windows</td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y">Mac</td>
</tr>
<tr>
@@ -66,6 +68,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="n"></td>
<td data-col="win8" class="n"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -76,6 +79,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"><a href="../platforms/wp8/plugin.html">(see details)</a></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -91,6 +95,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -98,9 +103,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="n"></td>
+ <td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">* Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -111,6 +117,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -121,6 +128,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -131,6 +139,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -141,6 +150,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -148,9 +158,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="y"></td>
+ <td data-col="ubuntu" class="p">desktop only</td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="p">partially</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -161,6 +172,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -171,6 +183,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -181,6 +194,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="y"></td>
</tr>
<tr>
@@ -191,6 +205,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="n"></td>
<td data-col="winphone8" class="y">* Do not support onprogress nor abort</td>
<td data-col="win8" class="y">* Do not support onprogress nor abort</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -201,6 +216,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -211,6 +227,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -221,6 +238,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="p">uses iframe</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -241,6 +259,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -251,6 +270,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y"></td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -261,6 +281,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="n"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -271,6 +292,7 @@ CLI's shorthand names.
<td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y">localStorage & indexedDB</td>
<td data-col="win8" class="y">localStorage & indexedDB</td>
+ <td data-col="osx" class="n"></td>
</tr>
<tr>
@@ -278,9 +300,10 @@ CLI's shorthand names.
<td data-col="android" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="ubuntu" class="n"></td>
+ <td data-col="ubuntu" class="y"></td>
<td data-col="winphone8" class="y"></td>
<td data-col="win8" class="y">* Windows Phone 8.1 only</td>
+ <td data-col="osx" class="n"></td>
</tr>
</tbody>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/platform_plugin_versioning_ref/index.md b/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
index 00e3deb..b9eb822 100644
--- a/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
+++ b/www/docs/en/6.x/platform_plugin_versioning_ref/index.md
@@ -144,18 +144,15 @@ $ cordova plugin save
```
-### Updating / Removing plugins
-It is also possible to update/delete from config.xml during the commands 'cordova plugin update' and 'cordova plugin remove' :
+### Removing plugins
+It is also possible to delete from config.xml during the command 'cordova plugin remove' :
```bash
-$ cordova plugin update <plugin[@<version>] | directory | git_url> --save
+
$ cordova plugin remove <plugin> --save
```
-Some examples :
+For example:
- * **'cordova plugin update cordova-plugin-console --save'** => In addition to updating the console plugin to the pinned version, update config.xml entry
- * **'cordova plugin update cordova-plugin-console@0.2.13 --save'** => In addition to updating the android plugin to version 3.8.0, update config.xml entry
- * **'cordova plugin update /path/to/console/plugin --save'** => In addition to updating the console plugin to version in the folder, update config.xml entry
* **'cordova plugin remove cordova-plugin-console --save'** => Removes the console plugin from the project and deletes its entry from config.xml.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/plugin_ref/spec.md b/www/docs/en/6.x/plugin_ref/spec.md
index c70d48f..8412660 100644
--- a/www/docs/en/6.x/plugin_ref/spec.md
+++ b/www/docs/en/6.x/plugin_ref/spec.md
@@ -365,6 +365,112 @@ For windows-specific attributes:
```
The above example will set pre-8.1 platforms (Windows 8, specifically) to require the `webcam` device capability and the `picturesLibrary` general capability, and apply the `webcam` device capability only to Windows 8.1 projects that build for Windows Phone. Windows desktop 8.1 systems are unmodified.
+### edit-config
+Similar to `config-file`, `edit-config` identifies an XML-based configuration file to be modified, where in that document the modification should take place, and what should be modified. Instead of appending new children to an XML document tree, `edit-config` makes modifications to attributes of XML elements. There are two modes which will determine what type of attribute modification will be made, `merge` or `overwrite`. `edit-config` has one child and that child will contain the attributes to be added.
+
+Attributes(type) <br/> <span class="sub-header">Only for platform:</span> | Description
+---------------- | ------------
+file(string) | The file to be modified, and the path relative to the root of the Cordova project. If the specified file does not exist, the tool ignores the configuration change and continues installation. <br/> The target can include wildcard (`*`) elements. In this case, the CLI recursively searches through the project directory structure and uses the first match. <br/> On iOS, the location of configuration files relative to the project directory root is not known, so specifying a target of `config.xml` resolves to `cordova-ios-project/MyAppName/config.xml`.
+target(string) | An XPath selector referencing the target element to make attribute modifications to. If you use absolute selectors, you can use a wildcard (`*`) to specify the root element, e.g., `/*/plugins`. If the selector does not resolve to a child of the specified document, the tool stops and reverses the installation process, issues a warning, and exits with a non-zero code.
+mode(string) | The mode that determines what type of attribute modifications will be made. <br/> `merge` - Adds the specified attributes to the target element. Will replace the attribute values if the specified attributes already exist in the target element. <br/> `overwrite` - Replaces all attributes in the target element with the attributes specified.
+
+Example:
+
+```xml
+<!-- plugin-1 -->
+<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
+ <uses-sdk android:minSdkVersion="16" android:maxSdkVersion="23" />
+</edit-config>
+<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="overwrite">
+ <activity android:name="MainActivity" android:label="NewLabel" android:configChanges="orientation|keyboardHidden" />
+</edit-config>
+```
+
+AndroidManifest.xml before adding plugin-1:
+```xml
+<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
+ ...
+ <activity android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale" android:label="@string/activity_name" android:launchMode="singleTop" android:name="MainActivity" android:theme="@android:style/Theme.DeviceDefault.NoActionBar" android:windowSoftInputMode="adjustResize">
+ ...
+ </activity>
+ ...
+ <uses-sdk android:minSdkVersion="14" android:targetSdkVersion="23" />
+</manifest>
+```
+
+AndroidManifest.xml after adding plugin-1:
+```xml
+<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
+ ...
+ <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
+ ...
+ </activity>
+ ...
+ <uses-sdk android:maxSdkVersion="23" android:minSdkVersion="16" android:targetSdkVersion="23" />
+</manifest>
+```
+#### Managing edit-config conflicts
+
+Multiple plugins can not modify the same attributes because it may cause problems with the application. An error will be thrown and plugin install will fail. The conflicting `edit-config` tags must be resolved before the plugin can be added. Make modifications to conflicting tags to resolve the conflict, then remove and re-add the updated plugins.
+
+There is an option for those who are certain that the plugin should be installed despite the conflicts. The `--force` flag can be used with `cordova plugin add`. Force adding the plugin will revert conflicting changes of other plugins so that it can be added without issues. `--force` should be used with caution as reverting changes of other plugins may cause the application to not work as expected.
+
+If the plugins ever get in a weird state, remove all plugins and re-add them.
+
+Example:
+
+Assume plugin-1 from above is already installed. Trying to install plugin-2 below will cause an error because plugin-1 has modified `uses-sdk` element in AndroidManifest.xml already.
+
+```xml
+<!-- plugin-2 -->
+<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
+ <uses-sdk android:minSdkVersion="15" />
+</edit-config>
+```
+
+There are a couple ways plugin-2 can be added:
+
+One possible resolution of the conflict is to remove the `edit-config` tag from plugin-2 and merge it into plugin-1's `edit-config` tag (assuming plugin-1 has no issue with this change). Remove both plugins and re-add them with these changes. plugin-2 should be added cleanly this time.
+
+Removing `edit-config` from plugin-2 and merging it into plugin-1:
+```xml
+<!-- plugin-1 -->
+<edit-config file="AndroidManifest.xml" target="/manifest/uses-sdk" mode="merge">
+ <uses-sdk android:minSdkVersion="15" android:maxSdkVersion="23" />
+</edit-config>
+<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="overwrite">
+ <activity android:name="MainActivity" android:label="NewLabel" android:configChanges="orientation|keyboardHidden" />
+</edit-config>
+```
+
+The resulting AndroidManifest.xml after removing and re-adding both plugins:
+```xml
+<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
+ ...
+ <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
+ ...
+ </activity>
+ ...
+ <uses-sdk android:maxSdkVersion="23" android:minSdkVersion="15" android:targetSdkVersion="23" />
+</manifest>
+```
+
+The second way to add plugin-2 involves adding the plugin with `--force`. The conflicting `edit-config` change from plugin-1 will be reverted and plugin-2's change will be applied. The resulting AndroidManifest.xml will have the `uses-sdk` change from plugin-2 and the `activity` change from plugin-1. Notice only the `uses-sdk` change from plugin-1 is gone since it was the only conflicting change.
+
+The resulting AndroidManifest.xml after force adding plugin-2:
+```xml
+<manifest android:hardwareAccelerated="true" android:versionCode="1" android:versionName="0.0.1" package="io.cordova.hellocordova" xmlns:android="http://schemas.android.com/apk/res/android">
+ ...
+ <activity android:configChanges="orientation|keyboardHidden" android:label="NewLabel" android:name="MainActivity">
+ ...
+ </activity>
+ ...
+ <uses-sdk android:minSdkVersion="15" android:targetSdkVersion="23" />
+</manifest>
+```
+
+Note: Reverted changes from `--force` are gone for good. They will not reappear after removing the plugin that was force added. If the reverted changes are needed, all associated plugins should be removed and re-added.
+
### plugins-plist
Specifies a key and value to append to the correct `AppInfo.plist` file in an iOS Cordova project. This is _outdated_ as it only applies to cordova-ios 2.2.0 and below. Use the `<config-file>` tag for newer versions of Cordova.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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
index e118d05..8fe7c38 100644
--- a/www/docs/en/6.x/reference/cordova-cli/index.md
+++ b/www/docs/en/6.x/reference/cordova-cli/index.md
@@ -43,7 +43,6 @@ These commands are available at all times.
|----------|--------------
| create | Create a project
| help <command> | Get help for a command
-| telemetry | Turn telemetry collection on or off
## Project Command List
@@ -71,7 +70,6 @@ These options apply to all cordova-cli commands.
| -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)
-| --no-telemetry | Disable telemetry collection for the current command.
## Platform-specific options
@@ -85,12 +83,8 @@ Certain commands have options (`platformOpts`) that are specific to a particular
cd myApp
# Add camera plugin to the project and remember that in config.xml
cordova plugin add cordova-plugin-camera --save
- # Add camera plugin to the project and remember that in config.xml. Use npm install to fetch.
- cordova plugin add cordova-plugin-camera --save --fetch
# Add android platform to the project and remember that in config.xml
cordova platform add android --save
- # Add android platform to the project and remember that in config.xml. Use npm install to fetch.
- cordova platform add android --save --fetch
# Check to see if your system is configured for building android platform.
cordova requirements android
# Build the android and emit verbose logs.
@@ -129,7 +123,7 @@ cordova create path [id [name [config]]] [options]
### Directory structure
-Cordova CLI works with the following directory structure:
+A Cordova application created with `cordova-cli` will have the following directory structure:
```
myapp/
@@ -213,12 +207,11 @@ Manage cordova platforms - allowing you to add, remove, update, list and check f
```bash
cordova {platform | platforms} [
- add <platform-spec> [...] {--save | link=<path> | --fetch } |
- {remove | rm} platform [...] {--save | --fetch}|
+ add <platform-spec> [...] {--save | link=<path> } |
+ {remove | rm} platform [...] |
{list | ls} |
check |
- save |
- update ]
+ save ]
```
| Sub-command | Option | Description |
@@ -226,13 +219,10 @@ cordova {platform | platforms} [
| 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)
-| | --fetch | Fetches the platform using `npm install` and stores it into the apps `node_modules` directory |
| remove `<platform>` [...] | | Remove specified platforms |
| | --save | Delete specified platforms from `config.xml` after removing them |
-| | --fetch | Removes the platform using `npm uninstall` and removes it from the apps `node_modules` directory |
| update `platform` [...] | | Update specified platforms |
| | --save | Updates the version specified in `config.xml` |
-| | --fetch | Fetches the platform using `npm install` and stores it into the apps `node_modules` directory |
| 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 |
@@ -275,11 +265,6 @@ There are a number of ways to specify a platform:
cordova platform add android ios --save
-- Add pinned version of the `android` and `ios` platform and save the downloaded version to `config.xml`. Install
-to the project using `npm install` and store it in the apps `node_modules` directory:
-
- cordova platform add android ios --save --fetch
-
- 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
@@ -300,11 +285,6 @@ to the project using `npm install` and store it in the apps `node_modules` direc
cordova platform rm android --save
-- Remove `android` platform from the project and from `config.xml`. Run `npm uninstall` to remove it
-from the `node_modules` directory.
-
- cordova platform rm android --save --fetch
-
- List available and installed platforms with version numbers. This is useful to find version numbers when reporting issues:
cordova platform ls
@@ -323,8 +303,8 @@ Manage project plugins
```bash
cordova {plugin | plugins} [
- add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force | --fetch} |
- {remove | rm} {<pluginid> | <name>} --save --fetch |
+ add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force} |
+ {remove | rm} {<pluginid> | <name>} --save |
{list | ls} |
search [<keyword>] |
save |
@@ -334,16 +314,14 @@ cordova {plugin | plugins} [
| 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.
+| |--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.
-| |--fetch | Fetches the plugin using `npm install` and stores it into the apps `node_modules` directory |
| remove `<pluginid>|<name>` [...]| | Remove plugins with the given IDs/name.
| |--save | Remove the specified plugin from config.xml
-| |--fetch | Removes the plugin using `npm uninstall` and removes it from the apps `node_modules` directory |
|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
@@ -352,17 +330,16 @@ cordova {plugin | plugins} [
There are a number of ways to specify a plugin:
- <plugin-spec> : [@scope/]pluginID[@version]|directory|url[#commit-ish][:subdir]
+ <plugin-spec> : pluginID[@version]|directory|url[#commit-ish][:subdir]
| Value | Description
|-------------|--------------------
-| scope | Scope of plugin published as a [scoped npm package]
| 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. (Doesn't work with `--fetch` option)
+| subdir | Sub-directory to find plugin.xml for the specified plugin.
### Algorithm for resolving plugins
@@ -384,10 +361,6 @@ based on the following criteria (listed in order of precedence):
cordova plugin add cordova-plugin-camera@^2.0.0 --save
-- Add `cordova-plugin-camera` with [semver](http://semver.org/) version ^2.0.0 and `npm install` it. It will be stored in the `node_modules` directory:
-
- cordova plugin add cordova-plugin-camera@^2.0.0 --fetch
-
- 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
@@ -404,10 +377,6 @@ based on the following criteria (listed in order of precedence):
cordova plugin rm camera --save
-- Remove the plugin from the project and `npm uninstall` it. Removes it from the `node_modules` directory:
-
- cordova plugin rm camera --fetch
-
- List all plugins installed in the project:
cordova plugin ls
@@ -423,7 +392,7 @@ copies plugin files for specified platforms so that the project is ready to buil
```
cordova prepare [<platform> [..]]
- [--browserify | --fetch]
+ [--browserify]
```
###Options
@@ -432,8 +401,6 @@ cordova prepare [<platform> [..]]
|------------|------------------
| `<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.
-|--fetch | When restoring plugins or platforms, fetch will `npm install` the missing modules.
-
## cordova compile command
@@ -500,31 +467,29 @@ cordova build [<platform> [...]]
### Synopsis
-Prepares, builds, and deploys app on specified platform devices/emulators. If a device is connected it will be used, unless an eligible emulator is already running.
+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 | --debug | --release]
- [--noprepare] [--nobuild]
+ [--list | --nobuild ]
[--device|--emulator|--target=<targetName>]
[--buildConfig=<configfile>]
[--browserify]
[-- <platformOpts>]
```
-| Option | Description
-|-------------|------------------
+| Option | Description
+|------------|------------------
| `<platform> [..]` | Platform name(s) to run. If not specified, all platforms are run.
-| --list | Lists available targets. Displays both device and emulator deployment targets unless specified
-| --debug | Deploy a debug build. This is the default behavior unless `--release` is specified.
-| --release | Deploy a release build
-| --noprepare | Skip preparing (available in Cordova v6.2 or later)
-| --nobuild | Skip building
-| --device | Deploy to a device
-| --emulator | Deploy to an emulator
-| --target | Deploy to a specific target emulator/device. Use `--list` to display target options
+|--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.
@@ -616,38 +581,6 @@ Run a local web server for www/ assets using specified `port` or default of 8000
cordova serve [port]
```
-## cordova telemetry command
-
-### Synopsis
-
-Turns telemetry collection on or off.
-
-### Syntax
-
-```
-cordova telemetry [STATE]
-```
-
-| Option | Description
-|-------------|------------------
-| on | Turn telemetry collection on.
-| off | Turn telemetry collection off.
-
-### Details
- A timed prompt asking the user to opt-in or out is displayed the first time cordova is run.
- It lasts for 30 seconds, after which the user is automatically opted-out if he doesn't provide any answer.
- In CI environments, the `CI` environment variable can be set, which will prevent the prompt from showing up.
- Telemetry collection can also be turned off on a single command by using the `--no-telemetry` flag.
-
-### Examples
-```
-cordova telemetry on
-cordova telemetry off
-cordova build --no-telemetry
-```
-
-For details, see our privacy notice: https://cordova.apache.org/privacy
-
## cordova help command
### Synopsis
@@ -665,4 +598,3 @@ 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
[Cordova dependencies]: http://cordova.apache.org/docs/en/latest/guide/hybrid/plugins/index.html#specifying-project-requirements
-[scoped npm package]: https://docs.npmjs.com/misc/scope
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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
index 03471d1..74a9818 100644
--- 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
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-battery-status/blob/master/README.md'
-title: Battery Status
+title: cordova-plugin-battery-status
plugin_name: cordova-plugin-battery-status
plugin_version: master
-description: Get events for device battery level.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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
index a9181c1..a6c91d7 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-camera/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-camera/blob/master/README.md'
-title: Camera
+title: cordova-plugin-camera
plugin_name: cordova-plugin-camera
plugin_version: master
-description: Take pictures with the device camera.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -83,20 +82,20 @@ Documentation consists of template and API docs produced from the plugin JS code
* [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>
+ * [.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>
+ * [.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)
@@ -104,10 +103,8 @@ Documentation consists of template and API docs produced from the plugin JS code
---
<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
@@ -175,7 +172,6 @@ More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPict
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
@@ -200,7 +196,6 @@ function onFail(message) {
}
```
<a name="module_camera.onError"></a>
-
### camera.onError : <code>function</code>
Callback function that provides an error message.
@@ -211,7 +206,6 @@ Callback function that provides an error message.
| 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.
@@ -231,7 +225,6 @@ function cameraCallback(imageData) {
}
```
<a name="module_camera.CameraOptions"></a>
-
### camera.CameraOptions : <code>Object</code>
Optional parameters to customize the camera settings.
* [Quirks](#CameraOptions-quirks)
@@ -257,10 +250,8 @@ Optional parameters to customize the camera settings.
---
<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**
@@ -272,7 +263,6 @@ Optional parameters to customize the camera settings.
| 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**
@@ -283,7 +273,6 @@ Optional parameters to customize the camera settings.
| 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**
@@ -295,7 +284,6 @@ Optional parameters to customize the camera settings.
| 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**
@@ -307,7 +295,6 @@ Optional parameters to customize the camera settings.
| 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.
@@ -323,7 +310,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
| 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**
@@ -336,15 +322,8 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
---
<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.
+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 |
@@ -358,7 +337,6 @@ location.
---
<a name="module_CameraPopoverHandle"></a>
-
## CameraPopoverHandle
A handle to an image picker popover.
@@ -557,202 +535,3 @@ Tizen only supports a `destinationType` of
[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
-
-## Sample: Take Pictures, Select Pictures from the Picture Library, and Get Thumbnails <a name="sample"></a>
-
-The Camera plugin allows you to do things like open the device's Camera app and take a picture, or open the file picker and select one. The code snippets in this section demonstrate different tasks including:
-
-* Open the Camera app and [take a Picture](#takePicture)
-* Take a picture and [return thumbnails](#getThumbnails) (resized picture)
-* Take a picture and [generate a FileEntry object](#convert)
-* [Select a file](#selectFile) from the picture library
-* Select a JPEG image and [return thumbnails](#getFileThumbnails) (resized image)
-* Select an image and [generate a FileEntry object](#convert)
-
-## Take a Picture <a name="takePicture"></a>
-
-Before you can take a picture, you need to set some Camera plugin options to pass into the Camera plugin's `getPicture` function. Here is a common set of recommendations. In this example, you create the object that you will use for the Camera options, and set the `sourceType` dynamically to support both the Camera app and the file picker.
-
-```js
-function setOptions(srcType) {
- var options = {
- // Some common settings are 20, 50, and 100
- quality: 50,
- destinationType: Camera.DestinationType.FILE_URI,
- // In this app, dynamically set the picture source, Camera or photo gallery
- sourceType: srcType,
- encodingType: Camera.EncodingType.JPEG,
- mediaType: Camera.MediaType.PICTURE,
- allowEdit: true,
- correctOrientation: true //Corrects Android orientation quirks
- }
- return options;
-}
-```
-
-Typically, you want to use a FILE_URI instead of a DATA_URL to avoid most memory issues. JPEG is the recommended encoding type for Android.
-
-You take a picture by passing in the options object to `getPicture`, which takes a CameraOptions object as the third argument. When you call `setOptions`, pass `Camera.PictureSourceType.CAMERA` as the picture source.
-
-```js
-function openCamera(selection) {
-
- var srcType = Camera.PictureSourceType.CAMERA;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- displayImage(imageUri);
- // You may choose to copy the picture, save it somewhere, or upload.
- func(imageUri);
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-Once you take the picture, you can display it or do something else. In this example, call the app's `displayImage` function from the preceding code.
-
-```js
-function displayImage(imgUri) {
-
- var elem = document.getElementById('imageFile');
- elem.src = imgUri;
-}
-```
-
-To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
-
-```html
-<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
-```
-
-## Take a Picture and Return Thumbnails (Resize the Picture) <a name="getThumbnails"></a>
-
-To get smaller images, you can return a resized image by passing both `targetHeight` and `targetWidth` values with your CameraOptions object. In this example, you resize the returned image to fit in a 100px by 100px box (the aspect ratio is maintained, so 100px is either the height or width, whichever is greater in the source).
-
-```js
-function openCamera(selection) {
-
- var srcType = Camera.PictureSourceType.CAMERA;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- if (selection == "camera-thmb") {
- options.targetHeight = 100;
- options.targetWidth = 100;
- }
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Select a File from the Picture Library <a name="selectFile"></a>
-
-When selecting a file using the file picker, you also need to set the CameraOptions object. In this example, set the `sourceType` to `Camera.PictureSourceType.SAVEDPHOTOALBUM`. To open the file picker, call `getPicture` just as you did in the previous example, passing in the success and error callbacks along with CameraOptions object.
-
-```js
-function openFilePicker(selection) {
-
- var srcType = Camera.PictureSourceType.SAVEDPHOTOALBUM;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Select an Image and Return Thumbnails (resized images) <a name="getFileThumbnails"></a>
-
-Resizing a file selected with the file picker works just like resizing using the Camera app; set the `targetHeight` and `targetWidth` options.
-
-```js
-function openFilePicker(selection) {
-
- var srcType = Camera.PictureSourceType.SAVEDPHOTOALBUM;
- var options = setOptions(srcType);
- var func = createNewFileEntry;
-
- if (selection == "picker-thmb") {
- // To downscale a selected image,
- // Camera.EncodingType (e.g., JPEG) must match the selected image type.
- options.targetHeight = 100;
- options.targetWidth = 100;
- }
-
- navigator.camera.getPicture(function cameraSuccess(imageUri) {
-
- // Do something with image
-
- }, function cameraError(error) {
- console.debug("Unable to obtain picture: " + error, "app");
-
- }, options);
-}
-```
-
-## Take a picture and get a FileEntry Object <a name="convert"></a>
-
-If you want to do something like copy the image to another location, or upload it somewhere using the FileTransfer plugin, you need to get a FileEntry object for the returned picture. To do that, call `window.resolveLocalFileSystemURL` on the file URI returned by the Camera app. If you need to use a FileEntry object, set the `destinationType` to `Camera.DestinationType.FILE_URI` in your CameraOptions object (this is also the default value).
-
->*Note* You need the [File plugin](https://www.npmjs.com/package/cordova-plugin-file) to call `window.resolveLocalFileSystemURL`.
-
-Here is the call to `window.resolveLocalFileSystemURL`. The image URI is passed to this function from the success callback of `getPicture`. The success handler of `resolveLocalFileSystemURL` receives the FileEntry object.
-
-```js
-function getFileEntry(imgUri) {
- window.resolveLocalFileSystemURL(imgUri, function success(fileEntry) {
-
- // Do something with the FileEntry object, like write to it, upload it, etc.
- // writeFile(fileEntry, imgUri);
- console.log("got file: " + fileEntry.fullPath);
- // displayFileData(fileEntry.nativeURL, "Native URL");
-
- }, function () {
- // If don't get the FileEntry (which may happen when testing
- // on some emulators), copy to a new FileEntry.
- createNewFileEntry(imgUri);
- });
-}
-```
-
-In the example shown in the preceding code, you call the app's `createNewFileEntry` function if you don't get a valid FileEntry object. The image URI returned from the Camera app should result in a valid FileEntry, but platform behavior on some emulators may be different for files returned from the file picker.
-
->*Note* To see an example of writing to a FileEntry, see the [File plugin README](https://www.npmjs.com/package/cordova-plugin-file).
-
-The code shown here creates a file in your app's cache (in sandboxed storage) named `tempFile.jpeg`. With the new FileEntry object, you can copy the image to the file or do something else like upload it.
-
-```js
-function createNewFileEntry(imgUri) {
- window.resolveLocalFileSystemURL(cordova.file.cacheDirectory, function success(dirEntry) {
-
- // JPEG file
- dirEntry.getFile("tempFile.jpeg", { create: true, exclusive: false }, function (fileEntry) {
-
- // Do something with it, like write to it, upload it, etc.
- // writeFile(fileEntry, imgUri);
- console.log("got file: " + fileEntry.fullPath);
- // displayFileData(fileEntry.fullPath, "File copied to");
-
- }, onErrorCreateFile);
-
- }, onErrorResolveUrl);
-}
-```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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
index 319c250..127a041 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-console/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-console/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-console/blob/master/README.md'
-title: Console
+title: cordova-plugin-console
plugin_name: cordova-plugin-console
plugin_version: master
-description: Get JavaScript logs in your native logs.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[4/6] docs commit: copied dev docsinto 6.x for english
Posted by st...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/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
index 9bd4f6c..26c89ad 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-contacts/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-contacts/blob/master/README.md'
-title: Contacts
+title: cordova-plugin-contacts
plugin_name: cordova-plugin-contacts
plugin_version: master
-description: Manage the contacts on the device.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -34,12 +33,11 @@ description: Manage the contacts on the device.
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.
-```js
-document.addEventListener("deviceready", onDeviceReady, false);
-function onDeviceReady() {
-console.log(navigator.contacts);
-}
-```
+
+ 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
@@ -81,15 +79,14 @@ 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.
-```json
-"type": "privileged",
-"permissions": {
- "contacts": {
- "access": "readwrite",
- "description": "Describe why there is a need for such permission"
+ "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.
@@ -138,9 +135,7 @@ database, for which you need to invoke the `Contact.save` method.
### Example
-```js
var myContact = navigator.contacts.create({"displayName": "Test User"});
-```
## navigator.contacts.find
@@ -194,24 +189,22 @@ Supported values for both __contactFields__ and __contactFindOptions.desiredFiel
### Example
-```js
-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);
-```
+ 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
@@ -238,13 +231,11 @@ function specified by the __contactSuccess__ parameter.
### Example
-```js
-navigator.contacts.pickContact(function(contact){
- console.log('The following contact has been selected:' + JSON.stringify(contact));
- },function(err){
- console.log('Error: ' + err);
- });
-```
+ navigator.contacts.pickContact(function(contact){
+ console.log('The following contact has been selected:' + JSON.stringify(contact));
+ },function(err){
+ console.log('Error: ' + err);
+ });
### Android Quirks
@@ -329,82 +320,49 @@ for details.
### Save Example
-```js
-function onSuccess(contact) {
- alert("Save Success");
-};
+ function onSuccess(contact) {
+ alert("Save Success");
+ };
-function onError(contactError) {
- alert("Error = " + contactError.code);
-};
+ 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
+ // 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;
+ // populate some fields
+ var name = new ContactName();
+ name.givenName = "Jane";
+ name.familyName = "Doe";
+ contact.name = name;
-// save to device
-contact.save(onSuccess,onError);
-```
+ // save to device
+ contact.save(onSuccess,onError);
### Clone Example
-```js
-// 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);
-```
+ // 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
-```js
-function onSuccess() {
- alert("Removal Success");
-};
+ function onSuccess() {
+ alert("Removal Success");
+ };
-function onError(contactError) {
- alert("Error = " + contactError.code);
-};
+ function onError(contactError) {
+ alert("Error = " + contactError.code);
+ };
+
+ // remove the contact from the device
+ contact.remove(onSuccess,onError);
-// remove the contact from the device
-contact.remove(onSuccess,onError);
-```
-### Removing phone number(s) from a saved contact
-
-```js
-// Example to create a contact with 3 phone numbers and then remove
-// 2 phone numbers. This example is for illustrative purpose only
-var myContact = navigator.contacts.create({"displayName": "Test User"});
-var phoneNumbers = [];
-
-phoneNumbers[0] = new ContactField('work', '768-555-1234', false);
-phoneNumbers[1] = new ContactField('mobile', '999-555-5432', true); // preferred number
-phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
-
-myContact.phoneNumbers = phoneNumbers;
-myContact.save(function (contact_obj) {
- var contactObjToModify = contact_obj.clone();
- contact_obj.remove(function(){
- var phoneNumbers = [contactObjToModify.phoneNumbers[0]];
- contactObjToModify.phoneNumbers = phoneNumbers;
- contactObjToModify.save(function(c_obj){
- console.log("All Done");
- }, function(error){
- console.log("Not able to save the cloned object: " + error);
- });
- }, function(contactError) {
- console.log("Contact Remove Operation failed: " + contactError);
- });
-});
-```
### Android 2.X Quirks
@@ -504,35 +462,33 @@ a `ContactAddress[]` array.
### Example
-```js
-// 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);
+ // 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);
-```
+ };
+
+ 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
@@ -630,20 +586,18 @@ string.
### Example
-```js
-// create a new contact
-var contact = navigator.contacts.create();
+ // 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;
+ // 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();
-```
+ // save the contact
+ contact.save();
### Android Quirks
@@ -696,28 +650,26 @@ Contains different kinds of information about a `Contact` object's name.
### Example
-```js
-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 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!');
-};
+ function onError(contactError) {
+ alert('onError!');
+ };
-var options = new ContactFindOptions();
-options.filter = "";
-options.multiple = true;
-filter = ["displayName", "name"];
-navigator.contacts.find(filter, onSuccess, onError, options);
-```
+ var options = new ContactFindOptions();
+ options.filter = "";
+ options.multiple = true;
+ filter = ["displayName", "name"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
### Android Quirks
@@ -791,29 +743,27 @@ properties. A `Contact` object stores one or more
### Example
-```js
-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 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!');
-};
+ function onError(contactError) {
+ alert('onError!');
+ };
-var options = new ContactFindOptions();
-options.filter = "";
-options.multiple = true;
-filter = ["displayName", "organizations"];
-navigator.contacts.find(filter, onSuccess, onError, options);
-```
+ var options = new ContactFindOptions();
+ options.filter = "";
+ options.multiple = true;
+ filter = ["displayName", "organizations"];
+ navigator.contacts.find(filter, onSuccess, onError, options);
### Android 2.X Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-device-motion/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-device-motion/index.md b/www/docs/en/6.x/reference/cordova-plugin-device-motion/index.md
index d8c582e..b3c6dd6 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-device-motion/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-device-motion/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-device-motion/blob/master/README.md'
-title: Device Motion
+title: cordova-plugin-device-motion
plugin_name: cordova-plugin-device-motion
plugin_version: master
-description: Access accelerometer data.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -130,7 +129,7 @@ accelerometer.
accelerometerOptions);
- __accelerometerOptions__: An object with the following optional keys:
- - __frequency__: requested frequency of calls to accelerometerSuccess with acceleration data in Milliseconds. _(Number)_ (Default: 10000)
+ - __period__: requested period of calls to accelerometerSuccess with acceleration data in Milliseconds. _(Number)_ (Default: 10000)
### Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-device-orientation/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-device-orientation/index.md b/www/docs/en/6.x/reference/cordova-plugin-device-orientation/index.md
index 12127ae..7e2ed34 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-device-orientation/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-device-orientation/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-device-orientation/blob/master/README.md'
-title: Device Orientation
+title: cordova-plugin-device-orientation
plugin_name: cordova-plugin-device-orientation
plugin_version: master
-description: Access compass data.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -207,6 +206,8 @@ A `CompassHeading` object is returned to the `compassSuccess` callback function.
- The `trueHeading` property is only returned for location services enabled via `navigator.geolocation.watchLocation()`.
+- For iOS 4 devices and above, heading factors in the device's current orientation, and does not reference its absolute position, for apps that supports that orientation.
+
## CompassError
A `CompassError` object is returned to the `compassError` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-device/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-device/index.md b/www/docs/en/6.x/reference/cordova-plugin-device/index.md
index 2b5db0f..6e4a82c 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-device/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-device/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-device/blob/master/README.md'
-title: Device
+title: cordova-plugin-device
plugin_name: cordova-plugin-device
plugin_version: master
-description: Get device information.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-dialogs/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-dialogs/index.md b/www/docs/en/6.x/reference/cordova-plugin-dialogs/index.md
index cb566b0..ca4e113 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-dialogs/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-dialogs/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-dialogs/blob/master/README.md'
-title: Dialogs
+title: cordova-plugin-dialogs
plugin_name: cordova-plugin-dialogs
plugin_version: master
-description: Use native dialog UI elements
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -89,7 +88,6 @@ function, which is typically less customizable.
- Amazon Fire OS
- Android
- BlackBerry 10
-- Browser
- Firefox OS
- iOS
- Tizen
@@ -154,7 +152,6 @@ indexing, so the value is `1`, `2`, `3`, etc.
- Amazon Fire OS
- Android
- BlackBerry 10
-- Browser
- Firefox OS
- iOS
- Tizen
@@ -226,7 +223,6 @@ contains the following properties:
- Amazon Fire OS
- Android
-- Browser
- Firefox OS
- iOS
- Windows Phone 7 and 8
@@ -265,7 +261,6 @@ The device plays a beep sound.
- Amazon Fire OS
- Android
- BlackBerry 10
-- Browser
- iOS
- Tizen
- Windows Phone 7 and 8
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-file-transfer/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-file-transfer/index.md b/www/docs/en/6.x/reference/cordova-plugin-file-transfer/index.md
index 454bbb3..7b698b0 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-file-transfer/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-file-transfer/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-file-transfer/blob/master/README.md'
-title: File Transfer
+title: cordova-plugin-file-transfer
plugin_name: cordova-plugin-file-transfer
plugin_version: master
-description: Upload and download files.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -35,20 +34,16 @@ This plugin allows you to upload and download files.
This plugin defines global `FileTransfer`, `FileUploadOptions` constructors. Although in the global scope, they are not available until after the `deviceready` event.
-```js
-document.addEventListener("deviceready", onDeviceReady, false);
-function onDeviceReady() {
- console.log(FileTransfer);
-}
-```
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log(FileTransfer);
+ }
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%20File%20Transfer%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC)
## Installation
-```bash
-cordova plugin add cordova-plugin-file-transfer
-```
+ cordova plugin add cordova-plugin-file-transfer
## Supported Platforms
@@ -108,74 +103,70 @@ __Parameters__:
### Example
-```js
-// !! Assumes variable fileURL contains a valid URL to a text file on the device,
-// for example, cdvfile://localhost/persistent/path/to/file.txt
+ // !! Assumes variable fileURL contains a valid URL to a text file on the device,
+ // for example, cdvfile://localhost/persistent/path/to/file.txt
-var win = function (r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
-}
+ var win = function (r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
-var fail = function (error) {
- alert("An error has occurred: Code = " + error.code);
- console.log("upload error source " + error.source);
- console.log("upload error target " + error.target);
-}
+ var fail = function (error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
-var options = new FileUploadOptions();
-options.fileKey = "file";
-options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
-options.mimeType = "text/plain";
+ var options = new FileUploadOptions();
+ options.fileKey = "file";
+ options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
+ options.mimeType = "text/plain";
-var params = {};
-params.value1 = "test";
-params.value2 = "param";
+ var params = {};
+ params.value1 = "test";
+ params.value2 = "param";
-options.params = params;
+ options.params = params;
-var ft = new FileTransfer();
-ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options);
-```
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options);
### Example with Upload Headers and Progress Events (Android and iOS only)
-```js
-function win(r) {
- console.log("Code = " + r.responseCode);
- console.log("Response = " + r.response);
- console.log("Sent = " + r.bytesSent);
-}
+ function win(r) {
+ console.log("Code = " + r.responseCode);
+ console.log("Response = " + r.response);
+ console.log("Sent = " + r.bytesSent);
+ }
-function fail(error) {
- alert("An error has occurred: Code = " + error.code);
- console.log("upload error source " + error.source);
- console.log("upload error target " + error.target);
-}
+ function fail(error) {
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
-var uri = encodeURI("http://some.server.com/upload.php");
+ var uri = encodeURI("http://some.server.com/upload.php");
-var options = new FileUploadOptions();
-options.fileKey="file";
-options.fileName=fileURL.substr(fileURL.lastIndexOf('/')+1);
-options.mimeType="text/plain";
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName=fileURL.substr(fileURL.lastIndexOf('/')+1);
+ options.mimeType="text/plain";
-var headers={'headerParam':'headerValue'};
+ var headers={'headerParam':'headerValue'};
-options.headers = headers;
+ options.headers = headers;
+
+ var ft = new FileTransfer();
+ ft.onprogress = function(progressEvent) {
+ if (progressEvent.lengthComputable) {
+ loadingStatus.setPercentage(progressEvent.loaded / progressEvent.total);
+ } else {
+ loadingStatus.increment();
+ }
+ };
+ ft.upload(fileURL, uri, win, fail, options);
-var ft = new FileTransfer();
-ft.onprogress = function(progressEvent) {
- if (progressEvent.lengthComputable) {
- loadingStatus.setPercentage(progressEvent.loaded / progressEvent.total);
- } else {
- loadingStatus.increment();
- }
-};
-ft.upload(fileURL, uri, win, fail, options);
-```
-
## FileUploadResult
A `FileUploadResult` object is passed to the success callback of the
@@ -200,10 +191,6 @@ A `FileUploadResult` object is passed to the success callback of the
- __withCredentials__: _boolean_ that tells the browser to set the withCredentials flag on the XMLHttpRequest
-### Windows Quirks
-
-- An option parameter with empty/null value is excluded in the upload operation due to the Windows API design.
-
## download
__Parameters__:
@@ -222,32 +209,30 @@ __Parameters__:
### Example
-```js
-// !! Assumes variable fileURL contains a valid URL to a path on the device,
-// for example, cdvfile://localhost/persistent/path/to/downloads/
-
-var fileTransfer = new FileTransfer();
-var uri = encodeURI("http://some.server.com/download.php");
-
-fileTransfer.download(
- uri,
- fileURL,
- function(entry) {
- console.log("download complete: " + entry.toURL());
- },
- function(error) {
- console.log("download error source " + error.source);
- console.log("download error target " + error.target);
- console.log("upload error code" + error.code);
- },
- false,
- {
- headers: {
- "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
+ // !! Assumes variable fileURL contains a valid URL to a path on the device,
+ // for example, cdvfile://localhost/persistent/path/to/downloads/
+
+ var fileTransfer = new FileTransfer();
+ var uri = encodeURI("http://some.server.com/download.php");
+
+ fileTransfer.download(
+ uri,
+ fileURL,
+ function(entry) {
+ console.log("download complete: " + entry.toURL());
+ },
+ function(error) {
+ console.log("download error source " + error.source);
+ console.log("download error target " + error.target);
+ console.log("upload error code" + error.code);
+ },
+ false,
+ {
+ headers: {
+ "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
+ }
}
- }
-);
-```
+ );
### WP8 Quirks
@@ -263,30 +248,29 @@ Aborts an in-progress transfer. The onerror callback is passed a FileTransferErr
### Example
-```js
-// !! Assumes variable fileURL contains a valid URL to a text file on the device,
-// for example, cdvfile://localhost/persistent/path/to/file.txt
+ // !! Assumes variable fileURL contains a valid URL to a text file on the device,
+ // for example, cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log("Should not be called.");
+ }
-var win = function(r) {
- console.log("Should not be called.");
-}
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert("An error has occurred: Code = " + error.code);
+ console.log("upload error source " + error.source);
+ console.log("upload error target " + error.target);
+ }
-var fail = function(error) {
- // error.code == FileTransferError.ABORT_ERR
- alert("An error has occurred: Code = " + error.code);
- console.log("upload error source " + error.source);
- console.log("upload error target " + error.target);
-}
+ var options = new FileUploadOptions();
+ options.fileKey="file";
+ options.fileName="myphoto.jpg";
+ options.mimeType="image/jpeg";
-var options = new FileUploadOptions();
-options.fileKey="file";
-options.fileName="myphoto.jpg";
-options.mimeType="image/jpeg";
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options);
+ ft.abort();
-var ft = new FileTransfer();
-ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options);
-ft.abort();
-```
## FileTransferError
@@ -336,253 +320,3 @@ If you are upgrading to a new (1.0.0 or newer) version of File, and you have pre
cdvfile://localhost/persistent/path/to/file
which can be used in place of the absolute file path in both `download()` and `upload()` methods.
-
-## Sample: Download and Upload Files <a name="sample"></a>
-
-Use the File-Transfer plugin to upload and download files. In these examples, we demonstrate several tasks like:
-
-* [Downloading a binary file to the application cache](#binaryFile)
-* [Uploading a file created in your application's root](#uploadFile)
-* [Downloading the uploaded file](#downloadFile)
-
-## Download a Binary File to the application cache <a name="binaryFile"></a>
-
-Use the File plugin with the File-Transfer plugin to provide a target for the files that you download (the target must be a FileEntry object). Before you download the file, create a DirectoryEntry object by using `resolveLocalFileSystemURL` and calling `fs.root` in the success callback. Use the `getFile` method of DirectoryEntry to create the target file.
-
-```js
-window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
-
- console.log('file system open: ' + fs.name);
-
- // Make sure you add the domain name to the Content-Security-Policy <meta> element.
- var url = 'http://cordova.apache.org/static/img/cordova_bot.png';
- // Parameters passed to getFile create a new file or return the file if it already exists.
- fs.root.getFile('downloaded-image.png', { create: true, exclusive: false }, function (fileEntry) {
- download(fileEntry, url, true);
-
- }, onErrorCreateFile);
-
-}, onErrorLoadFs);
-```
-
->*Note* For persistent storage, pass LocalFileSystem.PERSISTENT to requestFileSystem.
-
-When you have the FileEntry object, download the file using the `download` method of the FileTransfer object. The 3rd argument to the `download` function of FileTransfer is the success callback, which you can use to call the app's `readBinaryFile` function. In this code example, the `entry` variable is a new FileEntry object that receives the result of the download operation.
-
-```js
-function download(fileEntry, uri, readBinaryData) {
-
- var fileTransfer = new FileTransfer();
- var fileURL = fileEntry.toURL();
-
- fileTransfer.download(
- uri,
- fileURL,
- function (entry) {
- console.log("Successful download...");
- console.log("download complete: " + entry.toURL());
- if (readBinaryData) {
- // Read the file...
- readBinaryFile(entry);
- }
- else {
- // Or just display it.
- displayImageByFileURL(entry);
- }
- },
- function (error) {
- console.log("download error source " + error.source);
- console.log("download error target " + error.target);
- console.log("upload error code" + error.code);
- },
- null, // or, pass false
- {
- //headers: {
- // "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
- //}
- }
- );
-}
-```
-
-If you just need to display the image, take the FileEntry to call its toURL() function.
-
-```js
-function displayImageByFileURL(fileEntry) {
- var elem = document.getElementById('imageFile');
- elem.src = fileEntry.toURL();
-}
-```
-
-Depending on your app requirements, you may want to read the file. To support operations with binary files, FileReader supports two methods, `readAsBinaryString` and `readAsArrayBuffer`. In this example, use `readAsArrayBuffer` and pass the FileEntry object to the method. Once you read the file successfully, construct a Blob object using the result of the read.
-
-```js
-function readBinaryFile(fileEntry) {
- fileEntry.file(function (file) {
- var reader = new FileReader();
-
- reader.onloadend = function() {
-
- console.log("Successful file read: " + this.result);
- // displayFileData(fileEntry.fullPath + ": " + this.result);
-
- var blob = new Blob([new Uint8Array(this.result)], { type: "image/png" });
- displayImage(blob);
- };
-
- reader.readAsArrayBuffer(file);
-
- }, onErrorReadFile);
-}
-```
-
-Once you read the file successfully, you can create a DOM URL string using `createObjectURL`, and then display the image.
-
-```js
-function displayImage(blob) {
-
- // Note: Use window.URL.revokeObjectURL when finished with image.
- var objURL = window.URL.createObjectURL(blob);
-
- // Displays image if result is a valid DOM string for an image.
- var elem = document.getElementById('imageFile');
- elem.src = objURL;
-}
-```
-
-As you saw previously, you can call FileEntry.toURL() instead to just display the downloaded image (skip the file read).
-
-## Upload a File <a name="uploadFile"></a>
-
-When you upload a File using the File-Transfer plugin, use the File plugin to provide files for upload (again, they must be FileEntry objects). Before you can upload anything, create a file for upload using the `getFile` method of DirectoryEntry. In this example, create the file in the application's cache (fs.root). Then call the app's writeFile function so you have some content to upload.
-
-```js
-function onUploadFile() {
- window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
-
- console.log('file system open: ' + fs.name);
- var fileName = "uploadSource.txt";
- var dirEntry = fs.root;
- dirEntry.getFile(fileName, { create: true, exclusive: false }, function (fileEntry) {
-
- // Write something to the file before uploading it.
- writeFile(fileEntry);
-
- }, onErrorCreateFile);
-
- }, onErrorLoadFs);
-}
-```
-
-In this example, create some simple content, and then call the app's upload function.
-
-```js
-function writeFile(fileEntry, dataObj) {
- // Create a FileWriter object for our FileEntry (log.txt).
- fileEntry.createWriter(function (fileWriter) {
-
- fileWriter.onwriteend = function () {
- console.log("Successful file write...");
- upload(fileEntry);
- };
-
- fileWriter.onerror = function (e) {
- console.log("Failed file write: " + e.toString());
- };
-
- if (!dataObj) {
- dataObj = new Blob(['file data to upload'], { type: 'text/plain' });
- }
-
- fileWriter.write(dataObj);
- });
-}
-```
-
-Forward the FileEntry object to the upload function. To perform the actual upload, use the upload function of the FileTransfer object.
-
-```js
-function upload(fileEntry) {
- // !! Assumes variable fileURL contains a valid URL to a text file on the device,
- var fileURL = fileEntry.toURL();
-
- var success = function (r) {
- console.log("Successful upload...");
- console.log("Code = " + r.responseCode);
- displayFileData(fileEntry.fullPath + " (content uploaded to server)");
- }
-
- var fail = function (error) {
- alert("An error has occurred: Code = " + error.code);
- }
-
- var options = new FileUploadOptions();
- options.fileKey = "file";
- options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
- options.mimeType = "text/plain";
-
- var params = {};
- params.value1 = "test";
- params.value2 = "param";
-
- options.params = params;
-
- var ft = new FileTransfer();
- // SERVER must be a URL that can handle the request, like
- // http://some.server.com/upload.php
- ft.upload(fileURL, encodeURI(SERVER), success, fail, options);
-};
-```
-
-## Download the uploaded file <a name="downloadFile"></a>
-
-To download the image you just uploaded, you will need a valid URL that can handle the request, for example, http://some.server.com/download.php. Again, the success handler for the FileTransfer.download method receives a FileEntry object. The main difference here from previous examples is that we call FileReader.readAsText to read the result of the download operation, because we uploaded a file with text content.
-
-```js
-function download(fileEntry, uri) {
-
- var fileTransfer = new FileTransfer();
- var fileURL = fileEntry.toURL();
-
- fileTransfer.download(
- uri,
- fileURL,
- function (entry) {
- console.log("Successful download...");
- console.log("download complete: " + entry.toURL());
- readFile(entry);
- },
- function (error) {
- console.log("download error source " + error.source);
- console.log("download error target " + error.target);
- console.log("upload error code" + error.code);
- },
- null, // or, pass false
- {
- //headers: {
- // "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
- //}
- }
- );
-}
-```
-
-In the readFile function, call the `readAsText` method of the FileReader object.
-
-```js
-function readFile(fileEntry) {
- fileEntry.file(function (file) {
- var reader = new FileReader();
-
- reader.onloadend = function () {
-
- console.log("Successful file read: " + this.result);
- // displayFileData(fileEntry.fullPath + ": " + this.result);
-
- };
-
- reader.readAsText(file);
-
- }, onErrorReadFile);
-}
-```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-file/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-file/index.md b/www/docs/en/6.x/reference/cordova-plugin-file/index.md
index dc21546..4bf1453 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-file/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-file/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-file/blob/master/README.md'
-title: File
+title: cordova-plugin-file
plugin_name: cordova-plugin-file
plugin_version: master
-description: Read/write files on the device.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -37,7 +36,7 @@ This plugin is based on several specs, including :
The HTML5 File API
[http://www.w3.org/TR/FileAPI/](http://www.w3.org/TR/FileAPI/)
-The Directories and System extensions
+The (now-defunct) Directories and System extensions
Latest:
[http://www.w3.org/TR/2012/WD-file-system-api-20120417/](http://www.w3.org/TR/2012/WD-file-system-api-20120417/)
Although most of the plugin code was written when an earlier spec was current:
@@ -46,12 +45,10 @@ Although most of the plugin code was written when an earlier spec was current:
It also implements the FileWriter spec :
[http://dev.w3.org/2009/dap/file-system/file-writer.html](http://dev.w3.org/2009/dap/file-system/file-writer.html)
->*Note* While the W3C FileSystem spec is deprecated for web browsers, the FileSystem APIs are supported in Cordova applications with this plugin for the platforms listed in the _Supported Platforms_ list, with the exception of the Browser platform.
-
-To get a few ideas how to use the plugin, check out the [sample](#sample) at the bottom of this page. For additional examples (browser focused), see the HTML5 Rocks' [FileSystem article.](http://www.html5rocks.com/en/tutorials/file/filesystem/)
+For usage, please refer to HTML5 Rocks' excellent [FileSystem article.](http://www.html5rocks.com/en/tutorials/file/filesystem/)
For an overview of other storage options, refer to Cordova's
-[storage guide](http://cordova.apache.org/docs/en/latest/cordova/storage/storage.html).
+[storage guide](http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html).
This plugin defines global `cordova.file` object.
@@ -285,14 +282,6 @@ Listing asset directories is really slow on Android. You can speed it up though,
adding `src/android/build-extras.gradle` to the root of your android project (also
requires cordova-android@4.0.0 or greater).
-### Permisson to write to external storage when it's not mounted on Marshmallow
-
-Marshmallow requires the apps to ask for permissions when reading/writing to external locations. By
-[default](http://developer.android.com/guide/topics/data/data-storage.html#filesExternal), your app has permission to write to
-`cordova.file.applicationStorageDirectory` and `cordova.file.externalApplicationStorageDirectory`, and the plugin doesn't request permission
-for these two directories unless external storage is not mounted. However due to a limitation, when external storage is not mounted, it would ask for
-permission to write to `cordova.file.externalApplicationStorageDirectory`.
-
## iOS Quirks
- `cordova.file.applicationStorageDirectory` is read-only; attempting to store
@@ -558,314 +547,3 @@ Android also supports a special filesystem named "documents", which represents a
* `root`: The entire device filesystem
By default, the library and documents directories can be synced to iCloud. You can also request two additional filesystems, `library-nosync` and `documents-nosync`, which represent a special non-synced directory within the `/Library` or `/Documents` filesystem.
-
-## Sample: Create Files and Directories, Write, Read, and Append files <a name="sample"></a>
-
-The File plugin allows you to do things like store files in a temporary or persistent storage location for your app (sandboxed storage) and to store files in other platform-dependent locations. The code snippets in this section demonstrate different tasks including:
-* [Accessing the file system](#persistent)
-* Using cross-platform Cordova file URLs to [store your files](#appendFile) (see _Where to Store Files_ for more info)
-* Creating [files](#persistent) and [directories](#createDir)
-* [Writing to files](#writeFile)
-* [Reading files](#readFile)
-* [Appending files](#appendFile)
-* [Display an image file](#displayImage)
-
-## Create a persistent file <a name="persistent"></a>
-
-Before you use the File plugin APIs, you can get access to the file system using `requestFileSystem`. When you do this, you can request either persistent or temporary storage. Persistent storage will not be removed unless permission is granted by the user.
-
-When you get file system access using `requestFileSystem`, access is granted for the sandboxed file system only (the sandbox limits access to the app itself), not for general access to any file system location on the device. (To access file system locations outside the sandboxed storage, use other methods such as window.requestLocalFileSystemURL, which support platform-specific locations. For one example of this, see _Append a File_.)
-
-Here is a request for persistent storage.
-
->*Note* When targeting WebView clients (instead of a browser) or native apps (Windows), you dont need to use `requestQuota` before using persistent storage.
-
-```js
-window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, function (fs) {
-
- console.log('file system open: ' + fs.name);
- fs.root.getFile("newPersistentFile.txt", { create: true, exclusive: false }, function (fileEntry) {
-
- console.log("fileEntry is file?" + fileEntry.isFile.toString());
- // fileEntry.name == 'someFile.txt'
- // fileEntry.fullPath == '/someFile.txt'
- writeFile(fileEntry, null);
-
- }, onErrorCreateFile);
-
-}, onErrorLoadFs);
-```
-
-The success callback receives FileSystem object (fs). Use `fs.root` to return a DirectoryEntry object, which you can use to create or get a file (by calling `getFile`). In this example, `fs.root` is a DirectoryEntry object that represents the persistent storage in the sandboxed file system.
-
-The success callback for `getFile` receives a FileEntry object. You can use this to perform file write and file read operations.
-
-## Create a temporary file
-
-Here is an example of a request for temporary storage. Temporary storage may be deleted by the operating system if the device runs low on memory.
-
-```js
-window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
-
- console.log('file system open: ' + fs.name);
- createFile(fs.root, "newTempFile.txt", false);
-
-}, onErrorLoadFs);
-```
-When you are using temporary storage, you can create or get the file by calling `getFile`. As in the persistent storage example, this will give you a FileEntry object that you can use for read or write operations.
-
-```js
-function createFile(dirEntry, fileName, isAppend) {
- // Creates a new file or returns the file if it already exists.
- dirEntry.getFile(fileName, {create: true, exclusive: false}, function(fileEntry) {
-
- writeFile(fileEntry, null, isAppend);
-
- }, onErrorCreateFile);
-
-}
-```
-
-## Write to a file <a name="writeFile"></a>
-
-Once you have a FileEntry object, you can write to the file by calling `createWriter`, which returns a FileWriter object in the success callback. Call the `write` method of FileWriter to write to the file.
-
-```js
-function writeFile(fileEntry, dataObj) {
- // Create a FileWriter object for our FileEntry (log.txt).
- fileEntry.createWriter(function (fileWriter) {
-
- fileWriter.onwriteend = function() {
- console.log("Successful file read...");
- readFile(fileEntry);
- };
-
- fileWriter.onerror = function (e) {
- console.log("Failed file read: " + e.toString());
- };
-
- // If data object is not passed in,
- // create a new Blob instead.
- if (!dataObj) {
- dataObj = new Blob(['some file data'], { type: 'text/plain' });
- }
-
- fileWriter.write(dataObj);
- });
-}
-```
-
-## Read a file <a name="readFile"></a>
-
-You also need a FileEntry object to read an existing file. Use the file property of FileEntry to get the file reference, and then create a new FileReader object. You can use methods like `readAsText` to start the read operation. When the read operation is complete, `this.result` stores the result of the read operation.
-
-```js
-function readFile(fileEntry) {
-
- fileEntry.file(function (file) {
- var reader = new FileReader();
-
- reader.onloadend = function() {
- console.log("Successful file read: " + this.result);
- displayFileData(fileEntry.fullPath + ": " + this.result);
- };
-
- reader.readAsText(file);
-
- }, onErrorReadFile);
-}
-```
-
-## Append a file using alternative methods <a name="appendFile"></a>
-
-Of course, you will often want to append existing files instead of creating new ones. Here is an example of that. This example shows another way that you can access the file system using window.resolveLocalFileSystemURL. In this example, pass the cross-platform Cordova file URL, cordova.file.dataDirectory, to the function. The success callback receives a DirectoryEntry object, which you can use to do things like create a file.
-
-```js
-window.resolveLocalFileSystemURL(cordova.file.dataDirectory, function (dirEntry) {
- console.log('file system open: ' + dirEntry.name);
- var isAppend = true;
- createFile(dirEntry, "fileToAppend.txt", isAppend);
-}, onErrorLoadFs);
-```
-
-In addition to this usage, you can use `resolveLocalFileSystemURL` to get access to some file system locations that are not part of the sandboxed storage system. See _Where to store Files_ for more information; many of these storage locations are platform-specific. You can also pass cross-platform file system locations to `resolveLocalFileSystemURL` using the _cdvfile protocol_.
-
-For the append operation, there is nothing new in the `createFile` function that is called in the preceding code (see the preceding examples for the actual code). `createFile` calls `writeFile`. In `writeFile`, you check whether an append operation is requested.
-
-Once you have a FileWriter object, call the `seek` method, and pass in the index value for the position where you want to write. In this example, you also test whether the file exists. After calling seek, then call the write method of FileWriter.
-
-```js
-function writeFile(fileEntry, dataObj, isAppend) {
- // Create a FileWriter object for our FileEntry (log.txt).
- fileEntry.createWriter(function (fileWriter) {
-
- fileWriter.onwriteend = function() {
- console.log("Successful file read...");
- readFile(fileEntry);
- };
-
- fileWriter.onerror = function (e) {
- console.log("Failed file read: " + e.toString());
- };
-
- // If we are appending data to file, go to the end of the file.
- if (isAppend) {
- try {
- fileWriter.seek(fileWriter.length);
- }
- catch (e) {
- console.log("file doesn't exist!");
- }
- }
- fileWriter.write(dataObj);
- });
-}
-```
-
-## Store an existing binary file <a name="binaryFile"></a>
-
-We already showed how to write to a file that you just created in the sandboxed file system. What if you need to get access to an existing file and convert that to something you can store on your device? In this example, you obtain a file using an xhr request, and then save it to the cache in the sandboxed file system.
-
-Before you get the file, get a FileSystem reference using `requestFileSystem`. By passing window.TEMPORARY in the method call (same as before), the returned FileSystem object (fs) represents the cache in the sandboxed file system. Use `fs.root` to get the DirectoryEntry object that you need.
-
-```js
-window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
-
- console.log('file system open: ' + fs.name);
- getSampleFile(fs.root);
-
-}, onErrorLoadFs);
-```
-
-For completeness, here is the xhr request to get a Blob image. There is nothing Cordova-specific in this code, except that you forward the DirectoryEntry reference that you already obtained as an argument to the saveFile function. You will save the blob image and display it later after reading the file (to validate the operation).
-
-```js
-function getSampleFile(dirEntry) {
-
- var xhr = new XMLHttpRequest();
- xhr.open('GET', 'http://cordova.apache.org/static/img/cordova_bot.png', true);
- xhr.responseType = 'blob';
-
- xhr.onload = function() {
- if (this.status == 200) {
-
- var blob = new Blob([this.response], { type: 'image/png' });
- saveFile(dirEntry, blob, "downloadedImage.png");
- }
- };
- xhr.send();
-}
-```
->*Note* For Cordova 5 security, the preceding code requires that you add the domain name, http://cordova.apache.org, to the Content-Security-Policy <meta> element in index.html.
-
-After getting the file, copy the contents to a new file. The current DirectoryEntry object is already associated with the app cache.
-
-```js
-function saveFile(dirEntry, fileData, fileName) {
-
- dirEntry.getFile(fileName, { create: true, exclusive: false }, function (fileEntry) {
-
- writeFile(fileEntry, fileData);
-
- }, onErrorCreateFile);
-}
-```
-
-In writeFile, you pass in the Blob object as the dataObj and you will save that in the new file.
-
-```js
-function writeFile(fileEntry, dataObj, isAppend) {
-
- // Create a FileWriter object for our FileEntry (log.txt).
- fileEntry.createWriter(function (fileWriter) {
-
- fileWriter.onwriteend = function() {
- console.log("Successful file write...");
- if (dataObj.type == "image/png") {
- readBinaryFile(fileEntry);
- }
- else {
- readFile(fileEntry);
- }
- };
-
- fileWriter.onerror = function(e) {
- console.log("Failed file write: " + e.toString());
- };
-
- fileWriter.write(dataObj);
- });
-}
-```
-
-After writing to the file, read it and display it. You saved the image as binary data, so you can read it using FileReader.readAsArrayBuffer.
-
-```js
-function readBinaryFile(fileEntry) {
-
- fileEntry.file(function (file) {
- var reader = new FileReader();
-
- reader.onloadend = function() {
-
- console.log("Successful file write: " + this.result);
- displayFileData(fileEntry.fullPath + ": " + this.result);
-
- var blob = new Blob([new Uint8Array(this.result)], { type: "image/png" });
- displayImage(blob);
- };
-
- reader.readAsArrayBuffer(file);
-
- }, onErrorReadFile);
-}
-```
-
-After reading the data, you can display the image using code like this. Use window.URL.createObjectURL to get a DOM string for the Blob image.
-
-```js
-function displayImage(blob) {
-
- // Displays image if result is a valid DOM string for an image.
- var elem = document.getElementById('imageFile');
- // Note: Use window.URL.revokeObjectURL when finished with image.
- elem.src = window.URL.createObjectURL(blob);
-}
-```
-
-## Display an image file <a name="displayImage"></a>
-
-To display an image using a FileEntry, you can call the `toURL` method.
-
-```js
-function displayImageByFileURL(fileEntry) {
- var elem = document.getElementById('imageFile');
- elem.src = fileEntry.toURL();
-}
-```
-
-If you are using some platform-specific URIs instead of a FileEntry and you want to display an image, you may need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
-
-```html
-<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
-```
-
-## Create Directories <a name="createDir"></a>
-
-In the code here, you create directories in the root of the app storage location. You could use this code with any writable storage location (that is, any DirectoryEntry). Here, you write to the application cache (assuming that you used window.TEMPORARY to get your FileSystem object) by passing fs.root into this function.
-
-This code creates the /NewDirInRoot/images folder in the application cache. For platform-specific values, look at _File System Layouts_.
-
-```js
-function createDirectory(rootDirEntry) {
- rootDirEntry.getDirectory('NewDirInRoot', { create: true }, function (dirEntry) {
- dirEntry.getDirectory('images', { create: true }, function (subDirEntry) {
-
- createFile(subDirEntry, "fileInNewSubDir.txt");
-
- }, onErrorGetDir);
- }, onErrorGetDir);
-}
-```
-
-When creating subfolders, you need to create each folder separately as shown in the preceding code.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-geolocation/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-geolocation/index.md b/www/docs/en/6.x/reference/cordova-plugin-geolocation/index.md
index de11b0c..d656549 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-geolocation/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-geolocation/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-geolocation/blob/master/README.md'
-title: Geolocation
+title: cordova-plugin-geolocation
plugin_name: cordova-plugin-geolocation
plugin_version: master
-description: Access GPS data.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -32,16 +31,12 @@ description: Access GPS data.
# cordova-plugin-geolocation
This plugin provides information about the device's location, such as
-latitude and longitude.
-
-Common sources of location information include
+latitude and longitude. Common sources of location information include
Global Positioning System (GPS) and location inferred from network
signals such as IP address, RFID, WiFi and Bluetooth MAC addresses,
and GSM/CDMA cell IDs. There is no guarantee that the API returns the
device's actual location.
-> To get a few ideas, check out the [sample](#sample) at the bottom of this page or go straight to the [reference](#reference) content.
-
This API is based on the
[W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html),
and only executes on devices that don't already provide an implementation.
@@ -67,15 +62,11 @@ where it is otherwise missing).
Although the object is in the global scope, features provided by this plugin
are not available until after the `deviceready` event.
-```javascript
-
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log("navigator.geolocation works well");
}
-```
-## <a id="reference"></a>Reference
## Installation
This requires cordova 5.0+ ( current stable 1.0.0 )
@@ -135,8 +126,6 @@ error, the `geolocationError` callback is passed a
### Example
-```javascript
-
// onSuccess Callback
// This method accepts a Position object, which contains the
// current GPS coordinates
@@ -161,8 +150,6 @@ error, the `geolocationError` callback is passed a
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-```
-
### Android Quirks
If Geolocation service is turned off the `onError` callback is invoked after `timeout` interval (if specified).
@@ -194,8 +181,6 @@ there is an error, the `geolocationError` callback executes with a
### Example
-```javascript
-
// onSuccess Callback
// This method accepts a `Position` object, which contains
// the current GPS coordinates
@@ -218,7 +203,6 @@ there is an error, the `geolocationError` callback executes with a
//
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-```
## geolocationOptions
@@ -253,8 +237,6 @@ Stop watching for changes to the device's location referenced by the
### Example
-```javascript
-
// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
//
@@ -264,8 +246,6 @@ Stop watching for changes to the device's location referenced by the
navigator.geolocation.clearWatch(watchID);
-```
-
## Position
Contains `Position` coordinates and timestamp, created by the geolocation API.
@@ -325,438 +305,3 @@ callback function when an error occurs with navigator.geolocation.
- Returned when the device is unable to retrieve a position. In general, this means the device is not connected to a network or can't get a satellite fix.
- `PositionError.TIMEOUT`
- Returned when the device is unable to retrieve a position within the time specified by the `timeout` included in `geolocationOptions`. When used with `navigator.geolocation.watchPosition`, this error could be repeatedly passed to the `geolocationError` callback every `timeout` milliseconds.
-
-
-## <a id="sample"></a>Sample: Get the weather, find stores, and see photos of things nearby with Geolocation ##
-
-Use this plugin to help users find things near them such as Groupon deals, houses for sale, movies playing, sports and entertainment events and more.
-
-Here's a "cookbook" of ideas to get you started. In the snippets below, we'll show you some basic ways to add these features to your app.
-
-* [Get your coordinates](#coords).
-* [Get the weather forecast](#weather).
-* [Receive updated weather forecasts as you drive around](#receive).
-* [See where you are on a map](#see).
-* [Find stores near you](#find).
-* [See pictures of things around you](#see).
-
-## <a id="coord"></a>Get your geolocation coordinates
-
-```javascript
-
-function getWeatherLocation() {
-
- navigator.geolocation.getCurrentPosition
- (onWeatherSuccess, onWeatherError, { enableHighAccuracy: true });
-}
-
-```
-## <a id="weather"></a>Get the weather forecast
-
-```javascript
-
-// Success callback for get geo coordinates
-
-var onWeatherSuccess = function (position) {
-
- Latitude = position.coords.latitude;
- Longitude = position.coords.longitude;
-
- getWeather(Latitude, Longitude);
-}
-
-// Get weather by using coordinates
-
-function getWeather(latitude, longitude) {
-
- // Get a free key at http://openweathermap.org/. Replace the "Your_Key_Here" string with that key.
- var OpenWeatherAppKey = "Your_Key_Here";
-
- var queryString =
- 'http://api.openweathermap.org/data/2.5/weather?lat='
- + latitude + '&lon=' + longitude + '&appid=' + OpenWeatherAppKey + '&units=imperial';
-
- $.getJSON(queryString, function (results) {
-
- if (results.weather.length) {
-
- $.getJSON(queryString, function (results) {
-
- if (results.weather.length) {
-
- $('#description').text(results.name);
- $('#temp').text(results.main.temp);
- $('#wind').text(results.wind.speed);
- $('#humidity').text(results.main.humidity);
- $('#visibility').text(results.weather[0].main);
-
- var sunriseDate = new Date(results.sys.sunrise);
- $('#sunrise').text(sunriseDate.toLocaleTimeString());
-
- var sunsetDate = new Date(results.sys.sunrise);
- $('#sunset').text(sunsetDate.toLocaleTimeString());
- }
-
- });
- }
- }).fail(function () {
- console.log("error getting location");
- });
-}
-
-// Error callback
-
-function onWeatherError(error) {
- console.log('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
-}
-
-```
-
-## <a id="receive"></a>Receive updated weather forecasts as you drive around
-
-```javascript
-
-// Watch your changing position
-
-function watchWeatherPosition() {
-
- return navigator.geolocation.watchPosition
- (onWeatherWatchSuccess, onWeatherError, { enableHighAccuracy: true });
-}
-
-// Success callback for watching your changing position
-
-var onWeatherWatchSuccess = function (position) {
-
- var updatedLatitude = position.coords.latitude;
- var updatedLongitude = position.coords.longitude;
-
- if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
-
- Latitude = updatedLatitude;
- Longitude = updatedLongitude;
-
- // Calls function we defined earlier.
- getWeather(updatedLatitude, updatedLongitude);
- }
-}
-
-```
-
-## <a id="see"></a>See where you are on a map
-
-Both Bing and Google have map services. We'll use Google's. You'll need a key but it's free if you're just trying things out.
-
-Add a reference to the **maps** service.
-
-```HTML
-
- <script src="https://maps.googleapis.com/maps/api/js?key=Your_API_Key"></script>
-
-```
-Then, add code to use it.
-
-```javascript
-
-var Latitude = undefined;
-var Longitude = undefined;
-
-// Get geo coordinates
-
-function getMapLocation() {
-
- navigator.geolocation.getCurrentPosition
- (onMapSuccess, onMapError, { enableHighAccuracy: true });
-}
-
-// Success callback for get geo coordinates
-
-var onMapSuccess = function (position) {
-
- Latitude = position.coords.latitude;
- Longitude = position.coords.longitude;
-
- getMap(Latitude, Longitude);
-
-}
-
-// Get map by using coordinates
-
-function getMap(latitude, longitude) {
-
- var mapOptions = {
- center: new google.maps.LatLng(0, 0),
- zoom: 1,
- mapTypeId: google.maps.MapTypeId.ROADMAP
- };
-
- map = new google.maps.Map
- (document.getElementById("map"), mapOptions);
-
-
- var latLong = new google.maps.LatLng(latitude, longitude);
-
- var marker = new google.maps.Marker({
- position: latLong
- });
-
- marker.setMap(map);
- map.setZoom(15);
- map.setCenter(marker.getPosition());
-}
-
-// Success callback for watching your changing position
-
-var onMapWatchSuccess = function (position) {
-
- var updatedLatitude = position.coords.latitude;
- var updatedLongitude = position.coords.longitude;
-
- if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
-
- Latitude = updatedLatitude;
- Longitude = updatedLongitude;
-
- getMap(updatedLatitude, updatedLongitude);
- }
-}
-
-// Error callback
-
-function onMapError(error) {
- console.log('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
-}
-
-// Watch your changing position
-
-function watchMapPosition() {
-
- return navigator.geolocation.watchPosition
- (onMapWatchSuccess, onMapError, { enableHighAccuracy: true });
-}
-
-```
-
-## <a id="find"></a>Find stores near you
-
-You can use the same Google key for this.
-
-Add a reference to the **places** service.
-
-```HTML
-
-<script src=
-"https://maps.googleapis.com/maps/api/js?key=Your_API_Key&libraries=places">
-</script>
-
-```
-
-Then, add code to use it.
-
-```javascript
-
-var Map;
-var Infowindow;
-var Latitude = undefined;
-var Longitude = undefined;
-
-// Get geo coordinates
-
-function getPlacesLocation() {
- navigator.geolocation.getCurrentPosition
- (onPlacesSuccess, onPlacesError, { enableHighAccuracy: true });
-}
-
-// Success callback for get geo coordinates
-
-var onPlacesSuccess = function (position) {
-
- Latitude = position.coords.latitude;
- Longitude = position.coords.longitude;
-
- getPlaces(Latitude, Longitude);
-
-}
-
-// Get places by using coordinates
-
-function getPlaces(latitude, longitude) {
-
- var latLong = new google.maps.LatLng(latitude, longitude);
-
- var mapOptions = {
-
- center: new google.maps.LatLng(latitude, longitude),
- zoom: 15,
- mapTypeId: google.maps.MapTypeId.ROADMAP
-
- };
-
- Map = new google.maps.Map(document.getElementById("places"), mapOptions);
-
- Infowindow = new google.maps.InfoWindow();
-
- var service = new google.maps.places.PlacesService(Map);
- service.nearbySearch({
-
- location: latLong,
- radius: 500,
- type: ['store']
- }, foundStoresCallback);
-
-}
-
-// Success callback for watching your changing position
-
-var onPlacesWatchSuccess = function (position) {
-
- var updatedLatitude = position.coords.latitude;
- var updatedLongitude = position.coords.longitude;
-
- if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
-
- Latitude = updatedLatitude;
- Longitude = updatedLongitude;
-
- getPlaces(updatedLatitude, updatedLongitude);
- }
-}
-
-// Success callback for locating stores in the area
-
-function foundStoresCallback(results, status) {
-
- if (status === google.maps.places.PlacesServiceStatus.OK) {
-
- for (var i = 0; i < results.length; i++) {
-
- createMarker(results[i]);
-
- }
- }
-}
-
-// Place a pin for each store on the map
-
-function createMarker(place) {
-
- var placeLoc = place.geometry.location;
-
- var marker = new google.maps.Marker({
- map: Map,
- position: place.geometry.location
- });
-
- google.maps.event.addListener(marker, 'click', function () {
-
- Infowindow.setContent(place.name);
- Infowindow.open(Map, this);
-
- });
-}
-
-// Error callback
-
-function onPlacesError(error) {
- console.log('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
-}
-
-// Watch your changing position
-
-function watchPlacesPosition() {
-
- return navigator.geolocation.watchPosition
- (onPlacesWatchSuccess, onPlacesError, { enableHighAccuracy: true });
-}
-
-```
-
-## <a id="pictures"></a>See pictures of things around you
-
-Digital photos can contain geo coordinates that identify where the picture was taken.
-
-Use Flickr API's to find pictures that folks have taken near you. Like Google services, you'll need a key, but it's free if you just want to try things out.
-
-```javascript
-
-var Latitude = undefined;
-var Longitude = undefined;
-
-// Get geo coordinates
-
-function getPicturesLocation() {
-
- navigator.geolocation.getCurrentPosition
- (onPicturesSuccess, onPicturesError, { enableHighAccuracy: true });
-
-}
-
-// Success callback for get geo coordinates
-
-var onPicturesSuccess = function (position) {
-
- Latitude = position.coords.latitude;
- Longitude = position.coords.longitude;
-
- getPictures(Latitude, Longitude);
-}
-
-// Get pictures by using coordinates
-
-function getPictures(latitude, longitude) {
-
- $('#pictures').empty();
-
- var queryString =
- "https://api.flickr.com/services/rest/?method=flickr.photos.search&api_key=Your_API_Key&lat="
- + latitude + "&lon=" + longitude + "&format=json&jsoncallback=?";
-
- $.getJSON(queryString, function (results) {
- $.each(results.photos.photo, function (index, item) {
-
- var photoURL = "http://farm" + item.farm + ".static.flickr.com/" +
- item.server + "/" + item.id + "_" + item.secret + "_m.jpg";
-
- $('#pictures').append($("<img />").attr("src", photoURL));
-
- });
- }
- );
-}
-
-// Success callback for watching your changing position
-
-var onPicturesWatchSuccess = function (position) {
-
- var updatedLatitude = position.coords.latitude;
- var updatedLongitude = position.coords.longitude;
-
- if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
-
- Latitude = updatedLatitude;
- Longitude = updatedLongitude;
-
- getPictures(updatedLatitude, updatedLongitude);
- }
-}
-
-// Error callback
-
-function onPicturesError(error) {
-
- console.log('code: ' + error.code + '\n' +
- 'message: ' + error.message + '\n');
-}
-
-// Watch your changing position
-
-function watchPicturePosition() {
-
- return navigator.geolocation.watchPosition
- (onPicturesWatchSuccess, onPicturesError, { enableHighAccuracy: true });
-}
-
-```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-globalization/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-globalization/index.md b/www/docs/en/6.x/reference/cordova-plugin-globalization/index.md
index 26fa441..91c4906 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-globalization/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-globalization/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-globalization/blob/master/README.md'
-title: Globalization
+title: cordova-plugin-globalization
plugin_name: cordova-plugin-globalization
plugin_version: master
-description: Access locale data.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-inappbrowser/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-inappbrowser/index.md b/www/docs/en/6.x/reference/cordova-plugin-inappbrowser/index.md
index 01429d1..7f0d306 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-inappbrowser/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-inappbrowser/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-inappbrowser/blob/master/README.md'
-title: Inappbrowser
+title: cordova-plugin-inappbrowser
plugin_name: cordova-plugin-inappbrowser
plugin_version: master
-description: Open an in-app browser window.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -227,79 +226,6 @@ The object returned from a call to `cordova.InAppBrowser.open`.
- __callback__: the function that executes when the event fires. The function is passed an `InAppBrowserEvent` object as a parameter.
-## Example
-
-```javascript
-
-var inAppBrowserRef = undefined;
-
-function showHelp(url) {
-
- var target = "_blank";
-
- var options = "location=yes,hidden=yes";
-
- inAppBrowserRef = cordova.InAppBrowser.open(url, target, options);
-
- with (inAppBrowserRef) {
-
- addEventListener('loadstart', loadStartCallBack);
-
- addEventListener('loadstop', loadStopCallBack);
-
- addEventListener('loaderror', loadErrorCallBack);
- }
-
-}
-
-function loadStartCallBack() {
-
- $('#status-message').text("loading please wait ...");
-
-}
-
-function loadStopCallBack() {
-
- if (inAppBrowserRef != undefined) {
-
- inAppBrowserRef.insertCSS({ code: "body{font-size: 25px;" });
-
- $('#status-message').text("");
-
- inAppBrowserRef.show();
- }
-
-}
-
-function loadErrorCallBack(params) {
-
- $('#status-message').text("");
-
- var scriptErrorMesssage =
- "alert('Sorry we cannot open that page. Message from the server is : "
- + params.message + "');"
-
- inAppBrowserRef.executeScript({ code: scriptErrorMesssage }, executeScriptCallBack);
-
- inAppBrowserRef.close();
-
- inAppBrowserRef = undefined;
-
-}
-
-function executeScriptCallBack(params) {
-
- if (params[0] == null) {
-
- $('#status-message').text(
- "Sorry we couldn't open that page. Message from the server is : '"
- + params.message + "'");
- }
-
-}
-
-```
-
### InAppBrowserEvent Properties
- __type__: the eventname, either `loadstart`, `loadstop`, `loaderror`, or `exit`. _(String)_
@@ -477,161 +403,3 @@ Due to [MSDN docs](https://msdn.microsoft.com/en-us/library/windows.ui.xaml.cont
ref.addEventListener('loadstop', function() {
ref.insertCSS({file: "mystyles.css"});
});
-__
-
-## <a id="sample"></a>Sample: Show help pages with an InAppBrowser
-
-You can use this plugin to show helpful documentation pages within your app. Users can view online help documents and then close them without leaving the app.
-
-Here's a few snippets that show how you do this.
-
-* [Give users a way to ask for help](#give).
-* [Load a help page](#load).
-* [Let users know that you're getting their page ready](#let).
-* [Show the help page](#show).
-* [Handle page errors](#handle).
-
-### <a id="give"></a>Give users a way to ask for help
-
-There's lots of ways to do this in your app. A drop down list is a simple way to do that.
-
-```html
-
-<select id="help-select">
- <option value="default">Need help?</option>
- <option value="article">Show me a helpful article</option>
- <option value="video">Show me a helpful video</option>
- <option value="search">Search for other topics</option>
-</select>
-
-```
-
-Gather the users choice in the ``onDeviceReady`` function of the page and then send an appropriate URL to a helper function in some shared library file. Our helper function is named ``showHelp()`` and we'll write that function next.
-
-```javascript
-
-$('#help-select').on('change', function (e) {
-
- var url;
-
- switch (this.value) {
-
- case "article":
- url = "https://cordova.apache.org/docs/en/latest/"
- + "reference/cordova-plugin-inappbrowser/index.html";
- break;
-
- case "video":
- url = "https://youtu.be/F-GlVrTaeH0";
- break;
-
- case "search":
- url = "https://www.google.com/#q=inAppBrowser+plugin";
- break;
- }
-
- showHelp(url);
-
-});
-
-```
-
-### <a id="load"></a>Load a help page
-
-We'll use the ``open`` function to load the help page. We're setting the ``hidden`` property to ``yes`` so that we can show the browser only after the page content has loaded. That way, users don't see a blank browser while they wait for content to appear. When the ``loadstop`` event is raised, we'll know when the content has loaded. We'll handle that event shortly.
-
-```javascript
-
-function showHelp(url) {
-
- var target = "_blank";
-
- var options = "location=yes,hidden=yes";
-
- inAppBrowserRef = cordova.InAppBrowser.open(url, target, options);
-
- with (inAppBrowserRef) {
-
- addEventListener('loadstart', loadStartCallBack);
-
- addEventListener('loadstop', loadStopCallBack);
-
- addEventListener('loaderror', loadErrorCallBack);
- }
-
-}
-
-```
-
-### <a id="let"></a>Let users know that you're getting their page ready
-
-Because the browser doesn't immediately appear, we can use the ``loadstart`` event to show a status message, progress bar, or other indicator. This assures users that content is on the way.
-
-```javascript
-
-function loadStartCallBack() {
-
- $('#status-message').text("loading please wait ...");
-
-}
-
-```
-
-### <a id="show"></a>Show the help page
-
-When the ``loadstopcallback`` event is raised, we know that the content has loaded and we can make the browser visible. This sort of trick can create the impression of better performance. The truth is that whether you show the browser before content loads or not, the load times are exactly the same.
-
-```javascript
-
-function loadStopCallBack() {
-
- if (inAppBrowserRef != undefined) {
-
- inAppBrowserRef.insertCSS({ code: "body{font-size: 25px;" });
-
- $('#status-message').text("");
-
- inAppBrowserRef.show();
- }
-
-}
-
-```
-You might have noticed the call to the ``insertCSS`` function. This serves no particular purpose in our scenario. But it gives you an idea of why you might use it. In this case, we're just making sure that the font size of your pages have a certain size. You can use this function to insert any CSS style elements. You can even point to a CSS file in your project.
-
-### <a id="handle"></a>Handle page errors
-
-Sometimes a page no longer exists, a script error occurs, or a user lacks permission to view the resource. How or if you handle that situation is completely up to you and your design. You can let the browser show that message or you can present it in another way.
-
-We'll try to show that error in a message box. We can do that by injecting a script that calls the ``alert`` function. That said, this won't work in browsers on Windows devices so we'll have to look at the parameter of the ``executeScript`` callback function to see if our attempt worked. If it didn't work out for us, we'll just show the error message in a ``<div>`` on the page.
-
-```javascript
-
-function loadErrorCallBack(params) {
-
- $('#status-message').text("");
-
- var scriptErrorMesssage =
- "alert('Sorry we cannot open that page. Message from the server is : "
- + params.message + "');"
-
- inAppBrowserRef.executeScript({ code: scriptErrorMesssage }, executeScriptCallBack);
-
- inAppBrowserRef.close();
-
- inAppBrowserRef = undefined;
-
-}
-
-function executeScriptCallBack(params) {
-
- if (params[0] == null) {
-
- $('#status-message').text(
- "Sorry we couldn't open that page. Message from the server is : '"
- + params.message + "'");
- }
-
-}
-
-```
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-legacy-whitelist/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-legacy-whitelist/index.md b/www/docs/en/6.x/reference/cordova-plugin-legacy-whitelist/index.md
index 1a8af54..2cc5d53 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-legacy-whitelist/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-legacy-whitelist/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-legacy-whitelist/blob/master/README.md'
-title: Legacy Whitelist
+title: cordova-plugin-legacy-whitelist
plugin_name: cordova-plugin-legacy-whitelist
plugin_version: master
-description: Legacy implementation of the whitelist plugin.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-media-capture/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-media-capture/index.md b/www/docs/en/6.x/reference/cordova-plugin-media-capture/index.md
index 1dbf17d..dd6b295 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-media-capture/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-media-capture/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-media-capture/blob/master/README.md'
-title: Media Capture
+title: cordova-plugin-media-capture
plugin_name: cordova-plugin-media-capture
plugin_version: master
-description: 'Capture audio, video, and images.'
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -433,8 +432,6 @@ Each `MediaFile` object describes a captured media file.
- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
-- `CaptureError.CAPTURE_PERMISSION_DENIED`: The user denied a permission required to perform the given capture request.
-
- `CaptureError.CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
## CaptureErrorCB
@@ -643,41 +640,3 @@ Supports the following `MediaFileData` properties:
- __width__: Supported: image and video files only.
- __duration__: Supported: audio and video files only.
-
-## Android Lifecycle Quirks
-
-When capturing audio, video, or images on the Android platform, there is a chance that the
-application will get destroyed after the Cordova Webview is pushed to the background by
-the native capture application. See the [Android Lifecycle Guide][android-lifecycle] for
-a full description of the issue. In this case, the success and failure callbacks passed
-to the capture method will not be fired and instead the results of the call will be
-delivered via a document event that fires after the Cordova [resume event][resume-event].
-
-In your app, you should subscribe to the two possible events like so:
-
-```javascript
-function onDeviceReady() {
- // pendingcaptureresult is fired if the capture call is successful
- document.addEventListener('pendingcaptureresult', function(mediaFiles) {
- // Do something with result
- });
-
- // pendingcaptureerror is fired if the capture call is unsuccessful
- document.addEventListener('pendingcaptureerror', function(error) {
- // Handle error case
- });
-}
-
-// Only subscribe to events after deviceready fires
-document.addEventListener('deviceready', onDeviceReady);
-```
-
-It is up you to track what part of your code these results are coming from. Be sure to
-save and restore your app's state as part of the [pause][pause-event] and
-[resume][resume-event] events as appropriate. Please note that these events will only
-fire on the Android platform and only when the Webview was destroyed during a capture
-operation.
-
-[android-lifecycle]: http://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html#lifecycle-guide
-[pause-event]: http://cordova.apache.org/docs/en/latest/cordova/events/events.html#pause
-[resume-event]: http://cordova.apache.org/docs/en/latest/cordova/events/events.html#resume
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[2/6] docs commit: added note about ios plugin upgrade issues
Posted by st...@apache.org.
added note about ios plugin upgrade issues
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/52bf193e
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/52bf193e
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/52bf193e
Branch: refs/heads/master
Commit: 52bf193e638620511395d45b51056030530ebb30
Parents: 0d1574f
Author: Steve Gill <st...@gmail.com>
Authored: Mon Aug 22 18:19:30 2016 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Mon Aug 22 18:21:04 2016 -0700
----------------------------------------------------------------------
www/_posts/2016-08-22-android-ios-release.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/52bf193e/www/_posts/2016-08-22-android-ios-release.md
----------------------------------------------------------------------
diff --git a/www/_posts/2016-08-22-android-ios-release.md b/www/_posts/2016-08-22-android-ios-release.md
index cae2e70..5111e9a 100644
--- a/www/_posts/2016-08-22-android-ios-release.md
+++ b/www/_posts/2016-08-22-android-ios-release.md
@@ -10,7 +10,11 @@ tags: news releases
We are happy to announce patch releases for`Cordova Android 5.2.2` & `Cordova iOS 4.2.1` have been released! We have also updated and released `Cordova Common 1.4.1`.
-These release fixes issues with the upcoming `edit-config` functionality coming to `plugin.xml`.
+These release fixes issues with the upcoming `edit-config` functionality coming to `plugin.xml`.
+
+**Note:** When updating **iOS**, make sure to save your plugins as current unsaved plugins may not be reinstalled otherwise. Run the following command in your project to save your currently installed plugins into `config.xml`:
+
+ cordova plugin save
To upgrade:
@@ -27,7 +31,7 @@ To add it explicitly:
<!--more-->
## What's new in Android
-* [CB-11615](https://issues.apache.org/jira/browse/CB-11615) updated `cordoova-common` to `1.4.0`
+* [CB-11615](https://issues.apache.org/jira/browse/CB-11615) updated `cordova-common` to `1.4.0`
## What's new in iOS
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[3/6] docs commit: copied dev docsinto 6.x for english
Posted by st...@apache.org.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-media/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-media/index.md b/www/docs/en/6.x/reference/cordova-plugin-media/index.md
index f12da05..55b8aa5 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-media/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-media/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-media/blob/master/README.md'
-title: Media
+title: cordova-plugin-media
plugin_name: cordova-plugin-media
plugin_version: master
-description: Record and play audio on the device.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -102,8 +101,6 @@ The following constants are reported as the only parameter to the
### Methods
-- `media.getCurrentAmplitude`: Returns the current position within an audio file.
-
- `media.getCurrentPosition`: Returns the current position within an audio file.
- `media.getDuration`: Returns the duration of an audio file.
@@ -112,12 +109,8 @@ The following constants are reported as the only parameter to the
- `media.pause`: Pause playback of an audio file.
-- `media.pauseRecord`: Pause recording of an audio file.
-
- `media.release`: Releases the underlying operating system's audio resources.
-- `media.resumeRecord`: Resume recording of an audio file.
-
- `media.seekTo`: Moves the position within the audio file.
- `media.setVolume`: Set the volume for audio playback.
@@ -136,47 +129,6 @@ The following constants are reported as the only parameter to the
- __duration__: The duration of the media, in seconds.
-## media.getCurrentAmplitude
-
-Returns the current amplitude of the current recording.
-
- media.getCurrentAmplitude(mediaSuccess, [mediaError]);
-
-### Supported Platforms
-
-- Android
-- iOS
-
-### Parameters
-
-- __mediaSuccess__: The callback that is passed the current amplitude (0.0 - 1.0).
-
-- __mediaError__: (Optional) The callback to execute if an error occurs.
-
-### Quick Example
-
- // Audio player
- //
- var my_media = new Media(src, onSuccess, onError);
-
- // Record audio
- my_media.startRecord();
-
- mediaTimer = setInterval(function () {
- // get media amplitude
- my_media.getCurrentAmplitude(
- // success callback
- function (amp) {
- console.log(amp + "%");
- },
- // error callback
- function (e) {
- console.log("Error getting amp=" + e);
- }
- );
- }, 1000);
-
-
## media.getCurrentPosition
Returns the current position within an audio file. Also updates the `Media` object's `position` parameter.
@@ -271,44 +223,6 @@ Pauses playing an audio file.
}
-## media.pauseRecord
-
-Pauses recording an audio file.
-
- media.pauseRecord();
-
-
-### Supported Platforms
-
-- iOS
-
-
-### Quick Example
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src,
- // success callback
- function() {
- console.log("recordAudio():Audio Success");
- },
-
- // error callback
- function(err) {
- console.log("recordAudio():Audio Error: "+ err.code);
- });
-
- // Record audio
- mediaRec.startRecord();
-
- // Pause Recording after 5 seconds
- setTimeout(function() {
- my_media.pauseRecord();
- }, 5000);
- }
-
## media.play
Starts or resumes playing an audio file.
@@ -381,50 +295,6 @@ function for any `Media` resource that is no longer needed.
my_media.release();
-## media.resumeRecord
-
-Resume recording an audio file.
-
- media.resumeRecord();
-
-
-### Supported Platforms
-
-- iOS
-
-
-### Quick Example
-
- // Record audio
- //
- function recordAudio() {
- var src = "myrecording.mp3";
- var mediaRec = new Media(src,
- // success callback
- function() {
- console.log("recordAudio():Audio Success");
- },
-
- // error callback
- function(err) {
- console.log("recordAudio():Audio Error: "+ err.code);
- });
-
- // Record audio
- mediaRec.startRecord();
-
- // Pause Recording after 5 seconds
- setTimeout(function() {
- my_media.pauseRecord();
- }, 5000);
-
- // Resume Recording after 10 seconds
- setTimeout(function() {
- my_media.resumeRecord();
- }, 10000);
- }
-
-
## media.seekTo
Sets the current position within an audio file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-network-information/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-network-information/index.md b/www/docs/en/6.x/reference/cordova-plugin-network-information/index.md
index 42067f7..0e9a5f2 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-network-information/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-network-information/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-network-information/blob/master/README.md'
-title: Network Information
+title: cordova-plugin-network-information
plugin_name: cordova-plugin-network-information
plugin_version: master
-description: Get information about wireless connectivity.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -37,12 +36,8 @@ This plugin provides an implementation of an old version of the
It provides information about the device's cellular and
wifi connection, and whether the device has an internet connection.
-> To get a few ideas how to use the plugin, check out the [sample](#sample) at the bottom of this page or go straight to the [reference](#reference) content.
-
Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cordova issue tracker].
-##<a name="reference"></a>Reference
-
## Installation
cordova plugin add cordova-plugin-network-information
@@ -224,120 +219,4 @@ When running in the Emulator, the `connection.status` is always unknown, so this
The Emulator reports the connection type as `Cellular`, which does not change, so events does _not_ fire.
-## Sample: Upload a File Depending on your Network State <a name="sample"></a>
-
-The code examples in this section show examples of changing app behavior using the online and offline events and your network connection status.
-
-To start with, create a new FileEntry object (data.txt) to use for sample data. Call this function from the `deviceready` handler.
-
->*Note* This code example requires the File plugin.
-
-```js
-
-var dataFileEntry;
-
-function createSomeData() {
-
- window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
-
- console.log('file system open: ' + fs.name);
- // Creates a new file or returns an existing file.
- fs.root.getFile("data.txt", { create: true, exclusive: false }, function (fileEntry) {
-
- dataFileEntry = fileEntry;
-
- }, onErrorCreateFile);
-
- }, onErrorLoadFs);
-}
-```
-
-Next, add listeners for the online and offline events in the `deviceready` handler.
-
-```js
-document.addEventListener("offline", onOffline, false);
-document.addEventListener("online", onOnline, false);
-```
-
-The app's `onOnline` function handles the online event. In the event handler, check the current network state. In this app, treat any connection type as good except Connection.NONE. If you have a connection, you try to upload a file.
-
-```js
-function onOnline() {
- // Handle the online event
- var networkState = navigator.connection.type;
-
- if (networkState !== Connection.NONE) {
- if (dataFileEntry) {
- tryToUploadFile();
- }
- }
- display('Connection type: ' + networkState);
-}
-```
-
-When the online event fires in the preceding code, call the app's `tryToUploadFile` function.
-
-If the FileTransfer object's upload function fails, call the app's `offlineWrite` function to save the current data somewhere.
-
->*Note* This example requires the FileTransfer plugin.
-
-```js
-function tryToUploadFile() {
- // !! Assumes variable fileURL contains a valid URL to a text file on the device,
- var fileURL = getDataFileEntry().toURL();
-
- var success = function (r) {
- console.log("Response = " + r.response);
- display("Uploaded. Response: " + r.response);
- }
-
- var fail = function (error) {
- console.log("An error has occurred: Code = " + error.code);
- offlineWrite("Failed to upload: some offline data");
- }
-
- var options = new FileUploadOptions();
- options.fileKey = "file";
- options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
- options.mimeType = "text/plain";
-
- var ft = new FileTransfer();
- // Make sure you add the domain of your server URL to the
- // Content-Security-Policy <meta> element in index.html.
- ft.upload(fileURL, encodeURI(SERVER), success, fail, options);
-};
-```
-
-Here is the code for the `offlineWrite` function.
-
->*Note* This code examples requires the File plugin.
-
-```js
-function offlineWrite(offlineData) {
- // Create a FileWriter object for our FileEntry.
- dataFileEntry.createWriter(function (fileWriter) {
-
- fileWriter.onwriteend = function () {
- console.log("Successful file write...");
- display(offlineData);
- };
-
- fileWriter.onerror = function (e) {
- console.log("Failed file write: " + e.toString());
- };
-
- fileWriter.write(offlineData);
- });
-}
-```
-
-If the offline event occurs, just do something like notify the user (for this example, just log it).
-
-```js
-function onOffline() {
- // Handle the offline event
- console.log("lost connection");
-}
-```
-
[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%20Network%20Information%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-splashscreen/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-splashscreen/index.md b/www/docs/en/6.x/reference/cordova-plugin-splashscreen/index.md
index 890551e..acda36c 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-splashscreen/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-splashscreen/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-splashscreen/blob/master/README.md'
-title: Splashscreen
+title: cordova-plugin-splashscreen
plugin_name: cordova-plugin-splashscreen
plugin_version: master
-description: Control the splash screen for your app.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
@@ -50,33 +49,14 @@ Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cord
- BlackBerry 10
- iOS
- Windows Phone 7 and 8
-- Windows (`cordova-windows` version >= 4.4.0 is required)
+- Windows 8
+- Windows
- Browser
-__Note__: Extended splashscreen does not require the plugin on Windows (as opposed to Android and iOS) in case you don't use the plugin API, i.e. programmatic hide/show.
-
## Example Configuration
In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here.
-Please notice that the value of the "src" attribute is relative to the project root directory and not to the www directory (see `Directory structure` below). You can name the source image whatever you like. The internal name in the app is determined by Cordova.
-
-Directory structure:
-
-```
-projectRoot
- hooks
- platforms
- plugins
- www
- css
- img
- js
- res
- screen
- android
- ios
- windows
-```
+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 is determined by Cordova.
```xml
<platform name="android">
@@ -125,75 +105,30 @@ projectRoot
#### config.xml
-- `AutoHideSplashScreen` (boolean, default to `true`). Indicates whether to hide splash screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay` preference.
+- __AutoHideSplashScreen__ (boolean, default to `true`). Indicates wherether hide splash screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay` preference.
```xml
<preference name="AutoHideSplashScreen" value="true" />
```
-- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.
+- __SplashScreenDelay__ (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.
```xml
<preference name="SplashScreenDelay" value="3000" />
```
-Note also that this value used to be seconds, and not milliseconds, so values less than 30 will still be treated as seconds. ( Consider this a deprecated patch that will disapear in some future version. )
-
-To disable the splashscreen add the following preference to `config.xml`:
-```xml
-<preference name="SplashScreenDelay" value="0"/>
-```
-
-**iOS Quirk**: to disable the splashscreen on `ios` platform you should also add `<preference name="FadeSplashScreenDuration" value="0"/>` to `config.xml`.
-
-- `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
- prevent the splash screen from fading in and out when its display
- state changes.
-
-```xml
- <preference name="FadeSplashScreen" value="false"/>
-```
-
-- `FadeSplashScreenDuration` (float, defaults to `500`): Specifies the
- number of milliseconds for the splash screen fade effect to execute.
-
-```xml
- <preference name="FadeSplashScreenDuration" value="750"/>
-```
-
-_Note_: `FadeSplashScreenDuration` is included into `SplashScreenDelay`, for example if you have `<preference name="SplashScreenDelay" value="3000" />` and `<preference name="FadeSplashScreenDuration" value="1000"/>` defined in `config.xml`:
-
-- 00:00 - splashscreen is shown
-- 00:02 - fading has started
-- 00:03 - splashscreen is hidden
-
-Turning the fading off via `<preference name="FadeSplashScreen" value="false"/>` technically means fading duration to be `0` so that in this example the overall splash delay will still be 3 seconds.
-
-_Note_: This only applies to the app startup - you need to take the fading timeout into account when manually showing/hiding the splashscreen in the code:
-
-```javascript
-navigator.splashscreen.show();
-window.setTimeout(function () {
- navigator.splashscreen.hide();
-}, splashDuration - fadeDuration);
-```
-
-- `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
- to hide the splash-screen spinner.
-
-```xml
- <preference name="ShowSplashScreenSpinner" value="false"/>
-```
-
### Android Quirks
-In your `config.xml`, you can add the following preferences:
+In your `config.xml`, you need to add the following preferences:
```xml
+<preference name="SplashScreenDelay" value="3000" />
<preference name="SplashMaintainAspectRatio" value="true|false" />
<preference name="SplashShowOnlyFirstTime" value="true|false" />
```
+The first parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms.
+
"SplashMaintainAspectRatio" preference is optional. If set to true, splash screen drawable is not stretched to fit screen, but instead simply "covers" the screen, like CSS "background-size:cover". This is very useful when splash screen images cannot be distorted in any way, for example when they contain scenery or text. This setting works best with images that have large margins (safe areas) that can be safely cropped on screens with different aspect ratios.
The plugin reloads splash drawable whenever orientation changes, so you can specify different drawables for portrait and landscape orientations.
@@ -217,24 +152,49 @@ You can use the following preferences in your `config.xml`:
__Note__: `SplashScreen` value should be absolute in order to work in a sub-page. The `SplashScreen` value is used only for the browser platform. The value will be ignored for other platforms.
-### iOS Quirks
+### Android and iOS Quirks
- In iOS, the splashscreen images are called launch images. These images are mandatory on iOS.
-### Windows Quirks
+- `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
+ prevent the splash screen from fading in and out when its display
+ state changes.
+
+```xml
+ <preference name="FadeSplashScreen" value="false"/>
+```
-- `SplashScreenSpinnerColor` (string, defaults to system accent color): hash, rgb notation or CSS color name.
+- `FadeSplashScreenDuration` (float, defaults to `3000`): Specifies the
+ number of milliseconds for the splash screen fade effect to execute.
```xml
-<preference name="SplashScreenSpinnerColor" value="#242424"/>
-<preference name="SplashScreenSpinnerColor" value="DarkRed"/>
-<preference name="SplashScreenSpinnerColor" value="rgb(50,128,128)"/>
+ <preference name="FadeSplashScreenDuration" value="3000"/>
```
-- `SplashScreenBackgroundColor` (string, defaults to #464646): hex notation.
+Note also that this value used to be seconds, and not milliseconds, so values less than 30 will still be treated as seconds. ( Consider this a deprecated patch that will disapear in some future version. )
+
+_Note_: `FadeSplashScreenDuration` is included into `SplashScreenDelay`, for example if you have `<preference name="SplashScreenDelay" value="3000" />` and `<preference name="FadeSplashScreenDuration" value="1000"/>` defined in `config.xml`:
+
+- 00:00 - splashscreen is shown
+- 00:02 - fading has started
+- 00:03 - splashscreen is hidden
+
+Turning the fading off via `<preference name="FadeSplashScreen" value="false"/>` technically means fading duration to be `0` so that in this example the overall splash delay will still be 3 seconds.
+
+_Note_: This only applies to the app startup - you need to take the fading timeout into account when manually showing/hiding the splashscreen in the code:
+
+```javascript
+navigator.splashscreen.show();
+window.setTimeout(function () {
+ navigator.splashscreen.hide();
+}, splashDuration - fadeDuration);
+```
+
+- `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
+ to hide the splash-screen spinner.
```xml
-<preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
+ <preference name="ShowSplashScreenSpinner" value="false"/>
```
## Methods
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-statusbar/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-statusbar/index.md b/www/docs/en/6.x/reference/cordova-plugin-statusbar/index.md
index 4071532..16ac56b 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-statusbar/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-statusbar/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-statusbar/blob/master/README.md'
-title: Statusbar
+title: cordova-plugin-statusbar
plugin_name: cordova-plugin-statusbar
plugin_version: master
-description: Control the device status bar.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-vibration/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-vibration/index.md b/www/docs/en/6.x/reference/cordova-plugin-vibration/index.md
index d3a7f75..551f98c 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-vibration/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-vibration/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-vibration/blob/master/README.md'
-title: Vibration
+title: cordova-plugin-vibration
plugin_name: cordova-plugin-vibration
plugin_version: master
-description: Vibrate the device.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d24004ab/www/docs/en/6.x/reference/cordova-plugin-whitelist/index.md
----------------------------------------------------------------------
diff --git a/www/docs/en/6.x/reference/cordova-plugin-whitelist/index.md b/www/docs/en/6.x/reference/cordova-plugin-whitelist/index.md
index 9fadb56..342bc57 100644
--- a/www/docs/en/6.x/reference/cordova-plugin-whitelist/index.md
+++ b/www/docs/en/6.x/reference/cordova-plugin-whitelist/index.md
@@ -1,9 +1,8 @@
---
edit_link: 'https://github.com/apache/cordova-plugin-whitelist/blob/master/README.md'
-title: Whitelist
+title: cordova-plugin-whitelist
plugin_name: cordova-plugin-whitelist
plugin_version: master
-description: Whitelist external content accessible by your app.
---
<!-- WARNING: This file is generated. See fetch_docs.js. -->
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org