You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/01/04 02:19:31 UTC
[6/10] Version 2.3.0
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/geolocation.clearWatch.md b/docs/en/2.3.0/cordova/geolocation/geolocation.clearWatch.md
new file mode 100644
index 0000000..8041dfa
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/geolocation.clearWatch.md
@@ -0,0 +1,119 @@
+---
+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.
+---
+
+geolocation.clearWatch
+======================
+
+Stop watching for changes to the device's location referenced by the `watchID` parameter.
+
+ navigator.geolocation.clearWatch(watchID);
+
+Parameters
+----------
+
+- __watchID:__ The id of the `watchPosition` interval to clear. (String)
+
+Description
+-----------
+
+`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // Options: watch for changes in position, and use the most
+ // accurate position acquisition method available.
+ //
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
+
+ // ...later on...
+
+ navigator.geolocation.clearWatch(watchID);
+
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ var watchID = null;
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Get the most accurate position updates available on the
+ // device.
+ var options = { enableHighAccuracy: true };
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // clear the watch that was started earlier
+ //
+ function clearWatch() {
+ if (watchID != null) {
+ navigator.geolocation.clearWatch(watchID);
+ watchID = null;
+ }
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Watching geolocation...</p>
+ <button onclick="clearWatch();">Clear Watch</button>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/2.3.0/cordova/geolocation/geolocation.getCurrentPosition.md
new file mode 100644
index 0000000..197ba70
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -0,0 +1,128 @@
+---
+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.
+---
+
+geolocation.getCurrentPosition
+==============================
+
+Returns the device's current position as a `Position` object.
+
+ navigator.geolocation.getCurrentPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
+
+Parameters
+----------
+
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
+
+Description
+-----------
+
+`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ // This method accepts a `Position` object, which contains
+ // the current GPS coordinates
+ //
+ var onSuccess = function(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ };
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ navigator.geolocation.getCurrentPosition(onSuccess, onError);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ 'Altitude: ' + position.coords.altitude + '<br />' +
+ 'Accuracy: ' + position.coords.accuracy + '<br />' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '<br />' +
+ 'Heading: ' + position.coords.heading + '<br />' +
+ 'Speed: ' + position.coords.speed + '<br />' +
+ 'Timestamp: ' + position.timestamp + '<br />';
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Finding geolocation...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/geolocation.md b/docs/en/2.3.0/cordova/geolocation/geolocation.md
new file mode 100644
index 0000000..ae1e8ab
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/geolocation.md
@@ -0,0 +1,104 @@
+---
+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.
+---
+
+Geolocation
+===========
+
+> The `geolocation` object provides access to the device's GPS sensor.
+
+Geolocation provides location information for the device, such as 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. No guarantee is given that the API returns the device's actual location.
+
+This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html). Some devices (Android, BlackBerry, Bada, Windows Phone 7, webOS and Tizen, to be specific) already provide an implementation of this spec. For those devices, the built-in support is used instead of replacing it with Cordova's implementation. For devices that don't have geolocation support, the Cordova implementation adheres to the W3C specification.
+
+Methods
+-------
+
+- geolocation.getCurrentPosition
+- geolocation.watchPosition
+- geolocation.clearWatch
+
+
+Arguments
+---------
+
+- geolocationSuccess
+- geolocationError
+- geolocationOptions
+
+Objects (Read-Only)
+-------------------
+
+- Position
+- PositionError
+- Coordinates
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" />
+
+#### app/AndroidManifest.xml
+
+ <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+ <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
+
+### Bada
+
+ No permissions are required.
+
+### BlackBerry WebWorks
+
+#### www/plugins.xml
+
+ <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" />
+
+#### www/config.xml
+
+ <rim:permissions>
+ <rim:permit>read_geolocation</rim:permit>
+ </rim:permissions>
+
+### iOS
+
+#### config.xml
+
+ <plugin name="Geolocation" value="CDVLocation" />
+
+### webOS
+
+ No permissions are required.
+
+### Windows Phone
+
+#### Properties/WPAppManifest.xml
+
+ <Capabilities>
+ <Capability Name="ID_CAP_LOCATION" />
+ </Capabilities>
+
+Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
+
+### Tizen
+
+ No permissions are required.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/geolocation.watchPosition.md b/docs/en/2.3.0/cordova/geolocation/geolocation.watchPosition.md
new file mode 100644
index 0000000..6e221d7
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/geolocation.watchPosition.md
@@ -0,0 +1,130 @@
+---
+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.
+---
+
+geolocation.watchPosition
+=========================
+
+Watches for changes to the device's current position.
+
+ var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
+ [geolocationError],
+ [geolocationOptions]);
+
+Parameters
+----------
+
+- __geolocationSuccess__: The callback that is called with the current position.
+- __geolocationError__: (Optional) The callback that is called if there was an error.
+- __geolocationOptions__: (Optional) The geolocation options.
+
+Returns
+-------
+
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
+
+Description
+-----------
+
+`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+- Windows Phone 7 and 8
+- Bada 1.2 & 2.x
+- webOS
+- Tizen
+- Windows 8
+
+Quick Example
+-------------
+
+ // onSuccess Callback
+ // This method accepts a `Position` object, which contains
+ // the current GPS coordinates
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ // Options: throw an error if no update is received every 30 seconds.
+ //
+ var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
+
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>Device Properties Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ var watchID = null;
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // Throw an error if no update is received every 30 seconds
+ var options = { timeout: 30000 };
+ watchID = navigator.geolocation.watchPosition(onSuccess, onError, options);
+ }
+
+ // onSuccess Geolocation
+ //
+ function onSuccess(position) {
+ var element = document.getElementById('geolocation');
+ element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
+ 'Longitude: ' + position.coords.longitude + '<br />' +
+ '<hr />' + element.innerHTML;
+ }
+
+ // onError Callback receives a PositionError object
+ //
+ function onError(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ }
+
+ </script>
+ </head>
+ <body>
+ <p id="geolocation">Watching geolocation...</p>
+ </body>
+ </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/parameters/geolocation.options.md b/docs/en/2.3.0/cordova/geolocation/parameters/geolocation.options.md
new file mode 100644
index 0000000..d822d24
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/parameters/geolocation.options.md
@@ -0,0 +1,41 @@
+---
+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.
+---
+
+geolocationOptions
+==================
+
+Optional parameters to customize the retrieval of the geolocation
+`Position`.
+
+ { maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
+
+Options
+-------
+
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
+
+Android Quirks
+--------------
+
+The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true.
+
+ { enableHighAccuracy: true }
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/parameters/geolocationError.md b/docs/en/2.3.0/cordova/geolocation/parameters/geolocationError.md
new file mode 100644
index 0000000..c0091a0
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/parameters/geolocationError.md
@@ -0,0 +1,32 @@
+---
+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.
+---
+
+geolocationError
+================
+
+The user's callback function that is called when there is an error for geolocation functions.
+
+ function(error) {
+ // Handle the error
+ }
+
+Parameters
+----------
+
+- __error:__ The error returned by the device. (`PositionError`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/2.3.0/cordova/geolocation/parameters/geolocationSuccess.md
new file mode 100644
index 0000000..b70a579
--- /dev/null
+++ b/docs/en/2.3.0/cordova/geolocation/parameters/geolocationSuccess.md
@@ -0,0 +1,46 @@
+---
+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.
+---
+
+geolocationSuccess
+==================
+
+The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
+
+ function(position) {
+ // Do something
+ }
+
+Parameters
+----------
+
+- __position:__ The geolocation position returned by the device. (`Position`)
+
+Example
+-------
+
+ function geolocationSuccess(position) {
+ alert('Latitude: ' + position.coords.latitude + '\n' +
+ 'Longitude: ' + position.coords.longitude + '\n' +
+ 'Altitude: ' + position.coords.altitude + '\n' +
+ 'Accuracy: ' + position.coords.accuracy + '\n' +
+ 'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
+ 'Heading: ' + position.coords.heading + '\n' +
+ 'Speed: ' + position.coords.speed + '\n' +
+ 'Timestamp: ' + position.timestamp + '\n');
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/2.3.0/cordova/globalization/GlobalizationError/globalizationerror.md
new file mode 100644
index 0000000..5623dd3
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -0,0 +1,93 @@
+---
+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.
+---
+
+GlobalizationError
+============
+
+An object representing a error from the Globalization API.
+
+Properties
+----------
+
+- __code:__ One of the following codes representing the error type (`Number`)
+ - GlobalizationError.UNKNOWN\_ERROR: 0
+ - GlobalizationError.FORMATTING\_ERROR: 1
+ - GlobalizationError.PARSING\_ERROR: 2
+ - GlobalizationError.PATTERN\_ERROR: 3
+- __message:__ A text message that includes the error explanation and/or details (`String`)
+
+Description
+-----------
+
+This object is created and populated by Cordova, and returned to a callback in the case of an error.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iOS
+
+Quick Example
+-------------
+
+When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
+
+ function errorCB(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ };
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function successCB(date) {
+ alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');
+ }
+
+ function errorCB(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ };
+
+ function checkError() {
+ navigator.globalization.stringToDate(
+ 'notADate',
+ successCB,
+ errorCB,
+ {selector:'foobar'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkError()">Click for error</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.dateToString.md b/docs/en/2.3.0/cordova/globalization/globalization.dateToString.md
new file mode 100644
index 0000000..10c9e43
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.dateToString.md
@@ -0,0 +1,91 @@
+---
+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.
+---
+
+globalization.dateToString
+===========
+
+Returns a date formatted as a string according to the client's locale and timezone.
+
+ navigator.globalization.dateToString(date, successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+
+The inbound ``date`` parameter should be of type ``Date``.
+
+If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+
+`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
+`options.selector` can be 'date', 'time' or 'date and time'.
+
+The default options are `{formatLength:'short', selector:'date and time'}`.
+The `options` parameter is optional.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options.
+
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) {alert('date:' + date.value + '\n');},
+ function () {alert('Error getting dateString\n');},
+ {formatLength:'short', selector:'date and time'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateString() {
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) {alert('date: ' + date.value + '\n');},
+ function () {alert('Error getting dateString\n');,
+ {formatLength:'short', selector:'date and time'}}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDateString()">Click for date string</button>
+ </body>
+ </html>
+
+
+Windows Phone 8 Quirks
+--------------
+- `formatLength` option supports only short and full values
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/2.3.0/cordova/globalization/globalization.getCurrencyPattern.md
new file mode 100644
index 0000000..6d46913
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getCurrencyPattern.md
@@ -0,0 +1,106 @@
+---
+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.
+---
+
+globalization.getCurrencyPattern
+===========
+
+Returns a pattern string for formatting and parsing currency values according
+to the client's user preferences and ISO 4217 currency code.
+
+ navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB);
+
+Description
+-----------
+
+It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+
+- pattern {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
+- code {String}: The ISO 4217 currency code for the pattern.
+- fraction {Number}: The number of fractional digits to use when parsing and formatting currency.
+- rounding {Number}: The rounding increment to use when parsing and formatting.
+- decimal: {String}: The decimal symbol to use for parsing and formatting.
+- grouping: {String}: The grouping symbol to use for parsing and formatting.
+
+The inbound `currencyCode` parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'.
+
+If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to:
+
+ pattern: $#,##0.##;($#,##0.##)
+ code: USD
+ fraction: 2
+ rounding: 0
+ decimal: .
+ grouping: ,
+
+.
+
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');}
+ );
+
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'code: ' + pattern.code + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkPattern()">Click for pattern</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getDateNames.md b/docs/en/2.3.0/cordova/globalization/globalization.getDateNames.md
new file mode 100644
index 0000000..58b519a
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getDateNames.md
@@ -0,0 +1,93 @@
+---
+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.
+---
+
+globalization.getDateNames
+===========
+
+Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.
+
+ navigator.globalization.getDateNames(successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+
+If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+
+`options.type` can be 'narrow', or 'wide'.
+`options.item` can be 'months', or 'days'.
+
+The default options are `{type:'wide', item:'months'}`.
+The options parameter is optional.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
+
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i=0; i<names.value.length; i++) {
+ alert('month: ' + names.value[i] + '\n');
+ }
+ },
+ function () {alert('Error getting names\n');},
+ {type:'wide', item:'months'}
+ );
+
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateNames() {
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i=0; i<names.value.length; i++) {
+ alert('month: ' + names.value[i] + '\n');
+ }
+ },
+ function () {alert('Error getting names\n');},
+ {type:'wide', item:'months'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDateNames()">Click for date names</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getDatePattern.md b/docs/en/2.3.0/cordova/globalization/globalization.getDatePattern.md
new file mode 100644
index 0000000..87c0bc8
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getDatePattern.md
@@ -0,0 +1,98 @@
+---
+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.
+---
+
+globalization.getDatePattern
+===========
+
+Returns a pattern string for formatting and parsing dates according to the client's user preferences.
+
+ navigator.globalization.getDatePattern(successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+
+- pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
+- timezone {String}: The abbreviated name of the time zone on the client
+- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.
+- dst\_offset {Number}: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone.
+
+If there is an error obtaining the pattern, then the errorCB callback is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+
+`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
+`options.selector` can be 'date', 'time' or 'date and time'.
+
+The default options are `{formatLength:'short', selector:'date and time'}`.
+The options parameter is optional.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
+
+ function checkDatePattern() {
+ navigator.globalization.getDatePattern(
+ function (date) {alert('pattern: ' + date.pattern + '\n');},
+ function () {alert('Error getting pattern\n');},
+ {formatLength:'short', selector:'date and time'}
+ );
+ }
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDatePattern() {
+ navigator.globalization.getDatePattern(
+ function (date) {alert('pattern: ' + date.pattern + '\n');},
+ function () {alert('Error getting pattern\n');},
+ {formatLength:'short', selector:'date and time'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDatePattern()">Click for pattern</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+--------------
+
+- `formatLength` option supports only short and full values.
+- `pattern` property for `date and time` pattern returns only full datetime format.
+- `timezone` property returns full time zone name
+- `dst_offset` returned property is not supported and always returns zero.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/2.3.0/cordova/globalization/globalization.getFirstDayOfWeek.md
new file mode 100644
index 0000000..969a9f7
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -0,0 +1,76 @@
+---
+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.
+---
+
+globalization.getFirstDayOfWeek
+===========
+
+Returns the first day of the week according to the client's user preferences and calendar.
+
+ navigator.globalization.getFirstDayOfWeek(successCB, errorCB);
+
+Description
+-----------
+
+The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+
+If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1".
+
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkFirstDay() {
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkFirstDay()">Click for first day of week</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getLocaleName.md b/docs/en/2.3.0/cordova/globalization/globalization.getLocaleName.md
new file mode 100644
index 0000000..3402c21
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getLocaleName.md
@@ -0,0 +1,81 @@
+---
+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.
+---
+
+globalization.getLocaleName
+===========
+
+Get the string identifier for the client's current locale setting.
+
+ navigator.globalization.getLocaleName(successCB, errorCB);
+
+
+Description
+-----------
+
+It returns the locale identifier string to the successCB callback with a
+properties object as a parameter. That object should have a ``value`` property with a String value.
+
+If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US".
+
+ navigator.globalization.getLocaleName(
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLocale() {
+ navigator.globalization.getLocaleName(
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkLocale()">Click for locale</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+---------------------
+- Returns the two-letter code defined in ISO 3166 for the current country/region.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getNumberPattern.md b/docs/en/2.3.0/cordova/globalization/globalization.getNumberPattern.md
new file mode 100644
index 0000000..2f63aa7
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getNumberPattern.md
@@ -0,0 +1,121 @@
+---
+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.
+---
+
+globalization.getNumberPattern
+===========
+
+Returns a pattern string for formatting and parsing numbers according to the client's user preferences.
+
+ navigator.globalization.getNumberPattern(successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+
+- pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
+- symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol.
+- fraction {Number}: The number of fractional digits to use when parsing and formatting numbers.
+- rounding {Number}: The rounding increment to use when parsing and formatting.
+- positive {String}: The symbol to use for positive numbers when parsing and formatting.
+- negative: {String}: The symbol to use for negative numbers when parsing and formatting.
+- decimal: {String}: The decimal symbol to use for parsing and formatting.
+- grouping: {String}: The grouping symbol to use for parsing and formatting.
+
+If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
+
+`options.type` can be 'decimal', 'percent', or 'currency'.
+The default options are `{type:'decimal'}`. The `options` parameter is optional.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to:
+
+ pattern: #,##0.###
+ symbol: .
+ fraction: 0
+ rounding: 0
+ positive:
+ negative: -
+ decimal: .
+ grouping: ,
+
+.
+
+ navigator.globalization.getNumberPattern(
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'positive: ' + pattern.positive + '\n' +
+ 'negative: ' + pattern.negative + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');},
+ {type:'decimal'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.globalization.getNumberPattern(
+ function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
+ 'symbol: ' + pattern.symbol + '\n' +
+ 'fraction: ' + pattern.fraction + '\n' +
+ 'rounding: ' + pattern.rounding + '\n' +
+ 'positive: ' + pattern.positive + '\n' +
+ 'negative: ' + pattern.negative + '\n' +
+ 'decimal: ' + pattern.decimal + '\n' +
+ 'grouping: ' + pattern.grouping);},
+ function () {alert('Error getting pattern\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkPattern()">Click for pattern</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+----------------
+- `pattern` property is not supported; empty string is always returned.
+- `fraction` property is not supported; zero is always returned.
+
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/2.3.0/cordova/globalization/globalization.getPreferredLanguage.md
new file mode 100644
index 0000000..46e7a1e
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.getPreferredLanguage.md
@@ -0,0 +1,81 @@
+---
+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.
+---
+
+globalization.getPreferredLanguage
+===========
+
+Get the string identifier for the client's current language.
+
+ navigator.globalization.getPreferredLanguage(successCB, errorCB);
+
+
+Description
+-----------
+
+It returns the language identifier string to the successCB callback with a
+properties object as a parameter. That object should have a ``value`` property with a String value.
+
+If there is an error getting the language, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with the text "language: English".
+
+ navigator.globalization.getPreferredLanguage(
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLanguage() {
+ navigator.globalization.getPreferredLanguage(
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
+ );
+ }
+ </script>
+ </head>
+ <body>
+ <button onclick="checkLanguage()">Click for language</button>
+ </body>
+ </html>
+
+
+Windows Phone 8 Quirks
+-------
+- Returns the ISO 639-1 two-letter code for the current language.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/2.3.0/cordova/globalization/globalization.isDayLightSavingsTime.md
new file mode 100644
index 0000000..862b634
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -0,0 +1,79 @@
+---
+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.
+---
+
+globalization.isDayLightSavingsTime
+===========
+
+Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.
+
+ navigator.globalization.isDayLightSavingsTime(date, successCB, errorCB);
+
+Description
+-----------
+
+It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a ``dst`` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+
+The inbound parameter `date` should be of type `Date`.
+
+If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true".
+
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDayLightSavings() {
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkDayLightSavings()">Click for daylight savings</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.md b/docs/en/2.3.0/cordova/globalization/globalization.md
new file mode 100644
index 0000000..15e787e
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.md
@@ -0,0 +1,61 @@
+---
+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.
+---
+
+Globalization
+======
+
+The `globalization` object obtains information and performs operations specific to the user's locale and timezone.
+
+Objects
+-------
+
+- GlobalizationError
+
+Methods
+-------
+
+- globalization.getPreferredLanguage
+- globalization.getLocaleName
+- globalization.dateToString
+- globalization.stringToDate
+- globalization.getDatePattern
+- globalization.getDateNames
+- globalization.isDayLightSavingsTime
+- globalization.getFirstDayOfWeek
+- globalization.numberToString
+- globalization.stringToNumber
+- globalization.getNumberPattern
+- globalization.getCurrencyPattern
+
+Variable Scope
+--------------
+
+The `globalization` object is a child of the `navigator` object, and therefore has global scope.
+
+ // The global globalization object
+ var globalization = navigator.globalization;
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="Globalization" value="org.apache.cordova.Globalization" />
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.numberToString.md b/docs/en/2.3.0/cordova/globalization/globalization.numberToString.md
new file mode 100644
index 0000000..287a9e5
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.numberToString.md
@@ -0,0 +1,81 @@
+---
+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.
+---
+
+globalization.numberToString
+===========
+
+Returns a number formatted as a string according to the client's user preferences.
+
+ navigator.globalization.numberToString(number, successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+
+If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+
+`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142"
+
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkNumber()">Click for number</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.stringToDate.md b/docs/en/2.3.0/cordova/globalization/globalization.stringToDate.md
new file mode 100644
index 0000000..276484b
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.stringToDate.md
@@ -0,0 +1,107 @@
+---
+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.
+---
+
+globalization.stringToDate
+===========
+
+Parses a date formatted as a string according to the client's user
+preferences and calendar using the time zone of the client and returns
+the corresponding date object.
+
+ navigator.globalization.stringToDate(dateString, successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:
+
+- year {Number}: The four digit year
+- month {Number}: The month from (0 - 11)
+- day {Number}: The day from (1 - 31)
+- hour {Number}: The hour from (0 - 23)
+- minute {Number}: The minute from (0 - 59)
+- second {Number}: The second from (0 - 59)
+- millisecond {Number}: The milliseconds (from 0 - 999), not available on all platforms
+
+The inbound `dateString` parameter should be of type `String`.
+
+`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
+`options.selector` can be 'date', 'time' or 'date and time'.
+
+The default options are `{formatLength:'short', selector:'date and time'}`.
+The options parameter is optional.
+
+If there is an error parsing the date string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.
+
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector:'date'}
+ );
+
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkStringDate() {
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector:'date'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkStringDate()">Click for parsed date</button>
+ </body>
+ </html>
+
+Windows Phone 8 Quirks
+------------------
+
+- `formatLength` option supports only short and full values
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/globalization/globalization.stringToNumber.md b/docs/en/2.3.0/cordova/globalization/globalization.stringToNumber.md
new file mode 100644
index 0000000..006aefa
--- /dev/null
+++ b/docs/en/2.3.0/cordova/globalization/globalization.stringToNumber.md
@@ -0,0 +1,84 @@
+---
+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.
+---
+
+globalization.stringToNumber
+===========
+
+Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.
+
+ navigator.globalization.stringToNumber(string, successCB, errorCB, options);
+
+Description
+-----------
+
+It returns the number to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+
+If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
+
+`options.type` can be 'decimal', 'percent', or 'currency'.
+The default options are `{type:'decimal'}`. The `options` parameter is optional.
+
+
+Supported Platforms
+-------------------
+
+- Android
+- BlackBerry WebWorks (OS 5.0 and higher)
+- iPhone
+- Windows Phone 8
+
+Quick Example
+-------------
+
+In the case when the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56".
+
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+
+
+Full Example
+------------
+
+ <!DOCTYPE HTML>
+ <html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkNumber()">Click for parsed number</button>
+ </body>
+ </html>
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/af24b6ce/docs/en/2.3.0/cordova/inappbrowser/inappbrowser.md
----------------------------------------------------------------------
diff --git a/docs/en/2.3.0/cordova/inappbrowser/inappbrowser.md b/docs/en/2.3.0/cordova/inappbrowser/inappbrowser.md
new file mode 100644
index 0000000..a66beef
--- /dev/null
+++ b/docs/en/2.3.0/cordova/inappbrowser/inappbrowser.md
@@ -0,0 +1,254 @@
+---
+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.
+---
+
+InAppBrowser
+============
+
+> The InAppBrowser is a web-browser that is shown in your app when you use the `window.open` call.
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+
+Description
+-----------
+
+The object returned from a call to `window.open`.
+
+Methods
+----------
+
+- addEventListener
+- removeEventListener
+- close
+
+Permissions
+-----------
+
+### Android
+
+#### app/res/xml/config.xml
+
+ <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" />
+
+### iOS
+
+#### config.xml
+
+ <plugin name="InAppBrowser" value="CDVInAppBrowser" />
+
+
+addEventListener
+================
+
+> Adds a listener for an event from the InAppBrowser.
+
+ ref.addEventListener(eventname, callback);
+
+- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
+- __eventname:__ the event to listen for (`String`)
+
+ loadstart - event fired when the InAppBrowser starts to load a URL
+ loadstop - event fired when the InAppBrowser finished loading a URL
+ exit - event fired when the InAppBrowser window is closed
+
+- __callback:__ the function that is called when the event is fired.
+The function is passed an `InAppBrowserEvent` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstart', function() { alert(event.url); });
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.addEventListener Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.addEventListener('loadstart', function() { alert('start: ' + event.url); });
+ ref.addEventListener('loadstop', function() { alert('stop: ' + event.url); });
+ ref.addEventListener('exit', function() { alert(event.type); });
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+removeEventListener
+===================
+
+> Removes a listener for an event from the InAppBrowser.
+
+ ref.removeEventListener(eventname, callback);
+
+- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
+- __eventname:__ the event to stop listening for (`String`)
+
+ loadstart - event fired when the InAppBrowser starts to load a URL
+ loadstop - event fired when the InAppBrowser finished loading a URL
+ exit - event fired when the InAppBrowser window is closed
+
+- __callback:__ the function that was to be called when the event is fired.
+The function is passed an `InAppBrowserEvent` object.
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ var myCallback = function() { alert(event.url); }
+ ref.addEventListener('loadstart', myCallback);
+ ref.removeEventListener('loadstart', myCallback);
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.removeEventListener Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Global InAppBrowser reference
+ var iabRef = null;
+
+ function iabLoadStart(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabLoadStop(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabClose(event) {
+ alert(event.type);
+ iabRef.removeEventListener('loadstart', iabLoadStart);
+ iabRef.removeEventListener('loadstop', iabLoadStop);
+ iabRef.removeEventListener('exit', iabClose);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ iabRef = window.open('http://apache.org', '_blank', 'location=yes');
+ iabRef.addEventListener('loadstart', iabLoadStart);
+ iabRef.addEventListener('loadstop', iabLoadStop);
+ iabRef.addEventListener('exit', iabClose);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+close
+=====
+
+> Closes the InAppBrowser window.
+
+ ref.close();
+
+- __ref:__ reference to the InAppBrowser window (`InAppBrowser`)
+
+Supported Platforms
+-------------------
+
+- Android
+- iOS
+
+Quick Example
+-------------
+
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ ref.close();
+
+Full Example
+------------
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <title>InAppBrowser.close Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.addEventListener("deviceready", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var ref = window.open('http://apache.org', '_blank', 'location=yes');
+ // close InAppBrowser after 5 seconds
+ setTimeout(function() {
+ ref.close();
+ }, 5000);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+ </html>
+
+InAppBrowserEvent
+=================
+
+The object that is passed to the callback function from an addEventListener call on an InAppBrowser object.
+
+Properties
+----------
+
+- __type:__ the eventname (`String`) - one of loadstart, loadstop, or exit
+- __url:__ the URL that was loaded (`String`)