You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/07/24 00:20:15 UTC
[11/75] [partial] docs commit: Moved docs to www/docs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/contacts.find.md b/docs/en/1.5.0/phonegap/contacts/contacts.find.md
deleted file mode 100644
index dfc0012..0000000
--- a/docs/en/1.5.0/phonegap/contacts/contacts.find.md
+++ /dev/null
@@ -1,115 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-contacts.find
-=============
-
-Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified.
-
- navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
-
-Description
------------
-
-contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter.
-
-Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `Contact` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields.
-
-The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned.
-
-Parameters
-----------
-
-- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required]
-- __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required]
-- __contactError:__ Error callback function. Invoked when error occurs. [Optional]
-- __contactFindOptions:__ Search options to filter contacts. [Optional]
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- function onSuccess(contacts) {
- alert('Found ' + contacts.length + ' contacts.');
- };
-
- function onError(contactError) {
- alert('onError!');
- };
-
- // find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter="Bob";
- var fields = ["displayName", "name"];
- navigator.contacts.find(fields, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter="Bob";
- var fields = ["displayName", "name"];
- navigator.contacts.find(fields, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
- //
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName);
- }
- }
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/contacts.md b/docs/en/1.5.0/phonegap/contacts/contacts.md
deleted file mode 100644
index 90b49b5..0000000
--- a/docs/en/1.5.0/phonegap/contacts/contacts.md
+++ /dev/null
@@ -1,48 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Contacts
-========
-
-> The `contacts` object provides access to the device contacts database.
-
-Methods
--------
-
-- contacts.create
-- contacts.find
-
-Arguments
----------
-
-- contactFields
-- contactSuccess
-- contactError
-- contactFindOptions
-
-Objects
--------
-
-- Contact
-- ContactName
-- ContactField
-- ContactAddress
-- ContactOrganization
-- ContactFindOptions
-- ContactError
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/parameters/contactError.md b/docs/en/1.5.0/phonegap/contacts/parameters/contactError.md
deleted file mode 100644
index 6b50ddc..0000000
--- a/docs/en/1.5.0/phonegap/contacts/parameters/contactError.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-contactError
-============
-
-Error callback function for contact functions.
-
- function(error) {
- // Handle the error
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md b/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
deleted file mode 100644
index 66c9d3d..0000000
--- a/docs/en/1.5.0/phonegap/contacts/parameters/contactFields.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-contactFields
-=============
-
-Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation.
-
- ["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md b/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
deleted file mode 100644
index 2eb9afc..0000000
--- a/docs/en/1.5.0/phonegap/contacts/parameters/contactFindOptions.md
+++ /dev/null
@@ -1,35 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-contactFindOptions
-==================
-
-Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database.
-
- {
- filter: "",
- multiple: true,
- };
-
-Options
--------
-
-- __filter:__ The search string used to filter contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md b/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
deleted file mode 100644
index 9068218..0000000
--- a/docs/en/1.5.0/phonegap/contacts/parameters/contactSuccess.md
+++ /dev/null
@@ -1,40 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-contactSuccess
-==============
-
-Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
-
- function(contacts) {
- // Do something
- }
-
-Parameters
-----------
-
-- __contacts:__ The contact array resulting from a find operation. (`Contact`)
-
-Example
--------
-
- function contactSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName;
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.md b/docs/en/1.5.0/phonegap/device/device.md
deleted file mode 100644
index aa1ae31..0000000
--- a/docs/en/1.5.0/phonegap/device/device.md
+++ /dev/null
@@ -1,42 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Device
-======
-
-> The `device` object describes the device's hardware and software.
-
-Properties
-----------
-
-- device.name
-- device.phonegap
-- device.platform
-- device.uuid
-- device.version
-
-Variable Scope
---------------
-
-Since `device` is assigned to the `window` object, it is implicitly in the global scope.
-
- // These reference the same `device`
- //
- var phoneName = window.device.name;
- var phoneName = device.name;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.name.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.name.md b/docs/en/1.5.0/phonegap/device/device.name.md
deleted file mode 100644
index c724ac9..0000000
--- a/docs/en/1.5.0/phonegap/device/device.name.md
+++ /dev/null
@@ -1,98 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-device.name
-===========
-
-Get the device's model name.
-
- var string = device.name;
-
-Description
------------
-
-`device.name` returns the name of the device's model or product. This value is set by the device manufacturer and may be different across versions of the same product.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- // Android: Nexus One returns "Passion" (Nexus One code name)
- // Motorola Droid returns "voles"
- // BlackBerry: Bold 8900 returns "8900"
- // iPhone: All devices returns a name set by iTunes e.g. "Joe's iPhone"
- //
- var name = device.name;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
-
-
-Android Quirks
---------------
-
-- Gets the [product name](http://developer.android.com/reference/android/os/Build.html#PRODUCT) instead of the [model name](http://developer.android.com/reference/android/os/Build.html#MODEL).
- - The product name is often the code name given during production.
- - e.g. Nexus One returns "Passion", Motorola Droid returns "voles"
-
-iPhone Quirks
--------------
-
-- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1).
- - The custom name is set by the owner in iTunes.
- - e.g. "Joe's iPhone"
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.phonegap.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.phonegap.md b/docs/en/1.5.0/phonegap/device/device.phonegap.md
deleted file mode 100644
index cb18867..0000000
--- a/docs/en/1.5.0/phonegap/device/device.phonegap.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-device.phonegap
-===============
-
-Get the version of phonegap running on the device.
-
- var string = device.phonegap;
-
-Description
------------
-
-`device.phonegap` returns the version of phonegap running on the device.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- var name = device.phonegap;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.platform.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.platform.md b/docs/en/1.5.0/phonegap/device/device.platform.md
deleted file mode 100644
index 3dc56e1..0000000
--- a/docs/en/1.5.0/phonegap/device/device.platform.md
+++ /dev/null
@@ -1,89 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-device.platform
-===============
-
-Get the device's operating system name.
-
- var string = device.platform;
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- // Depending on the device, a few examples are:
- // - "Android"
- // - "BlackBerry"
- // - "iPhone"
- // - "webOS"
- // - "WinCE"
- var devicePlatform = device.platform;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
-
-iPhone Quirks
--------------
-
-All devices return `iPhone` as the platform. This is inaccurate because Apple has rebranded the iPhone operating system as `iOS`.
-
-BlackBerry Quirks
------------------
-
-Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.uuid.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.uuid.md b/docs/en/1.5.0/phonegap/device/device.uuid.md
deleted file mode 100644
index 7a2ea57..0000000
--- a/docs/en/1.5.0/phonegap/device/device.uuid.md
+++ /dev/null
@@ -1,91 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-device.uuid
-===========
-
-Get the device's Universally Unique Identifier ([UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier)).
-
- var string = device.uuid;
-
-Description
------------
-
-The details of how a UUID is generated are determined by the device manufacturer and specific to the device's platform or model.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- // Android: Returns a random 64-bit integer (as a string, again!)
- // The integer is generated on the device's first boot
- //
- // BlackBerry: Returns the PIN number of the device
- // This is a nine-digit unique integer (as a string, though!)
- //
- // iPhone: (Paraphrased from the UIDevice Class documentation)
- // Returns a string of hash values created from multiple hardware identifies.
- // It is guaranteed to be unique for every device and cannot be tied
- // to the user account.
- // Windows Phone 7 : Returns a hash of device+current user,
- // if the user is not defined, a guid is generated and will persist until the app is uninstalled
- //
- var deviceID = device.uuid;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/device/device.version.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/device/device.version.md b/docs/en/1.5.0/phonegap/device/device.version.md
deleted file mode 100644
index 5fc00a1..0000000
--- a/docs/en/1.5.0/phonegap/device/device.version.md
+++ /dev/null
@@ -1,82 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-device.version
-==============
-
-Get the operating system version.
-
- var string = device.version;
-
-Supported Platforms
--------------------
-
-- Android 2.1+
-- BlackBerry
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iPhone
-- Windows Phone 7 ( Mango )
-
-Quick Example
--------------
-
- // Android: Froyo OS would return "2.2"
- // Eclair OS would return "2.1", "2.0.1", or "2.0"
- // Version can also return update level "2.1-update1"
- //
- // BlackBerry: Bold 9000 using OS 4.6 would return "4.6.0.282"
- //
- // iPhone: iOS 3.2 returns "3.2"
- //
- // Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720
- var deviceVersion = device.version;
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
-
- element.innerHTML = 'Device Name: ' + device.name + '<br />' +
- 'Device PhoneGap: ' + device.phonegap + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.backbutton.md b/docs/en/1.5.0/phonegap/events/events.backbutton.md
deleted file mode 100644
index 260032d..0000000
--- a/docs/en/1.5.0/phonegap/events/events.backbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-backbutton
-===========
-
-This is an event that fires when the user presses the back button.
-
- document.addEventListener("backbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("backbutton", onBackKeyDown, false);
-
- function onBackKeyDown() {
- // Handle the back button
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Back Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to call PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("backbutton", onBackKeyDown, false);
- }
-
- // Handle the back button
- //
- function onBackKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.batterycritical.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.batterycritical.md b/docs/en/1.5.0/phonegap/events/events.batterycritical.md
deleted file mode 100644
index a7494e6..0000000
--- a/docs/en/1.5.0/phonegap/events/events.batterycritical.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-batterycritical
-===========
-
-This is an event that fires when a PhoneGap application detects the battery has reached the critical level threshold.
-
- window.addEventListener("batterycritical", yourCallbackFunction, false);
-
-Details
--------
-
-This event that fires when a PhoneGap application detects the percentage of battery has reached the critical battery threshold. This value is device specific.
-
-The batterycritical handler will be called with an object that contains two properties:
-
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- window.addEventListener("batterycritical", onBatteryCritical, false);
-
- function onBatteryCritical(info) {
- // Handle the battery critical event
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- window.addEventListener("batterycritical", onBatteryCritical, false);
- }
-
- // Handle the batterycritical event
- //
- function onBatteryCritical(info) {
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.batterylow.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.batterylow.md b/docs/en/1.5.0/phonegap/events/events.batterylow.md
deleted file mode 100644
index 1413734..0000000
--- a/docs/en/1.5.0/phonegap/events/events.batterylow.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-batterylow
-===========
-
-This is an event that fires when a PhoneGap application detects the battery has reached the low level threshold.
-
- window.addEventListener("batterylow", yourCallbackFunction, false);
-
-Details
--------
-
-This event that fires when a PhoneGap application detects the percentage of battery has reached the low battery threshold. This value is device specific.
-
-The batterylow handler will be called with an object that contains two properties:
-
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- window.addEventListener("batterylow", onBatteryLow, false);
-
- function onBatteryLow(info) {
- // Handle the battery low event
- alert("Battery Level Low " + info.level + "%");
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- window.addEventListener("batterylow", onBatteryLow, false);
- }
-
- // Handle the batterylow event
- //
- function onBatteryLow(info) {
- alert("Battery Level Low " + info.level + "%");
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.batterystatus.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.batterystatus.md b/docs/en/1.5.0/phonegap/events/events.batterystatus.md
deleted file mode 100644
index 4ce8cf3..0000000
--- a/docs/en/1.5.0/phonegap/events/events.batterystatus.md
+++ /dev/null
@@ -1,93 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-batterystatus
-===========
-
-This is an event that fires when a PhoneGap application detects a change in the battery status.
-
- window.addEventListener("batterystatus", yourCallbackFunction, false);
-
-Details
--------
-
-This event that fires when a PhoneGap application detects the percentage of battery has changed by at least 1 percent. It is also fired if the device has been plugged in or un-plugged.
-
-The battery status handler will be called with an object that contains two properties:
-
-- __level:__ The percentage of battery (0-100). _(Number)_
-- __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_
-
-Typically, you will want to attach an event listener with `window.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- window.addEventListener("batterystatus", onBatteryStatus, false);
-
- function onBatteryStatus(info) {
- // Handle the online event
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- window.addEventListener("batterystatus", onBatteryStatus, false);
- }
-
- // Handle the batterystatus event
- //
- function onBatteryStatus(info) {
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.deviceready.md b/docs/en/1.5.0/phonegap/events/events.deviceready.md
deleted file mode 100644
index 1a83e7c..0000000
--- a/docs/en/1.5.0/phonegap/events/events.deviceready.md
+++ /dev/null
@@ -1,111 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-deviceready
-===========
-
-This is an event that fires when PhoneGap is fully loaded.
-
- document.addEventListener("deviceready", yourCallbackFunction, false);
-
-Details
--------
-
-This is a very important event that every PhoneGap application should use.
-
-PhoneGap consists of two code bases: native and JavaScript. While the native code is loading, a custom loading image is displayed. However, JavaScript is only loaded once the DOM loads. This means your web application could, potentially, call a PhoneGap JavaScript function before it is loaded.
-
-The PhoneGap `deviceready` event fires once PhoneGap has fully loaded. After the device has fired, you can safely make calls to PhoneGap function.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once the HTML document's DOM has loaded.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- document.addEventListener("deviceready", onDeviceReady, false);
-
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Device Ready Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
-
-BlackBerry (OS 4.6) Quirks
---------------------------
-
-Custom events are not supported in the RIM BrowserField (web browser view), so the `deviceready` event will never fire.
-
-A workaround is to manually query `PhoneGap.available` until PhoneGap has fully loaded.
-
- function onLoad() {
- // BlackBerry OS 4 browser does not support events.
- // So, manually wait until PhoneGap is available.
- //
- var intervalID = window.setInterval(
- function() {
- if (PhoneGap.available) {
- window.clearInterval(intervalID);
- onDeviceReady();
- }
- },
- 500
- );
- }
-
- function onDeviceReady() {
- // Now safe to use the PhoneGap API
- }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.endcallbutton.md b/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
deleted file mode 100644
index 40595b2..0000000
--- a/docs/en/1.5.0/phonegap/events/events.endcallbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-endcallbutton
-===========
-
-This is an event that fires when the user presses the end call button.
-
- document.addEventListener("endcallbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("endcallbutton", onEndCallKeyDown, false);
-
- function onEndCallKeyDown() {
- // Handle the end call button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap End Call Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("endcallbutton", onEndCallKeyDown, false);
- }
-
- // Handle the end call button
- //
- function onEndCallKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.md b/docs/en/1.5.0/phonegap/events/events.md
deleted file mode 100644
index 3621a48..0000000
--- a/docs/en/1.5.0/phonegap/events/events.md
+++ /dev/null
@@ -1,43 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-Events
-======
-
-> PhoneGap lifecycle events.
-
-Event Types
------------
-
-- deviceready
-- pause
-- resume
-- online
-- offline
-- backbutton
-- batterycritical
-- batterylow
-- batterystatus
-- menubutton
-- searchbutton
-- startcallbutton
-- endcallbutton
-- volumedownbutton
-- volumeupbutton
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.menubutton.md b/docs/en/1.5.0/phonegap/events/events.menubutton.md
deleted file mode 100644
index 9c515ae..0000000
--- a/docs/en/1.5.0/phonegap/events/events.menubutton.md
+++ /dev/null
@@ -1,87 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-menubutton
-===========
-
-This is an event that fires when the user presses the menu button.
-
- document.addEventListener("menubutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default menu button behaviour you can register an event listener for the 'menubutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("menubutton", onMenuKeyDown, false);
-
- function onMenuKeyDown() {
- // Handle the back button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap Menu Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("menubutton", onMenuKeyDown, false);
- }
-
- // Handle the menu button
- //
- function onMenuKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.offline.md b/docs/en/1.5.0/phonegap/events/events.offline.md
deleted file mode 100644
index 0a18f50..0000000
--- a/docs/en/1.5.0/phonegap/events/events.offline.md
+++ /dev/null
@@ -1,90 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-offline
-===========
-
-This is an event that fires when a PhoneGap application is offline (not connected to the Internet).
-
- document.addEventListener("offline", yourCallbackFunction, false);
-
-Details
--------
-
-When the application's network connection changes to being offline, the offline event is fired.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- document.addEventListener("offline", onOffline, false);
-
- function onOffline() {
- // Handle the offline event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Offline Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("offline", onOffline, false);
- }
-
- // Handle the offline event
- //
- function onOffline() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
-
-iOS Quirks
---------------------------
-During initial startup, the first offline event (if applicable) will take at least a second to fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.online.md b/docs/en/1.5.0/phonegap/events/events.online.md
deleted file mode 100644
index 90f3173..0000000
--- a/docs/en/1.5.0/phonegap/events/events.online.md
+++ /dev/null
@@ -1,90 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-online
-===========
-
-This is an event that fires when a PhoneGap application is online (connected to the Internet).
-
- document.addEventListener("online", yourCallbackFunction, false);
-
-Details
--------
-
-When the application's network connection changes to being online, the online event is fired.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- document.addEventListener("online", onOnline, false);
-
- function onOnline() {
- // Handle the online event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Online Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("online", onOnline, false);
- }
-
- // Handle the online event
- //
- function onOnline() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
-
-iOS Quirks
---------------------------
-During initial startup, the first online event (if applicable) will take at least a second to fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.pause.md b/docs/en/1.5.0/phonegap/events/events.pause.md
deleted file mode 100644
index 44b29fa..0000000
--- a/docs/en/1.5.0/phonegap/events/events.pause.md
+++ /dev/null
@@ -1,90 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-pause
-===========
-
-This is an event that fires when a PhoneGap application is put into the background.
-
- document.addEventListener("pause", yourCallbackFunction, false);
-
-Details
--------
-
-PhoneGap consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- document.addEventListener("pause", onPause, false);
-
- function onPause() {
- // Handle the pause event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Pause Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("pause", onPause, false);
- }
-
- // Handle the pause event
- //
- function onPause() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
-
-iOS Quirks
---------------------------
-In the pause handler, any calls that go through Objective-C will not work, nor will any calls that are interactive, like alerts. This means that you cannot call console.log (and its variants), or any calls from Plugins or the PhoneGap API. These will only be processed when the app resumes (processed on the next run-loop).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.resume.md b/docs/en/1.5.0/phonegap/events/events.resume.md
deleted file mode 100644
index ba9833c..0000000
--- a/docs/en/1.5.0/phonegap/events/events.resume.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-resume
-===========
-
-This is an event that fires when a PhoneGap application is retrieved from the background.
-
- document.addEventListener("resume", yourCallbackFunction, false);
-
-Details
--------
-
-PhoneGap consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-
-Quick Example
--------------
-
- document.addEventListener("resume", onResume, false);
-
- function onResume() {
- // Handle the resume event
- }
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>PhoneGap Resume Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- document.addEventListener("resume", onResume, false);
- }
-
- // Handle the resume event
- //
- function onResume() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.searchbutton.md b/docs/en/1.5.0/phonegap/events/events.searchbutton.md
deleted file mode 100644
index 7e968af..0000000
--- a/docs/en/1.5.0/phonegap/events/events.searchbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-searchbutton
-===========
-
-This is an event that fires when the user presses the search button on Android.
-
- document.addEventListener("searchbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- Android
-
-Quick Example
--------------
-
- document.addEventListener("searchbutton", onSearchKeyDown, false);
-
- function onSearchKeyDown() {
- // Handle the search button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap Search Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("searchbutton", onSearchKeyDown, false);
- }
-
- // Handle the search button
- //
- function onSearchKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.startcallbutton.md b/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
deleted file mode 100644
index 0a4d994..0000000
--- a/docs/en/1.5.0/phonegap/events/events.startcallbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-startcallbutton
-===========
-
-This is an event that fires when the user presses the start call button.
-
- document.addEventListener("startcallbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("startcallbutton", onStartCallKeyDown, false);
-
- function onStartCallKeyDown() {
- // Handle the start call button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap Start Call Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("startcallbutton", onStartCallKeyDown, false);
- }
-
- // Handle the start call button
- //
- function onStartCallKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md b/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
deleted file mode 100644
index 077320d..0000000
--- a/docs/en/1.5.0/phonegap/events/events.volumedownbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-volumedownbutton
-===========
-
-This is an event that fires when the user presses the volume down button.
-
- document.addEventListener("volumedownbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
-
- function onVolumeDownKeyDown() {
- // Handle the volume down button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap Volume Down Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
- }
-
- // Handle the volume down button
- //
- function onVolumeDownKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/17db5a3b/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md b/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
deleted file mode 100644
index b8fd124..0000000
--- a/docs/en/1.5.0/phonegap/events/events.volumeupbutton.md
+++ /dev/null
@@ -1,86 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-volumeupbutton
-===========
-
-This is an event that fires when the user presses the volume up button.
-
- document.addEventListener("volumeupbutton", yourCallbackFunction, false);
-
-Details
--------
-
-If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
-
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the PhoneGap 'deviceready' event.
-
-Supported Platforms
--------------------
-
-- BlackBerry WebWorks (OS 5.0 and higher)
-
-Quick Example
--------------
-
- document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
-
- function onVolumeUpKeyDown() {
- // Handle the volume up button
- }
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>PhoneGap Volume Up Button Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.5.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Call onDeviceReady when PhoneGap is loaded.
- //
- // At this point, the document has loaded but cordova-1.5.0.js has not.
- // When PhoneGap is loaded and talking with the native device,
- // it will call the event `deviceready`.
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is loaded and it is now safe to make calls PhoneGap methods
- //
- function onDeviceReady() {
- // Register the event listener
- document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
- }
-
- // Handle the volume up button
- //
- function onVolumeUpKeyDown() {
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- </body>
- </html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org