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:06 UTC
[4/6] docs commit: copied dev docsinto 6.x for english
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