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 2012/07/13 00:09:52 UTC
[15/64] [partial] Remove all files.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
deleted file mode 100644
index 741b8ac..0000000
--- a/README.md
+++ /dev/null
@@ -1,142 +0,0 @@
-Apache Cordova API Documentation
-================================
-
-The JavaScript API documentation for [Apache Cordova](http://cordova.io/).
-
-The documentation is available at [docs.cordova.io](http://docs.cordova.io/).
-
-Documentation Format
---------------------
-
-All of the [Apache Cordova](http://cordova.io/) documentation is written with [markdown](http://daringfireball.net/projects/markdown/syntax), a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document Cordova's core API and platform-specific APIs.
-
-File Structure
---------------
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/cordova/PluginName/
- docs/LANGUAGE/VERSION/cordova/PluginName/className.md
- docs/LANGUAGE/VERSION/cordova/PluginName/className.functionName.md
-
-Contributing to the Documentation
----------------------------------
-
-### Report or Fix an Issue
-
-We use [Apache JIRA](https://issues.apache.org/jira/browse/CB)
-
-By the way, you rock! Thanks for helping us improve the documentation!
-
-### Using Git
-
-Are you new to Git or contributing on GitHub?
-
-We have [written a few Git tutorials](http://wiki.apache.org/cordova/ContributerWorkflow)
-to help you get started with contributing to the documentation.
-
-### Sending Pull Requests
-
-Pull requests are welcome!
-
-We appreciate the use of topic branches.
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-### Adding a Language
-
-Do you want the Apache Cordova documentation in another language? We do too!
-
-__1. Create the language directory__
-
- # Spanish
- mkdir docs/es
-
-__2. Add a version__
-
-Start with the latest stable release. You can always add other versions later.
-
- mkdir docs/es/1.0.0
-
-__3. Begin Translating__
-
-Currently, English is the most up-to-date and so it is easiest to copy each English
-file into the new language directory.
-
-__4. config.json__
-
-For each version, there is a `config.json` that defines the name of the language and
-how to merge the files.
-
-__5. Customizing HTML template__
-
-Each language can override the default template in `template/docs/LANGUAGE`.
-
-Generating the Documentation
-----------------------------
-
-Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are used to generate the HTML documentation.
-
-### Install joDoc ###
-
-- Clone [joDoc](http://github.com/davebalmer/jodoc)
-
- git clone http://github.com/davebalmer/joDoc.git
-
-- Add joDoc/ to your path
-
- Open `~/.bashrc` or `~/.profile` (or whatever you use)
-
- export PATH=$PATH:~/path/to/joDoc/
-
-- Install markdown
-
- # Use your package manager
- brew install markdown
- port install markdown
- aptitude install markdown
-
-- Install nokogiri (Ruby HTML parser)
-
- gem install nokogiri
-
-- Install json (Ruby JSON parser)
-
- gem install json
-
-### Run the Script ###
-
- ./bin/generate
-
-Script Test Suite
------------------
-
-__Install rspec:__
-
- gem install rspec --version 1.3.0
-
-__Run all specs:__
-
- rake
-
-__Run a specific spec:__
-
- spec spec/phonegap/add_title_spec.rb
-
-Generated a Version Release
----------------------------
-
-There is a Rake task to increment the version, generate the version directory, and update the edge documentation.
-
- # generate version 1.7.0
- rake version[1.7.0]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/Rakefile
----------------------------------------------------------------------
diff --git a/Rakefile b/Rakefile
deleted file mode 100644
index 20ba1bb..0000000
--- a/Rakefile
+++ /dev/null
@@ -1,70 +0,0 @@
-# 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.
-
-require 'rubygems'
-require 'rake'
-require 'spec/rake/spectask'
-require 'fileutils'
-
-task :default => :spec
-
-desc "Run specs"
-Spec::Rake::SpecTask.new('spec') do |t|
- t.spec_opts = %w(-fs --color)
- t.warning = true
- t.spec_files = FileList['spec/**/*.rb']
-end
-task :spec
-
-desc "Increment the version - generates a release and updates the edge documentation"
-task :version, :nextVersion do |t, args|
- # get current and next version
- nextVersion = args[:nextVersion].strip
- prevVersion = File.read('VERSION').sub(/rc\d+$/, '').strip # remove release candidate
-
- # update edge documentation to reference next version
- _nextVersion = nextVersion.sub(/rc\d+$/, '') # cordova file references do not include the RC
- unless prevVersion == _nextVersion
- files = Dir.glob(File.join('docs', 'en', 'edge', '**', '*'))
-
- files.sort.each do |file|
- next if File.directory?(file) or file !~ /md|html/
- content = File.read(file)
- content.gsub!(prevVersion, _nextVersion)
- File.open(file, 'w') { |f| f.write(content) }
- end
- end
-
- # generate a release
- edge_dir = File.join('docs', 'en', 'edge')
- release_dir = File.join('docs', 'en', nextVersion)
- FileUtils.cp_r(edge_dir, release_dir)
-
- # update VERSION file
- File.open('VERSION', 'w') do |f|
- f.write(nextVersion)
- end
-
- # echo results
- puts "Generated version #{nextVersion}"
- puts ""
- puts "Next steps:"
- puts " 1. Review the update using `git status`"
- puts " 2. Commit the changes as 'Version #{nextVersion}'"
- puts " 3. Tag the commit as '#{nextVersion}'"
- puts ""
-end
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/VERSION
----------------------------------------------------------------------
diff --git a/VERSION b/VERSION
deleted file mode 100644
index abb1658..0000000
--- a/VERSION
+++ /dev/null
@@ -1 +0,0 @@
-1.9.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/bin/generate
----------------------------------------------------------------------
diff --git a/bin/generate b/bin/generate
deleted file mode 100755
index 3269a7b..0000000
--- a/bin/generate
+++ /dev/null
@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-#
-# 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.
-#
-
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-require 'docs_generator'
-
-generator = DocsGenerator.new
-generator.run
-
-puts " => #{generator.output_directory}"
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/config.json
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/config.json b/docs/en/0.9.2/config.json
deleted file mode 100644
index bbed441..0000000
--- a/docs/en/0.9.2/config.json
+++ /dev/null
@@ -1,78 +0,0 @@
-{
- "language": "English",
- "merge": {
- "accelerometer.md": [
- "phonegap/accelerometer/accelerometer.md",
- "phonegap/accelerometer/accelerometer.getCurrentAcceleration.md",
- "phonegap/accelerometer/accelerometer.watchAcceleration.md",
- "phonegap/accelerometer/accelerometer.clearWatch.md",
- "phonegap/accelerometer/acceleration/acceleration.md",
- "phonegap/accelerometer/parameters/accelerometerSuccess.md",
- "phonegap/accelerometer/parameters/accelerometerError.md",
- "phonegap/accelerometer/parameters/accelerometerOptions.md"
- ],
- "camera.md": [
- "phonegap/camera/camera.md",
- "phonegap/camera/camera.getPicture.md",
- "phonegap/camera/parameter/cameraSuccess.md",
- "phonegap/camera/parameter/cameraError.md",
- "phonegap/camera/parameter/cameraOptions.md"
- ],
- "contacts.md": [
- "phonegap/contacts/contacts.md",
- "phonegap/contacts/contacts.create.md",
- "phonegap/contacts/contacts.find.md",
- "phonegap/contacts/Contact/contact.md",
- "phonegap/contacts/ContactAccount/contactaccount.md",
- "phonegap/contacts/ContactAddress/contactaddress.md",
- "phonegap/contacts/ContactField/contactfield.md",
- "phonegap/contacts/ContactFindOptions/contactfindoptions.md",
- "phonegap/contacts/ContactName/contactname.md",
- "phonegap/contacts/ContactOrganization/contactorganization.md",
- "phonegap/contacts/ContactError/contactError.md",
- "phonegap/contacts/parameters/contactSuccess.md",
- "phonegap/contacts/parameters/contactError.md",
- "phonegap/contacts/parameters/contactFields.md",
- "phonegap/contacts/parameters/contactFindOptions.md"
- ],
- "device.md": [
- "phonegap/device/device.md",
- "phonegap/device/device.name.md",
- "phonegap/device/device.phonegap.md",
- "phonegap/device/device.platform.md",
- "phonegap/device/device.uuid.md",
- "phonegap/device/device.version.md"
- ],
- "events.md": [
- "phonegap/events/events.md",
- "phonegap/events/events.deviceready.md"
- ],
- "geolocation.md": [
- "phonegap/geolocation/geolocation.md",
- "phonegap/geolocation/geolocation.getCurrentPosition.md",
- "phonegap/geolocation/geolocation.watchPosition.md",
- "phonegap/geolocation/geolocation.clearWatch.md",
- "phonegap/geolocation/Coordinates/coordinates.md",
- "phonegap/geolocation/Position/position.md",
- "phonegap/geolocation/PositionError/positionError.md",
- "phonegap/geolocation/parameters/geolocationSuccess.md",
- "phonegap/geolocation/parameters/geolocationError.md",
- "phonegap/geolocation/parameters/geolocation.options.md"
- ],
- "network.md": [
- "phonegap/network/network.md",
- "phonegap/network/network.isReachable.md",
- "phonegap/network/NetworkStatus/NetworkStatus.md",
- "phonegap/network/parameters/reachableCallback.md",
- "phonegap/network/parameters/reachableHostname.md",
- "phonegap/network/parameters/reachableOptions.md"
- ],
- "notification.md": [
- "phonegap/notification/notification.md",
- "phonegap/notification/notification.alert.md",
- "phonegap/notification/notification.confirm.md",
- "phonegap/notification/notification.beep.md",
- "phonegap/notification/notification.vibrate.md"
- ]
- }
-}
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/index.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/index.md b/docs/en/0.9.2/index.md
deleted file mode 100644
index 4e1a4b8..0000000
--- a/docs/en/0.9.2/index.md
+++ /dev/null
@@ -1,63 +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.
----
-
-<div id="home">
- <h1>API Reference</h1>
- <ul>
- <li>
- <h2>Accelerometer</h2>
- <span>Tap into the device's motion sensor.</span>
- </li>
- <li>
- <h2>Camera</h2>
- <span>Capture a photo using the device's camera.</span>
- </li>
- <li>
- <h2>Contacts</h2>
- <span>Work with the devices contact database.</span>
- </li>
- <li>
- <h2>Device</h2>
- <span>Gather device specific information.</span>
- </li>
- <li>
- <h2>Events</h2>
- <span>Hook into native events through JavaScript.</span>
- </li>
- <li>
- <h2>Geolocation</h2>
- <span>Make your application location aware.</span>
- </li>
- <li>
- <h2>Network</h2>
- <span>Quickly check the network state.</span>
- </li>
- <li>
- <h2>Notification</h2>
- <span>Visual, audible, and tactile device notifications.</span>
- </li>
- </ul>
- <h1>Guides</h1>
- <ul>
- <li>
- <h2><a href="_index.html">Keyword Index</a></h2>
- <span>Full index of the PhoneGap Documentation.</span>
- </li>
- </ul>
-</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/acceleration/acceleration.md b/docs/en/0.9.2/phonegap/accelerometer/acceleration/acceleration.md
deleted file mode 100644
index 05bb951..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/acceleration/acceleration.md
+++ /dev/null
@@ -1,106 +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.
----
-
-Acceleration
-============
-
-Contains `Accelerometer` data captured at a specific point in time.
-
-Properties
-----------
-
-- __x:__ Amount of motion on the x-axis. Range [0, 1] (`Number`)
-- __y:__ Amount of motion on the y-axis. Range [0, 1] (`Number`)
-- __z:__ Amount of motion on the z-axis. Range [0, 1] (`Number`)
-- __timestamp:__ Creation timestamp in milliseconds. (`DOMTimeStamp`)
-
-Description
------------
-
-This object is created and populated by PhoneGap, and returned by an `Accelerometer` method.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess() {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
- </body>
- </html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.clearWatch.md b/docs/en/0.9.2/phonegap/accelerometer/accelerometer.clearWatch.md
deleted file mode 100644
index ba21c16..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.clearWatch.md
+++ /dev/null
@@ -1,113 +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.
----
-
-accelerometer.clearWatch
-========================
-
-Stop watching the `Acceleration` referenced by the watch ID parameter.
-
- navigator.accelerometer.clearWatch(watchID);
-
-- __watchID__: The ID returned by `accelerometer.watchAcceleration`.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-
- // ... later on ...
-
- navigator.accelerometer.clearWatch(watchID);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchAcceleration`
- var watchID = null;
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the acceleration
- //
- function startWatch() {
-
- // Update acceleration every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
- }
-
- // Stop watching the acceleration
- //
- function stopWatch() {
- if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
- 'Timestamp: ' + acceleration.timestamp + '<br />';
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <div id="accelerometer">Waiting for accelerometer...</div>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/0.9.2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md
deleted file mode 100644
index 105c64a..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.getCurrentAcceleration.md
+++ /dev/null
@@ -1,109 +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.
----
-
-accelerometer.getCurrentAcceleration
-====================================
-
-Get the current acceleration along the x, y, and z axis.
-
- navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
-
-Description
------------
-
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
-
-The acceleration is returned using the `accelerometerSuccess` callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>getCurrentAcceleration</p>
- </body>
- </html>
-
-iPhone Quirks
--------------
-
-- iPhone doesn't have the concept of getting the current acceleration at any given point.
-- You must watch the acceleration and capture the data at given time intervals.
-- Thus, the `getCurrentAcceleration` function will give you the last value reported from a phoneGap `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.md b/docs/en/0.9.2/phonegap/accelerometer/accelerometer.md
deleted file mode 100644
index b84eeb9..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.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.
----
-
-Accelerometer
-=============
-
-> Captures device motion in the x, y, and z direction.
-
-Methods
--------
-
-- accelerometer.getCurrentAcceleration
-- accelerometer.watchAcceleration
-- accelerometer.clearWatch
-
-Arguments
----------
-
-- accelerometerSuccess
-- accelerometerError
-- accelerometerOptions
-
-Objects (Read-Only)
--------------------
-
-- Acceleration
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.watchAcceleration.md b/docs/en/0.9.2/phonegap/accelerometer/accelerometer.watchAcceleration.md
deleted file mode 100644
index 8547213..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/accelerometer.watchAcceleration.md
+++ /dev/null
@@ -1,138 +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.
----
-
-accelerometer.watchAcceleration
-===============================
-
-At a regular interval, get the acceleration along the x, y, and z axis.
-
- var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
- accelerometerError,
- [accelerometerOptions]);
-
-Description
------------
-
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
-
-The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
-
-The returned watch ID references references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-- iPhone
-
-
-Quick Example
--------------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
-
- function onError() {
- alert('onError!');
- };
-
- var options = { frequency: 3000 }; // Update every 3 seconds
-
- var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Acceleration Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchAcceleration`
- var watchID = null;
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the acceleration
- //
- function startWatch() {
-
- // Update acceleration every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
- }
-
- // Stop watching the acceleration
- //
- function stopWatch() {
- if (watchID) {
- navigator.accelerometer.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get a snapshot of the current acceleration
- //
- function onSuccess(acceleration) {
- var element = document.getElementById('accelerometer');
- element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
- 'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
- 'Timestamp: ' + acceleration.timestamp + '<br />';
- }
-
- // onError: Failed to get the acceleration
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <div id="accelerometer">Waiting for accelerometer...</div>
- </body>
- </html>
-
- iPhone Quirks
--------------
-
-- At the interval requested, PhoneGap will call the success callback function and pass the accelerometer results.
-- However, in requests to the device PhoneGap restricts the interval to minimum of every 40ms and a maximum of every 1000ms.
- - For example, if you request an interval of 3 seconds (3000ms), PhoneGap will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerError.md b/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerError.md
deleted file mode 100644
index c908c16..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerError.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.
----
-
-accelerometerError
-==================
-
-onError callback function for acceleration functions.
-
- function() {
- // Handle the error
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerOptions.md b/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerOptions.md
deleted file mode 100644
index 197f416..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerOptions.md
+++ /dev/null
@@ -1,28 +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.
----
-
-accelerometerOptions
-====================
-
-An optional parameter to customize the retrieval of the accelerometer.
-
-Options
--------
-
-- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerSuccess.md b/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerSuccess.md
deleted file mode 100644
index 277fca8..0000000
--- a/docs/en/0.9.2/phonegap/accelerometer/parameters/accelerometerSuccess.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.
----
-
-accelerometerSuccess
-====================
-
-onSuccess callback function that provides the Acceleration information.
-
- function(acceleration) {
- // Do something
- }
-
-Parameters
-----------
-
-- __acceleration:__ The acceleration at a single moment in time. (Acceleration)
-
-Example
--------
-
- function onSuccess(acceleration) {
- alert('Acceleration X: ' + acceleration.x + '\n' +
- 'Acceleration Y: ' + acceleration.y + '\n' +
- 'Acceleration Z: ' + acceleration.z + '\n' +
- 'Timestamp: ' + acceleration.timestamp + '\n');
- };
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/camera/camera.getPicture.md b/docs/en/0.9.2/phonegap/camera/camera.getPicture.md
deleted file mode 100644
index 898f40b..0000000
--- a/docs/en/0.9.2/phonegap/camera/camera.getPicture.md
+++ /dev/null
@@ -1,192 +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.
----
-
-camera.getPicture
-=================
-
-Takes a photo using the camera or retrieves a photo from the device's album. The image is returned as a base64 encoded `String` or as the URI of an image file.
-
- navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
-
-Description
------------
-
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
-
-If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected.
-
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
-
-- A `String` containing the Base64 encoded photo image (default).
-- A `String` representing the image file location on local storage.
-
-You can do whatever you want with the encoded image or URI, for example:
-
-- Render the image in an `<img>` tag _(see example below)_
-- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
-- Post the data to a remote server
-
-Note: The image quality of pictures taken using the camera on newer devices is quite good. _Encoding such images using Base64 has caused memory issues on some of these devices (iPhone 4, BlackBerry Torch 9800)._ Therefore, using FILE_URI as the 'Camera.destinationType' is highly recommended.
-
-Supported Platforms
--------------------
-
-- Android
-- Blackberry Widgets (OS 5.0 and higher)
-- iPhone
-
-Quick Example
--------------
-
-Take photo and retrieve Base64-encoded image:
-
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50 });
-
- function onSuccess(imageData) {
- var image = document.getElementById('myImage');
- image.src = "data:image/jpeg;base64," + imageData;
- }
-
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
-Take photo and retrieve image file location:
-
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
-
- function onSuccess(imageURI) {
- var image = document.getElementById('myImage');
- image.src = imageURI;
- }
-
- function onFail(message) {
- alert('Failed because: ' + message);
- }
-
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Capture Photo</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- var pictureSource; // picture source
- var destinationType; // sets the format of returned value
-
- // Wait for PhoneGap to connect with the device
- //
- function onLoad() {
- document.addEventListener("deviceready",onDeviceReady,false);
- }
-
- // PhoneGap is ready to be used!
- //
- function onDeviceReady() {
- pictureSource=navigator.camera.PictureSourceType;
- destinationType=navigator.camera.DestinationType;
- }
-
- // Called when a photo is successfully retrieved
- //
- function onPhotoDataSuccess(imageData) {
- // Uncomment to view the base64 encoded image data
- // console.log(imageData);
-
- // Get image handle
- //
- var smallImage = document.getElementById('smallImage');
-
- // Unhide image elements
- //
- smallImage.style.display = 'block';
-
- // Show the captured photo
- // The inline CSS rules are used to resize the image
- //
- smallImage.src = "data:image/jpeg;base64," + imageData;
- }
-
- // Called when a photo is successfully retrieved
- //
- function onPhotoURISuccess(imageURI) {
- // Uncomment to view the image file URI
- // console.log(imageURI);
-
- // Get image handle
- //
- var largeImage = document.getElementById('largeImage');
-
- // Unhide image elements
- //
- largeImage.style.display = 'block';
-
- // Show the captured photo
- // The inline CSS rules are used to resize the image
- //
- largeImage.src = imageURI;
- }
-
- // A button will call this function
- //
- function capturePhoto() {
- // Take picture using device camera and retrieve image as base64-encoded string
- navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 50 });
- }
-
- // A button will call this function
- //
- function capturePhotoEdit() {
- // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
- navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true });
- }
-
- // A button will call this function
- //
- function getPhoto(source) {
- // Retrieve image file location from specified source
- navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
- destinationType: destinationType.FILE_URI,
- sourceType: source });
- }
-
- // Called if something bad happens.
- //
- function onFail(mesage) {
- alert('Failed because: ' + message);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <button onclick="capturePhoto();">Capture Photo</button> <br>
- <button onclick="capturePhotoEdit();">Capture Editable Photo</button> <br>
- <button onclick="getPhoto(pictureSource.PHOTOLIBRARY);">From Photo Library</button><br>
- <button onclick="getPhoto(pictureSource.SAVEDPHOTOALBUM);">From Photo Album</button><br>
- <img style="display:none;width:60px;height:60px;" id="smallImage" src="" />
- <img style="display:none;" id="largeImage" src="" />
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/camera/camera.md b/docs/en/0.9.2/phonegap/camera/camera.md
deleted file mode 100644
index d23563b..0000000
--- a/docs/en/0.9.2/phonegap/camera/camera.md
+++ /dev/null
@@ -1,28 +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.
----
-
-Camera
-======
-
-> The `camera` object provides access to the device's default camera application.
-
-Methods
--------
-
-- camera.getPicture
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/camera/parameter/cameraError.md b/docs/en/0.9.2/phonegap/camera/parameter/cameraError.md
deleted file mode 100644
index 7ee091b..0000000
--- a/docs/en/0.9.2/phonegap/camera/parameter/cameraError.md
+++ /dev/null
@@ -1,32 +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.
----
-
-cameraError
-===========
-
-onError callback function that provides an error message.
-
- function(message) {
- // Show a helpful message
- }
-
-Parameters
-----------
-
-- __message:__ The message is provided by the device's native code. (`String`)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/camera/parameter/cameraOptions.md b/docs/en/0.9.2/phonegap/camera/parameter/cameraOptions.md
deleted file mode 100644
index ec2f47b..0000000
--- a/docs/en/0.9.2/phonegap/camera/parameter/cameraOptions.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.
----
-
-cameraOptions
-=============
-
-Optional parameters to customize the camera settings.
-
- { quality : 75,
- destinationType : Camera.DestinationType.DATA_URL,
- sourceType : Camera.PictureSourceType.CAMERA,
- allowEdit : true };
-
-Options
--------
-
-- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
-
-- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
-
- Camera.DestinationType = {
- DATA_URL : 0, // Return image as base64 encoded string
- FILE_URI : 1 // Return image file URI
- };
-
-- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
-
- Camera.PictureSourceType = {
- PHOTOLIBRARY : 0,
- CAMERA : 1,
- SAVEDPHOTOALBUM : 2
- };
-
-- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
-
-Android Quirks
---------------
-
-- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-
-BlackBerry Quirks
------------------
-
-- Ignores the `quality` parameter.
-- Ignores the `sourceType` parameter.
-- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
-- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-
-Palm Quirks
------------
-
-- Ignores the `quality` parameter.
-- Ignores the `sourceType` parameter.
-- Ignores the `allowEdit` parameter.
-
-iPhone Quirks
---------------
-
-- Set `quality` below 50 to avoid memory error on some devices.
-- When `destinationType.FILE_URI` is used, photos taken with the camera and edited photos are saved in the application's Documents/tmp directory.
-- The application's Documents/tmp directory is deleted when the application ends. Developers may also delete this directory using the navigator.fileMgr APIs if storage space is a concern.
-
- navigator.fileMgr.deleteDirectory("tmp", onSuccess, onFail);
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/camera/parameter/cameraSuccess.md b/docs/en/0.9.2/phonegap/camera/parameter/cameraSuccess.md
deleted file mode 100644
index 773fba4..0000000
--- a/docs/en/0.9.2/phonegap/camera/parameter/cameraSuccess.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.
----
-
-cameraSuccess
-=============
-
-onSuccess callback function that provides the image data.
-
- function(imageData) {
- // Do something with the image
- }
-
-Parameters
-----------
-
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
-
-Example
--------
-
- // Show image
- //
- function cameraCallback(imageData) {
- var image = document.getElementById('myImage');
- image.src = "data:image/jpeg;base64," + imageData;
- }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/contacts/Contact/contact.md b/docs/en/0.9.2/phonegap/contacts/Contact/contact.md
deleted file mode 100644
index 8343e68..0000000
--- a/docs/en/0.9.2/phonegap/contacts/Contact/contact.md
+++ /dev/null
@@ -1,233 +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.
----
-
-Contact
-=======
-
-Contains properties that describe a contact, such as a user's personal or business contact.
-
-Properties
-----------
-
-- __id:__ A globally unique identifier. _(DOMString)_
-- __displayname:__ The name of this Contact, suitable for display to end-users. _(DOMString)_
-- __name:__ An object containing all components of a persons name. _(ContactName)_
-- __nickname:__ A casual name to address the contact by. _(DOMString)_
-- __phoneNumbers:__ An array of all the contact's phone numbers. _(ContactField[])_
-- __emails:__ An array of all the contact's email addresses. _(ContactField[])_
-- __addresses:__ An array of all the contact's addresses. _(ContactAddresses[])_
-- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_
-- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_
-- __published:__ The date the contact was first added to the database. _(DOMString)_
-- __updated:__ The last date the contact was updated. _(DOMString)_
-- __birthday:__ The birthday of the contact. _(DOMString)_
-- __anniversary:__ The wedding anniversary of the contact. _(DOMString)_
-- __gender:__ The gender of the contact. _(DOMString)_
-- __note:__ A note about the contact. _(DOMString)_
-- __preferredUsername:__ The preferred username of the contact. _(DOMString)_
-- __photos:__ An array of all the contact's photos. _(ContactField[])_
-- __tags:__ An array of all the contacts user defined tags. _(ContactField[])_
-- __relationships:__ An array of all the contact's relationships. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
-- __accounts:__ An array of accounts associated to the contact. _(ContactAccount[])_
-- __utcOffset:__ The offset from UTC of the contacts time zone. _(DOMString)_
-- __connected:__ Only true if the contact and the user have a bi-directional relationship. _(DOMString)_
-
-Methods
--------
-
-- __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`.
-- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful.
-- __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists.
-
-
-Details
--------
-
-The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method.
-
-_Note: Not all of the above contact fields are supported on every device platform. Please check each platform's Quirks section for information about which fields are supported._
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-
-Save Quick Example
-------------------
-
- // create a new contact object
- var contact = navigator.service.contacts.create();
- contact.displayName = "Plumber";
-
- // populate some fields
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save to device
- contact.save();
-
-Clone Quick Example
--------------------
-
- // clone the contact object
- var clone = contact.clone();
- clone.name.givenName = "John";
- console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
-
-Remove Quick Example
---------------------
-
- function onSuccess() {
- alert("Removal Success");
- };
-
- function onError(contactError) {
- alert("Error = " + contactError.code);
- };
-
- // remove the contact from the device
- contact.remove(onSuccess,onError);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // create
- var contact = navigator.service.contacts.create();
- contact.displayName = "Plumber";
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save
- contact.save();
-
- // clone
- var clone = contact.clone();
- clone.name.givenName = "John";
- console.log("Original contact name = " + contact.name.givenName);
- console.log("Cloned contact name = " + clone.name.givenName);
-
- // remove
- contact.remove(onRemoveSuccess,onRemoveError);
- }
-
- // onRemoveSuccess: Get a snapshot of the current contacts
- //
- function onRemoveSuccess(contacts) {
- alert("Removal Success");
- }
-
- // onRemoveError: Failed to get the contacts
- //
- function onRemoveError(contactError) {
- alert("Error = " + contactError.code);
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android 2.X Quirks
-------------------
-
-- __save__ function not yet supported.
-- __published:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __updated:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __gender:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __preferredUsername:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __photos:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __tags:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __accounts:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __utcOffset:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-- __connected:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-
-Android 1.X Quirks
-------------------
-
-- __save__ function not yet supported.
-- __name:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __nickname:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __published:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __updated:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __birthday:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __anniversary:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __gender:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __preferredUsername:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __photos:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __tags:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __relationships:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __urls:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __accounts:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __utcOffset:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-- __connected:__ This property is not support by Android 1.X devices, and will always be returned as `null`.
-
-BlackBerry Widgets (OS 5.0 and higher) Quirks
----------------------------------------------
-
-- __id:__ Supported. Assigned by device when contact is saved.
-- __displayname:__ Supported. Stored in BlackBerry __title__ field.
-- __name:__ Supported.
-- __nickname:__ This property is not supported, and will always be returned as `null`.
-- __phoneNumbers:__ Partially supported. Phone numbers will be stored in BlackBerry fields __homePhone1__ and __homePhone2__ if _type_ is 'home', __workPhone1__ and __workPhone2__ if _type_ is 'work', __mobilePhone__ if _type_ is 'mobile', __faxPhone__ if _type_ is 'fax', __pagerPhone__ if _type_ is 'pager', and __otherPhone__ if _type_ is none of the above.
-- __emails:__ Partially supported. The first three email addresses will be stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
-- __addresses:__ Partially supported. The first and second addresses will be stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
-- __ims:__ This property is not supported, and will always be returned as `null`.
-- __organizations:__ Partially supported. The __name__ and __title__ of the first organization are stored in the BlackBerry __company__ and __title__ fields, respectively.
-- __published:__ This property is not supported, and will always be returned as `null`.
-- __updated:__ This property is not supported, and will always be returned as `null`.
-- __birthday:__ Supported.
-- __anniversary:__ Supported.
-- __gender:__ This property is not supported, and will always be returned as `null`.
-- __note:__ Supported.
-- __preferredUsername:__ This property is not supported, and will always be returned as `null`.
-- __photos:__ This property is not supported, and will always be returned as `null`.
-- __tags:__ This property is not supported, and will always be returned as `null`.
-- __relationships:__ This property is not supported, and will always be returned as `null`.
-- __urls:__ Partially supported. The first url is stored in BlackBerry __webpage__ field.
-- __accounts:__ This property is not supported, and will always be returned as `null`.
-- __utcOffset:__ This property is not supported, and will always be returned as `null`.
-- __connected:__ This property is not supported, and will always be returned as `null`.
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/contacts/ContactAccount/contactaccount.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/contacts/ContactAccount/contactaccount.md b/docs/en/0.9.2/phonegap/contacts/ContactAccount/contactaccount.md
deleted file mode 100644
index f570f2c..0000000
--- a/docs/en/0.9.2/phonegap/contacts/ContactAccount/contactaccount.md
+++ /dev/null
@@ -1,113 +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.
----
-
-ContactAccount
-==============
-
-Contains user account properties of a `Contact` object.
-
-Properties
-----------
-
-- __domain:__ The top-most authoritative domain for this account. _(DOMString)_
-- __username:__ An alphanumeric user name. _(DOMString)_
-- __userid:__ A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric. _(DOMString)_
-
-Details
--------
-
-The `ContactAccount` object stores user account properties of a contact. A `Contact` object stores one or more accounts in a `ContactAddress[]` array.
-
-Supported Platforms
--------------------
-
-- None
-
-Quick Example
--------------
-
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].accounts.length; j++) {
- console.log("User Name = " + contacts[i].accounts[j].username;
- }
- }
- };
-
- function onError() {
- alert('onError!');
- };
-
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","accounts"];
- navigator.service.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","accounts"];
- navigator.service.contacts.find(filter, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
- //
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].accounts.length; j++) {
- console.log("User Name = " + contacts[i].accounts[j].username;
- }
- }
- }
-
- // onError: Failed to get the contacts
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/contacts/ContactAddress/contactaddress.md b/docs/en/0.9.2/phonegap/contacts/ContactAddress/contactaddress.md
deleted file mode 100644
index cc4d3fe..0000000
--- a/docs/en/0.9.2/phonegap/contacts/ContactAddress/contactaddress.md
+++ /dev/null
@@ -1,150 +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.
----
-
-ContactAddress
-==============
-
-Contains address properties for a `Contact` object.
-
-Properties
-----------
-
-- __formatted:__ The full address formatted for display. _(DOMString)_
-- __streetAddress:__ The full street address. _(DOMString)_
-- __locality:__ The city or locality. _(DOMString)_
-- __region:__ The state or region. _(DOMString)_
-- __postalCode:__ The zip code or postal code. _(DOMString)_
-- __country:__ The country name. _(DOMString)_
-
-Details
--------
-
-The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-
-Quick Example
--------------
-
- // display the address information for all contacts
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].addresses.length; j++) {
- alert("Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
- };
-
- function onError() {
- alert('onError!');
- };
-
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
- navigator.service.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
- navigator.service.contacts.find(filter, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
- //
- function onSuccess(contacts) {
- // display the address information for all contacts
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].addresses.length; j++) {
- alert("Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android 1.X Quirks
-------------------
-
-- __streetAddress:__ This property is not support by Android 1.X devices, and will always return `null`.
-- __locality:__ This property is not support by Android 1.X devices, and will always return `null`.
-- __region:__ This property is not support by Android 1.X devices, and will always return `null`.
-- __postalCode:__ This property is not support by Android 1.X devices, and will always return `null`.
-- __country:__ This property is not support by Android 1.X devices, and will always return `null`.
-
-BlackBerry Widget (OS 5.0 and higher) Quirks
---------------------------------------------
-
-- __formatted:__ Partially supported. Will return concatenation of all BlackBerry address fields.
-- __streetAddress:__ Supported. Will return concatenation of BlackBerry __address1__ and __address2__ address fields.
-- __locality:__ Supported. Stored in BlackBerry __city__ address field.
-- __region:__ Supported. Stored in BlackBerry __stateProvince__ address field.
-- __postalCode:__ Supported. Stored in BlackBerry __zipPostal__ address field.
-- __country:__ Supported.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/contacts/ContactError/contactError.md b/docs/en/0.9.2/phonegap/contacts/ContactError/contactError.md
deleted file mode 100644
index 1f86df7..0000000
--- a/docs/en/0.9.2/phonegap/contacts/ContactError/contactError.md
+++ /dev/null
@@ -1,46 +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
-========
-
-A `ContactError` object is returned to the `contactError` callback when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-
-Constants
----------
-
-- `ContactError.UNKNOWN_ERROR`
-- `ContactError.INVALID_ARGUMENT_ERROR`
-- `ContactError.NOT_FOUND_ERROR`
-- `ContactError.TIMEOUT_ERROR`
-- `ContactError.PENDING_OPERATION_ERROR`
-- `ContactError.IO_ERROR`
-- `ContactError.NOT_SUPPORTED_ERROR`
-- `ContactError.PERMISSION_DENIED_ERROR`
-
-Description
------------
-
-The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs.
-
http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/061df3e9/docs/en/0.9.2/phonegap/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/0.9.2/phonegap/contacts/ContactField/contactfield.md b/docs/en/0.9.2/phonegap/contacts/ContactField/contactfield.md
deleted file mode 100644
index 8c5aa0a..0000000
--- a/docs/en/0.9.2/phonegap/contacts/ContactField/contactfield.md
+++ /dev/null
@@ -1,138 +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.
----
-
-ContactField
-============
-
-Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls.
-
-Properties
-----------
-
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)_
-- __value:__ The value of the field (such as a phone number or email address). _(DOMString)_
-- __primary:__ Set to `true` if this `ContactField` contains the user's preferred value. _(boolean)_
-
-Details
--------
-
-The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a primary property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry Widgets (OS 5.0 and higher)
-
-Quick Example
--------------
-
- // create a new contact
- var contact = navigator.service.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555'-5432', true); // primary number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
-
-Full Example
-------------
-
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
- "http://www.w3.org/TR/html4/strict.dtd">
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="phonegap-0.9.2.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for PhoneGap to load
- //
- function onLoad() {
- document.addEventListener("deviceready", onDeviceReady, false);
- }
-
- // PhoneGap is ready
- //
- function onDeviceReady() {
- // create a new contact
- var contact = navigator.service.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555'-5432', true); // primary number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
-
- // search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","phoneNumbers"];
- navigator.service.contacts.find(filter, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
- //
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].phoneNumbers.length; j++) {
- alert("Type: " + contacts[i].phoneNumbers[j].type + "\n" +
- "Value: " + contacts[i].phoneNumbers[j].value + "\n" +
- "Primary: " + contacts[i].phoneNumbers[j].primary);
- }
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError() {
- alert('onError!');
- }
-
- </script>
- </head>
- <body onload="onLoad()">
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android Quirks
---------------
-
-- __primary:__ This property is not support by Android devices, and will always return `false`.
-
-BlackBerry Widget (OS 5.0 and higher) Quirks
---------------------------------------------
-
-- __type:__ Partially supported. Used for phone numbers.
-- __value:__ Supported.
-- __primary:__ This property is not supported, and will always return `false`.
-
-