You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/09/04 05:11:08 UTC
[25/51] [partial] Delete rc versions of docs
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/camera/parameter/cameraOptions.md b/docs/en/1.9.0rc1/cordova/camera/parameter/cameraOptions.md
deleted file mode 100644
index 217d3e2..0000000
--- a/docs/en/1.9.0rc1/cordova/camera/parameter/cameraOptions.md
+++ /dev/null
@@ -1,125 +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,
- encodingType: Camera.EncodingType.JPEG,
- targetWidth: 100,
- targetHeight: 100,
- popoverOptions: CameraPopoverOptions };
-
-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`)
-
-- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
-
- Camera.EncodingType = {
- JPEG : 0, // Return JPEG encoded image
- PNG : 1 // Return PNG encoded image
- };
-
-- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
-- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
-
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
-
- Camera.MediaType = {
- PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
- VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
- ALLMEDIA : 2 // allow selection from all media types
-};
-
-- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
-- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions
-
-Android Quirks
---------------
-
-- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
-- Camera.EncodingType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-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).
-- Camera.MediaType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-webOS Quirks
------------
-
-- Ignores the `quality` parameter.
-- Ignores the `sourceType` parameter.
-- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-iOS Quirks
---------------
-
-- Set `quality` below 50 to avoid memory error on some devices.
-- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory.
-
-Windows Phone 7 Quirks
---------------
-
-- Ignores the `allowEdit` parameter.
-- Ignores the `correctOrientation` parameter.
-- Ignores the `saveToPhotoAlbum` parameter.
-
-Bada 1.2 Quirks
---------------
-- options not supported
-- always returns a FILE URI
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/camera/parameter/cameraSuccess.md b/docs/en/1.9.0rc1/cordova/camera/parameter/cameraSuccess.md
deleted file mode 100644
index 773fba4..0000000
--- a/docs/en/1.9.0rc1/cordova/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/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.clearWatch.md b/docs/en/1.9.0rc1/cordova/compass/compass.clearWatch.md
deleted file mode 100755
index 067a11d..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.clearWatch.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.
----
-
-compass.clearWatch
-========================
-
-Stop watching the compass referenced by the watch ID parameter.
-
- navigator.compass.clearWatch(watchID);
-
-- __watchID__: The ID returned by `compass.watchHeading`.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-
- // ... later on ...
-
- navigator.compass.clearWatch(watchID);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchHeading`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the compass
- //
- function startWatch() {
-
- // Update compass every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
- }
-
- // Stop watching the compass
- //
- function stopWatch() {
- if (watchID) {
- navigator.compass.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- }
-
-
- </script>
- </head>
- <body>
- <div id="heading">Waiting for heading...</div>
- <button onclick="startWatch();">Start Watching</button>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.clearWatchFilter.md b/docs/en/1.9.0rc1/cordova/compass/compass.clearWatchFilter.md
deleted file mode 100644
index 8c92c03..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.clearWatchFilter.md
+++ /dev/null
@@ -1,23 +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.
----
-
-compass.clearWatchFilter
-========================
-
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.getCurrentHeading.md b/docs/en/1.9.0rc1/cordova/compass/compass.getCurrentHeading.md
deleted file mode 100755
index aeb28fd..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.getCurrentHeading.md
+++ /dev/null
@@ -1,96 +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.
----
-
-compass.getCurrentHeading
-=========================
-
-Get the current compass heading.
-
- navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);
-
-Description
------------
-
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-
-The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-- Bada 1.2 & 2.x
-- webOS
-
-Quick Example
--------------
-
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- };
-
- function onError(error) {
- alert('CompassError: ' + error.code);
- };
-
- navigator.compass.getCurrentHeading(onSuccess, onError);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- navigator.compass.getCurrentHeading(onSuccess, onError);
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass Error: ' + compassError.code);
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>getCurrentHeading</p>
- </body>
- </html>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.md b/docs/en/1.9.0rc1/cordova/compass/compass.md
deleted file mode 100755
index 1fe6b9f..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.md
+++ /dev/null
@@ -1,81 +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.
----
-
-Compass
-=======
-
-> Obtains the direction that the device is pointing.
-
-Methods
--------
-
-- compass.getCurrentHeading
-- compass.watchHeading
-- compass.clearWatch
-- compass.watchHeadingFilter (obsolete)
-- compass.clearWatchFilter (obsolete)
-
-Arguments
----------
-
-- compassSuccess
-- compassError
-- compassOptions
-- compassHeading
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="Compass" value="org.apache.cordova.CompassListener" />
-
-### Bada
-
- No permissions are required.
-
-### BlackBerry WebWorks
-
- No permissions are required.
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>Compass</key>
- <string>CDVLocation</string>
- </dict>
-
-### webOS
-
- No permissions are required.
-
-### Windows Phone
-
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_SENSORS" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.watchHeading.md b/docs/en/1.9.0rc1/cordova/compass/compass.watchHeading.md
deleted file mode 100755
index da1af1b..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.watchHeading.md
+++ /dev/null
@@ -1,132 +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.
----
-
-compass.watchHeading
-====================
-
-At a regular interval, get the compass heading in degrees.
-
- var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
-
-Description
------------
-
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
-
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
-
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
-
-Supported Platforms
--------------------
-
-- Android
-- iPhone
-- Windows Phone 7 ( Mango ) if available in hardware
-- Bada 1.2 & 2.x
-- webOS
-
-
-Quick Example
--------------
-
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- };
-
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- };
-
- var options = { frequency: 3000 }; // Update every 3 seconds
-
- var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Compass Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchHeading`
- var watchID = null;
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- startWatch();
- }
-
- // Start watching the compass
- //
- function startWatch() {
-
- // Update compass every 3 seconds
- var options = { frequency: 3000 };
-
- watchID = navigator.compass.watchHeading(onSuccess, onError, options);
- }
-
- // Stop watching the compass
- //
- function stopWatch() {
- if (watchID) {
- navigator.compass.clearWatch(watchID);
- watchID = null;
- }
- }
-
- // onSuccess: Get the current heading
- //
- function onSuccess(heading) {
- var element = document.getElementById('heading');
- element.innerHTML = 'Heading: ' + heading.magneticHeading;
- }
-
- // onError: Failed to get the heading
- //
- function onError(compassError) {
- alert('Compass error: ' + compassError.code);
- }
-
- </script>
- </head>
- <body>
- <div id="heading">Waiting for heading...</div>
- <button onclick="startWatch();">Start Watching</button>
- <button onclick="stopWatch();">Stop Watching</button>
- </body>
- </html>
-
-iOS Quirks
---------------
-
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
-
-In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compass.watchHeadingFilter.md b/docs/en/1.9.0rc1/cordova/compass/compass.watchHeadingFilter.md
deleted file mode 100644
index 6a0283f..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compass.watchHeadingFilter.md
+++ /dev/null
@@ -1,23 +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.
----
-
-compass.watchHeadingFilter
-==========================
-
-No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/compassError/compassError.md b/docs/en/1.9.0rc1/cordova/compass/compassError/compassError.md
deleted file mode 100644
index 989b4dc..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/compassError/compassError.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.
----
-
-CompassError
-==========
-
-A `CompassError` object is returned to the `compassError` callback function when an error occurs.
-
-Properties
-----------
-
-- __code:__ One of the predefined error codes listed below.
-
-Constants
----------
-- `CompassError.COMPASS_INTERNAL_ERR`
-- `CompassError.COMPASS_NOT_SUPPORTED`
-
-Description
------------
-
-The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/parameters/compassError.md b/docs/en/1.9.0rc1/cordova/compass/parameters/compassError.md
deleted file mode 100755
index cf89324..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/parameters/compassError.md
+++ /dev/null
@@ -1,30 +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.
----
-
-compassError
-==========
-
-onError callback function for compass functions.
-
-Example
--------
-
-function(CompassError) {
- // Handle the error
-}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/parameters/compassHeading.md b/docs/en/1.9.0rc1/cordova/compass/parameters/compassHeading.md
deleted file mode 100644
index 935ea06..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/parameters/compassHeading.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.
----
-
-compassHeading
-==========
-
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
-
-Properties
-----------
-- __magneticHeading:__ The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
-- __trueHeading:__ The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading could not be determined. _(Number)_
-- __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
-- __timestamp:__ The time at which this heading was determined. _(milliseconds)_
-
-Description
------------
-
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
-
-Android Quirks
---------------
-- trueHeading is not supported. It will report the same value as magneticHeading
-- headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.
-
-iOS Quirks
-----------
-
-- trueHeading is only returned when location services are running via `navigator.geolocation.watchLocation()`
-- For iOS > 4 devices, if the device is rotated and the app supports that orientation, the heading values will be reported
-back with respect to the current orientation.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/parameters/compassOptions.md b/docs/en/1.9.0rc1/cordova/compass/parameters/compassOptions.md
deleted file mode 100755
index 252966c..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/parameters/compassOptions.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.
----
-
-compassOptions
-==============
-
-An optional parameter to customize the retrieval of the compass.
-
-Options
--------
-
-- __frequency:__ How often to retrieve the compass heading in milliseconds. _(Number)_ (Default: 100)
-- __filter:__ The change in degrees required to initiate a watchHeading success callback. _(Number)_
-
-Android Quirks
-______________
-- filter is not supported.
-
-Windows Phone 7 Quirks
---------------
-
-- filter is not supported.
-
-Bada Quirks
------------
-- filter is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/compass/parameters/compassSuccess.md b/docs/en/1.9.0rc1/cordova/compass/parameters/compassSuccess.md
deleted file mode 100644
index 1b0fc9c..0000000
--- a/docs/en/1.9.0rc1/cordova/compass/parameters/compassSuccess.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.
----
-
-compassSuccess
-==============
-
-onSuccess callback function that provides the compass heading information via a compassHeading object.
-
- function(heading) {
- // Do something
- }
-
-Parameters
-----------
-
-
-- __heading:__ The heading information. _(compassHeading)_
-
-Example
--------
-
- function onSuccess(heading) {
- alert('Heading: ' + heading.magneticHeading);
- };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/connection/connection.md b/docs/en/1.9.0rc1/cordova/connection/connection.md
deleted file mode 100644
index c9b7c09..0000000
--- a/docs/en/1.9.0rc1/cordova/connection/connection.md
+++ /dev/null
@@ -1,92 +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.
----
-
-Connection
-==========
-
-> The `connection` object gives access to the device's cellular and wifi connection information.
-
-This object is accessed under the `navigator.network` interface.
-
-Properties
-----------
-
-- connection.type
-
-Constants
----------
-
-- Connection.UNKNOWN
-- Connection.ETHERNET
-- Connection.WIFI
-- Connection.CELL_2G
-- Connection.CELL_3G
-- Connection.CELL_4G
-- Connection.NONE
-
-Permissions
------------
-
-### Android
-
-#### app/res/xml/plugins.xml
-
- <plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" />
-
-#### app/AndroidManifest.xml
-
- <uses-permission android:name="android.permission.INTERNET" />
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
- <uses-permission android:name="android.permission.READ_PHONE_STATE" />
-
-### Bada
-
- <Privilege>
- <Name>SYSTEM_SERVICE</Name>
- </Privilege>
-
-### BlackBerry WebWorks
-
-#### www/plugins.xml
-
- <plugin name="Network Status" value="org.apache.cordova.network.Network" />
-
-### iOS
-
-#### App/Supporting Files/Cordova.plist
-
- <key>Plugins</key>
- <dict>
- <key>NetworkStatus</key>
- <string>CDVConnection</string>
- </dict>
-
-### webOS
-
- No permissions are required.
-
-### Windows Phone
-
-#### Properties/WPAppManifest.xml
-
- <Capabilities>
- <Capability Name="ID_CAP_NETWORKING" />
- </Capabilities>
-
-Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/connection/connection.type.md b/docs/en/1.9.0rc1/cordova/connection/connection.type.md
deleted file mode 100644
index 9a05c19..0000000
--- a/docs/en/1.9.0rc1/cordova/connection/connection.type.md
+++ /dev/null
@@ -1,123 +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.
----
-
-connection.type
-===================
-
-Checks the active network connection that is being used.
-
-Description
------------
-
-This property is a fast way to determine the device's network connection state, and type of connection.
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- Windows Phone 7 ( Mango )
-- Bada 2.x
-- webOS
-
-Quick Example
--------------
-
- function checkConnection() {
- var networkState = navigator.network.connection.type;
-
- var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- checkConnection();
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>navigator.network.connection.type Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is loaded and it is now safe to make calls Cordova methods
- //
- function onDeviceReady() {
- checkConnection();
- }
-
- function checkConnection() {
- var networkState = navigator.network.connection.type;
-
- var states = {};
- states[Connection.UNKNOWN] = 'Unknown connection';
- states[Connection.ETHERNET] = 'Ethernet connection';
- states[Connection.WIFI] = 'WiFi connection';
- states[Connection.CELL_2G] = 'Cell 2G connection';
- states[Connection.CELL_3G] = 'Cell 3G connection';
- states[Connection.CELL_4G] = 'Cell 4G connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- </script>
- </head>
- <body>
- <p>A dialog box will report the network state.</p>
- </body>
- </html>
-
-iOS Quirks
-----------
-
-- iOS cannot detect the type of cellular network connection.
- - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
-
-Bada Quirks
------------
-
-- Bada can only detect a WiFi or cellular connection.
- - `navigator.network.connection.type` is set to `Connection.CELL_2G` for all cellular data.
-
-webOS Quirks
-------------
-
-- Only shows that a connection is available, but not which type.
-
-Windows Phone Quirks
---------------------
-
-- Windows Phone Emulator always detects `navigator.network.connection.type` as `Connection.UNKNOWN`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/Contact/contact.md b/docs/en/1.9.0rc1/cordova/contacts/Contact/contact.md
deleted file mode 100644
index f6f3e44..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/Contact/contact.md
+++ /dev/null
@@ -1,232 +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. _(ContactAddress[])_
-- __ims:__ An array of all the contact's IM addresses. _(ContactField[])_
-- __organizations:__ An array of all the contact's organizations. _(ContactOrganization[])_
-- __birthday:__ The birthday of the contact. _(Date)_
-- __note:__ A note about the contact. _(DOMString)_
-- __photos:__ An array of the contact's photos. _(ContactField[])_
-- __categories:__ An array of all the contacts user defined categories. _(ContactField[])_
-- __urls:__ An array of web pages associated to the contact. _(ContactField[])_
-
-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 WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-Save Quick Example
-------------------
-
- function onSuccess(contact) {
- alert("Save Success");
- };
-
- function onError(contactError) {
- alert("Error = " + contactError.code);
- };
-
- // create a new contact object
- var contact = navigator.contacts.create();
- contact.displayName = "Plumber";
- contact.nickname = "Plumber"; //specify both to support all devices
-
- // populate some fields
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save to device
- contact.save(onSuccess,onError);
-
-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>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // create
- var contact = navigator.contacts.create();
- contact.displayName = "Plumber";
- contact.nickname = "Plumber"; //specify both to support all devices
- var name = new ContactName();
- name.givenName = "Jane";
- name.familyName = "Doe";
- contact.name = name;
-
- // save
- contact.save(onSaveSuccess,onSaveError);
-
- // 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);
- }
-
- // onSaveSuccess: Get a snapshot of the current contacts
- //
- function onSaveSuccess(contact) {
- alert("Save Success");
- }
-
- // onSaveError: Failed to get the contacts
- //
- function onSaveError(contactError) {
- alert("Error = " + contactError.code);
- }
-
- // 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>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android 2.X Quirks
-------------------
-
-- __categories:__ This property is not support by Android 2.X devices, and will always be returned as `null`.
-
-Android 1.X Quirks
-------------------
-
-- __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`.
-- __birthday:__ 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`.
-- __categories:__ 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`.
-
-
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
----------------------------------------------
-
-- __id:__ Supported. Assigned by device when contact is saved.
-- __displayName:__ Supported. Stored in BlackBerry __user1__ field.
-- __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.
-- __photos:__ - Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a Base64 encoded image, or a URL pointing to the image. The image will be scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a Base64 encoded image.
-- __categories:__ Partially supported. Only 'Business' and 'Personal' categories are supported.
-- __urls:__ Partially supported. The first url is stored in BlackBerry __webpage__ field.
-
-iOS Quirks
-----------
-- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively.
-- __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object.
-- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits.
-- __categories:__ This property is not currently supported and will always be returned as `null`.
-
-
-Bada Quirks
------------
-
-- __displayName:__ This property is not supported
-- __birthday:__ This property is not supported
-- __photos:__ This property should be a list with one URL to a photo
-- __categories:__ This property is not supported
-- __ims:__ This property is not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/1.9.0rc1/cordova/contacts/ContactAddress/contactaddress.md
deleted file mode 100644
index c5078ef..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactAddress/contactaddress.md
+++ /dev/null
@@ -1,170 +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
-----------
-- __pref:__ Set to `true` if this `ContactAddress` contains the user's preferred value. _(boolean)_
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
-- __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 WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-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("Pref: " + contacts[i].addresses[j].pref + "\n" +
- "Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
- };
-
- function onError(contactError) {
- alert('onError!');
- };
-
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
- navigator.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // find all contacts
- var options = new ContactFindOptions();
- options.filter="";
- var filter = ["displayName","addresses"];
- navigator.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("Pref: " + contacts[i].addresses[j].pref + "\n" +
- "Type: " + contacts[i].addresses[j].type + "\n" +
- "Formatted: " + contacts[i].addresses[j].formatted + "\n" +
- "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" +
- "Locality: " + contacts[i].addresses[j].locality + "\n" +
- "Region: " + contacts[i].addresses[j].region + "\n" +
- "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" +
- "Country: " + contacts[i].addresses[j].country);
- }
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android 2.X Quirks
-------------------
-
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
-
-Android 1.X Quirks
-------------------
-
-- __pref:__ This property is not supported by Android 1.X devices and will always return `false`.
-- __type:__ This property is not supported by Android 1.X devices and will always return `null`.
-- __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 WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __pref:__ This property is not supported on Blackberry devices and will always return `false`.
-- __type:__ Partially supported. Only one each of "Work" and "Home" type addresses can be stored per contact.
-- __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.
-
-iOS Quirks
-----------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-- __formatted:__ Not currently supported.
-
-Bada Quirks
------------
-- __formatted:__ This property is not supported
-- __type:__ Has to be one of the following: WORK, HOME
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactError/contactError.md b/docs/en/1.9.0rc1/cordova/contacts/ContactError/contactError.md
deleted file mode 100644
index 45b5873..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactError/contactError.md
+++ /dev/null
@@ -1,45 +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.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/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactField/contactfield.md b/docs/en/1.9.0rc1/cordova/contacts/ContactField/contactfield.md
deleted file mode 100644
index d00f870..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactField/contactfield.md
+++ /dev/null
@@ -1,146 +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)_
-- __pref:__ 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 pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses.
-
-In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-Quick Example
--------------
-
- // create a new contact
- var contact = navigator.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // create a new contact
- var contact = navigator.contacts.create();
-
- // store contact phone numbers in ContactField[]
- var phoneNumbers = [];
- phoneNumbers[0] = new ContactField('work', '212-555-1234', false);
- phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number
- phoneNumbers[2] = new ContactField('home', '203-555-7890', false);
- contact.phoneNumbers = phoneNumbers;
-
- // save the contact
- contact.save();
-
- // search contacts, returning display name and phone numbers
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","phoneNumbers"];
- navigator.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++) {
- // display phone numbers
- 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" +
- "Preferred: " + contacts[i].phoneNumbers[j].pref);
- }
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android Quirks
---------------
-
-- __pref:__ This property is not support by Android devices, and will always return `false`.
-
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-
-- __type:__ Partially supported. Used for phone numbers.
-- __value:__ Supported.
-- __pref:__ This property is not supported, and will always return `false`.
-
-iOS Quirks
------------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-
-Bada Quirks
------------
-- __type:__ Property has to be one of the following for Email or Address fields: "WORK", "HOME". Property has to be one of the following for Phone fields: "WORK", "HOME", "VOICE", "FAX", "MSG", "CELL", "PAGER","BBS", "MODEM", "CAR", "ISDN","VIDEO", "PCS"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/1.9.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
deleted file mode 100644
index f4625de..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ /dev/null
@@ -1,116 +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
-==================
-
-Contains properties that can be used to filter the results of a `contacts.find` operation.
-
-Properties
-----------
-
-- __filter:__ The search string used to find contacts. _(DOMString)_ (Default: "")
-- __multiple:__ Determines if the find operation should return multiple contacts. _(Boolean)_ (Default: false)
-
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-Quick Example
--------------
-
- // success callback
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert(contacts[i].displayName);
- }
- };
-
- // error callback
- function onError(contactError) {
- alert('onError!');
- };
-
- // specify contact search criteria
- var options = new ContactFindOptions();
- options.filter=""; // empty search string returns all contacts
- options.multiple=true; // return multiple results
- filter = ["displayName"]; // return contact.displayName field
-
- // find contacts
- navigator.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- // specify contact search criteria
- var options = new ContactFindOptions();
- options.filter=""; // empty search string returns all contacts
- options.multiple=true; // return multiple results
- filter = ["displayName"]; // return contact.displayName field
-
- // find contacts
- navigator.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++) {
- alert(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>
-
-Bada Quirks
------------
-__filter:__ Property can only apply to the following: "firstName", "lastName", "nickname", "phoneNumber", "email", "address"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactName/contactname.md b/docs/en/1.9.0rc1/cordova/contacts/ContactName/contactname.md
deleted file mode 100644
index 3a5199b..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactName/contactname.md
+++ /dev/null
@@ -1,145 +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.
----
-
-ContactName
-===========
-
-Contains name properties of a `Contact` object.
-
-Properties
-----------
-
-- __formatted:__ The complete name of the contact. _(DOMString)_
-- __familyName:__ The contacts family name. _(DOMString)_
-- __givenName:__ The contacts given name. _(DOMString)_
-- __middleName:__ The contacts middle name. _(DOMString)_
-- __honorificPrefix:__ The contacts prefix (example Mr. or Dr.) _(DOMString)_
-- __honorificSuffix:__ The contacts suffix (example Esq.). _(DOMString)_
-
-Details
--------
-
-The `ContactName` object stores name properties of a contact.
-
-Supported Platforms
--------------------
-
-- Android 2.X
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-Quick Example
--------------
-
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
- "Prefix: " + contacts[i].name.honorificSuffix);
- }
- };
-
- function onError(contactError) {
- alert('onError!');
- };
-
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","name"];
- navigator.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","name"];
- navigator.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++) {
- alert("Formatted: " + contacts[i].name.formatted + "\n" +
- "Family Name: " + contacts[i].name.familyName + "\n" +
- "Given Name: " + contacts[i].name.givenName + "\n" +
- "Middle Name: " + contacts[i].name.middleName + "\n" +
- "Suffix: " + contacts[i].name.honorificSuffix + "\n" +
- "Prefix: " + contacts[i].name.honorificPrefix);
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-Android Quirks
-------------
-- __formatted:__ Partially supported. Will return the concatenation of honorificPrefix, givenName, middleName, familyName and honorificSuffix but will not store.
-
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
----------------------------------------------
-
-- __formatted:__ Partially supported. Will return concatenation of BlackBerry __firstName__ and __lastName__ fields.
-- __familyName:__ Supported. Stored in BlackBerry __lastName__ field.
-- __givenName:__ Supported. Stored in BlackBerry __firstName__ field.
-- __middleName:__ This property is not supported, and will always return `null`.
-- __honorificPrefix:__ This property is not supported, and will always return `null`.
-- __honorificSuffix:__ This property is not supported, and will always return `null`.
-
-iOS Quirks
-------------
-- __formatted:__ Partially supported. Will return iOS Composite Name but will not store.
-
-Bada Quirks
------------
-- __formatted:__ Property not supported
-- __middleName:__ Property not supported
-_ __honorificPrefix:__ Property not supported
-- __honorificSuffix:__ Property not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/1.9.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
deleted file mode 100644
index 34f7dc9..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/ContactOrganization/contactorganization.md
+++ /dev/null
@@ -1,153 +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.
----
-
-ContactOrganization
-===================
-
-Contains organization properties of a `Contact` object.
-
-Properties
-----------
-- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
-- __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString)
-- __name:__ The name of the organization. _(DOMString)_
-- __department:__ The department the contract works for. _(DOMString)_
-- __title:__ The contacts title at the organization. _(DOMString)_
-
-Details
--------
-
-The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2
-
-Quick Example
--------------
-
- function onSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- for (var j=0; j<contacts[i].organizations.length; j++) {
- alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
- "Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
- "Title: " + contacts[i].organizations[j].title);
- }
- }
- };
-
- function onError(contactError) {
- alert('onError!');
- };
-
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","organizations"];
- navigator.contacts.find(filter, onSuccess, onError, options);
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- var options = new ContactFindOptions();
- options.filter="";
- filter = ["displayName","organizations"];
- navigator.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].organizations.length; j++) {
- alert("Pref: " + contacts[i].organizations[j].pref + "\n" +
- "Type: " + contacts[i].organizations[j].type + "\n" +
- "Name: " + contacts[i].organizations[j].name + "\n" +
- "Department: " + contacts[i].organizations[j].department + "\n" +
- "Title: " + contacts[i].organizations[j].title);
- }
- }
- };
-
- // onError: Failed to get the contacts
- //
- function onError(contactError) {
- alert('onError!');
- }
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
-
-
-Android 2.X Quirks
-------------------
-
-- __pref:__ This property is not supported by Android 2.X devices and will always return `false`.
-
-Android 1.X Quirks
-------------------
-
-- __pref:__ This property is not supported by Android 1.X devices and will always return `false`.
-- __type:__ This property is not supported by Android 1.X devices and will always return `null`.
-- __title:__ This property is not supported by Android 1.X devices, and will always be returned as `null`.
-
-BlackBerry WebWorks (OS 5.0 and higher) Quirks
---------------------------------------------
-- __pref:__ This property is not supported by Blackberry devices and will always return `false`.
-- __type:__ This property is not supported by Blackberry devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the BlackBerry __company__ field.
-- __department:__ This property is not supported, and will always be returned as `null`.
-- __title:__ Partially supported. The first organization title will be stored in the BlackBerry __jobTitle__ field.
-
-iOS Quirks
------------
-- __pref:__ This property is not supported on iOS devices and will always return `false`.
-- __type:__ This property is not supported on iOS devices and will always return `null`.
-- __name:__ Partially supported. The first organization name will be stored in the iOS __kABPersonOrganizationProperty__ field.
-- __department__: Partially supported. The first department name will be stored in the iOS __kABPersonDepartmentProperty__ field.
-- __title__: Partially supported. The first title will be stored in the iOS __kABPersonJobTitleProperty__ field.
-
-Bada 2.0 Quirks
----------------
-- ContactOrganization not supported
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/875c8fe2/docs/en/1.9.0rc1/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/1.9.0rc1/cordova/contacts/contacts.create.md b/docs/en/1.9.0rc1/cordova/contacts/contacts.create.md
deleted file mode 100644
index 1ab4a75..0000000
--- a/docs/en/1.9.0rc1/cordova/contacts/contacts.create.md
+++ /dev/null
@@ -1,77 +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.create
-===============
-
-Returns a new Contact object.
-
- var contact = navigator.contacts.create(properties);
-
-Description
------------
-
-contacts.create is a synchronous function that returns a new `Contact` object.
-
-This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method.
-
-Supported Platforms
--------------------
-
-- Android
-- BlackBerry WebWorks (OS 5.0 and higher)
-- iOS
-- Bada 1.2 & 2.0
-
-Quick Example
--------------
-
- var myContact = navigator.contacts.create({"displayName": "Test User"});
-
-Full Example
-------------
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova-1.9.0.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for Cordova to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // Cordova is ready
- //
- function onDeviceReady() {
- var myContact = navigator.contacts.create({"displayName": "Test User"});
- myContact.note = "This contact has a note.";
- console.log("The contact, " + myContact.displayName + ", note: " + myContact.note);
- }
-
-
- </script>
- </head>
- <body>
- <h1>Example</h1>
- <p>Create Contact</p>
- </body>
- </html>