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/12/19 04:01:16 UTC
[6/7] CB-5658 Delete plugin API reference in favour of links to
github doc/index.md files
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
deleted file mode 100755
index d0a2371..0000000
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ /dev/null
@@ -1,148 +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 the compass watch interval. The watch
-ID can be used with `compass.clearWatch` to stop watching the compass.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Tizen
-- Windows Phone 7 and 8 (if available in hardware)
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // The watch id references the current `watchHeading`
- var watchID = null;
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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 executes. Specify the degrees of
-change via the `filter` parameter in the `compassOptions` object.
-Clear the watch as usual by passing the returned watch ID to
-`compass.clearWatch`. This functionality replaces the previously
-separate, iOS-only `watchHeadingFilter` and `clearWatchFilter`
-functions, which were removed in version 1.6.
-
-Only one `watchHeading` can be in effect at one time in iOS. If a
-`watchHeading` uses a filter, calling `getCurrentHeading` or
-`watchHeading` uses the existing filter value to specify heading
-changes. Watching heading changes with a filter is more efficient than
-with time intervals.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
deleted file mode 100644
index 62483f3..0000000
--- a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
+++ /dev/null
@@ -1,22 +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/97ae96ee/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
deleted file mode 100644
index c405431..0000000
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ /dev/null
@@ -1,36 +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
-
-When an error occurs, the `CompassError` object is passed as a
-parameter to a `compassError` callback function.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
deleted file mode 100755
index 59d68b7..0000000
--- a/docs/en/edge/cordova/compass/parameters/compassError.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.
----
-
-# compassError
-
-onError callback function for compass functions.
-
-## Example
-
- function(CompassError) {
- // Handle the error
- }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
deleted file mode 100644
index ec53abf..0000000
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ /dev/null
@@ -1,54 +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.
-
-## 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 can't 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 `compassSuccess` callback function.
-
-## Amazon Fire OS Quirks
-
-- `trueHeading` is not supported, but reports the same value as `magneticHeading`
-
-- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`
-
-## Android Quirks
-
-- The `trueHeading` property is not supported, but reports the same value as `magneticHeading`.
-
-- The `headingAccuracy` property is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
-
-## iOS Quirks
-
-- The `trueHeading` property is only returned for location services enabled via `navigator.geolocation.watchLocation()`.
-
-- For iOS 4 devices and above, heading factors in the device's current orientation, and does not reference its absolute position, for apps that supports that orientation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
deleted file mode 100755
index 764cbb1..0000000
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ /dev/null
@@ -1,44 +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)_
-
-## Amazon Fire OS Quirks
-
-- `filter` is not supported.
-
-## Android Quirks
-
-- No support for `filter`.
-
-## Tizen Quirks
-
-- No support for `filter`.
-
-## Windows Phone 7 and 8 Quirks
-
-- No support for `filter`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
deleted file mode 100644
index e814959..0000000
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ /dev/null
@@ -1,36 +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/97ae96ee/docs/en/edge/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md
deleted file mode 100644
index 76c736f..0000000
--- a/docs/en/edge/cordova/connection/connection.md
+++ /dev/null
@@ -1,99 +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, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
-
-## Properties
-
-- connection.type
-
-## Constants
-
-- Connection.UNKNOWN
-- Connection.ETHERNET
-- Connection.WIFI
-- Connection.CELL_2G
-- Connection.CELL_3G
-- Connection.CELL_4G
-- Connection.CELL
-- Connection.NONE
-
-## Accessing the Feature
-
-As of version 3.0, Cordova implements device-level APIs as _plugins_.
-Use the CLI's `plugin` command, described in The Command-Line
-Interface, to add or remove this feature for a project:
-
- $ cordova plugin add org.apache.cordova.network-information
- $ cordova plugin ls
- [ 'org.apache.cordova.network-information' ]
- $ cordova plugin rm org.apache.cordova.network-information
-
-These commands apply to all targeted platforms, but modify the
-platform-specific configuration settings described below:
-
-* Amazon Fire OS
-
- (in app/res/xml/config.xml)
- <feature name="NetworkStatus">
- <param name="android-package" value="org.apache.cordova.networkinformation.NetworkManager" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-
-* Android
-
- (in app/res/xml/config.xml)
- <feature name="NetworkStatus">
- <param name="android-package" value="org.apache.cordova.networkinformation.NetworkManager" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-
-* BlackBerry 10
-
- (in www/config.xml)
- <feature name="NetworkStatus" value="NetworkStatus"/>
-
-* iOS (in the named application directory's `config.xml`)
-
- <feature name="NetworkStatus">
- <param name="ios-package" value="CDVConnection" />
- </feature>
-
-* Windows Phone (in `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)
-
-* Tizen (in `config.xml`)
-
- <feature name="http://tizen.org/api/systeminfo" required="true"/>
-
- Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures)
-
-Some platforms may support this feature without requiring any special
-configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
deleted file mode 100644
index 5bc8ae6..0000000
--- a/docs/en/edge/cordova/connection/connection.type.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.
----
-
-# connection.type
-
-Checks the currently active network connection.
-
-## Description
-
-This property offers a fast way to determine the device's network
-connection state, and type of connection.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- iOS
-- Android
-- BlackBerry 10
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-
-## Quick Example
-
- function checkConnection() {
- var networkState = navigator.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.CELL] = 'Cell generic connection';
- states[Connection.NONE] = 'No network connection';
-
- alert('Connection type: ' + states[networkState]);
- }
-
- checkConnection();
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>navigator.connection.type Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- function onDeviceReady() {
- checkConnection();
- }
-
- function checkConnection() {
- var networkState = navigator.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.CELL] = 'Cell generic 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>
-
-## API Change
-
-Until Cordova 2.3.0, the `Connection` object was accessed via
-`navigator.network.connection`, after which it was changed to
-`navigator.connection` to match the W3C specification. It's still
-available at its original location, but is deprecated and will
-eventually be removed.
-
-## iOS Quirks
-
-- iOS can't detect the type of cellular network connection.
- - `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
-
-## Windows Phone Quirks
-
-- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`.
-
-- Windows Phone can't detect the type of cellular network connection.
- - `navigator.connection.type` is set to `Connection.CELL` for all cellular data.
-
-## Tizen Quirks
-
-- Tizen can only detect a WiFi or cellular connection.
- - `navigator.connection.type` is set to `Connection.CELL_2G` for all cellular data.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/Contact/contact.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/Contact/contact.md b/docs/en/edge/cordova/contacts/Contact/contact.md
deleted file mode 100644
index 8694c09..0000000
--- a/docs/en/edge/cordova/contacts/Contact/contact.md
+++ /dev/null
@@ -1,257 +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 by which to address the contact. _(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 user-defined categories associated with the contact. _(ContactField[])_
-
-- __urls__: An array of web pages associated with 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, otherwise executes an error callback with a `ContactError` object.
-
-- __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's contact. Contacts can be
-created, stored, 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 contact fields listed above are supported on
-every device platform. Please check each platform's _Quirks_ section
-for details.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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__: Not supported on Android 2.X devices, returning `null`.
-
-## BlackBerry 10 Quirks
-
-- __id__: Supported. Assigned by the device when saving the contact.
-
-- __displayName__: Supported. Stored in BlackBerry __user1__ field.
-
-- __nickname__: Not supported, returning `null`.
-
-- __phoneNumbers__: Partially supported. Phone numbers are 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 are stored in the BlackBerry __email1__, __email2__, and __email3__ fields, respectively.
-
-- __addresses__: Partially supported. The first and second addresses are stored in the BlackBerry __homeAddress__ and __workAddress__ fields, respectively.
-
-- __ims__: Not supported, returning `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 is 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__: Not supported on iOS, returning `null` unless there is no `ContactName` specified, in which case it returns the composite name, __nickname__ or `""`, respectively.
-
-- __birthday__: Must be input as a JavaScript `Date` object, the same way it is returned.
-
-- __photos__: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.
-
-- __categories__: This property is currently not supported, returning `null`.
-
-## Windows Phone 7 and 8 Quirks
-
-- __displayName__: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.
-
-- __urls__: When creating a contact, users can input and save more than one web address, but only one is available when searching the contact.
-
-- __phoneNumbers__: The _pref_ option is not supported. The _type_ is not supported in a _find_ operation. Only one `phoneNumber` is allowed for each _type_.
-
-- __emails__: The _pref_ option is not supported. Home and personal references same email entry. Only one entry is allowed for each _type_.
-
-- __addresses__: Supports only work, and home/personal _type_. The home and personal _type_ reference the same address entry. Only one entry is allowed for each _type_.
-
-- __organizations__: Only one is allowed, and does not support the _pref_, _type_, and _department_ attributes.
-
-- __note__: Not supported, returning `null`.
-
-- __ims__: Not supported, returning `null`.
-
-- __birthdays__: Not supported, returning `null`.
-
-- __categories__: Not supported, returning `null`.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md b/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
deleted file mode 100644
index 6eab561..0000000
--- a/docs/en/edge/cordova/contacts/ContactAddress/contactaddress.md
+++ /dev/null
@@ -1,169 +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 indicating what type of field this is, _home_ for example. _(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 may include more than one address in
-a `ContactAddress[]` array.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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__: Not supported, returning `false` on Android 2.X devices.
-
-## BlackBerry 10 Quirks
-
-- __pref__: Not supported on BlackBerry devices, returning `false`.
-
-- __type__: Partially supported. Only one each of _Work_ and _Home_ type addresses can be stored per contact.
-
-- __formatted__: Partially supported. Returns a concatenation of all BlackBerry address fields.
-
-- __streetAddress__: Supported. Returns a 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__: Not supported on iOS devices, returning `false`.
-
-- __formatted__: Currently not supported.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/ContactError/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactError/contactError.md b/docs/en/edge/cordova/contacts/ContactError/contactError.md
deleted file mode 100644
index e6bc46b..0000000
--- a/docs/en/edge/cordova/contacts/ContactError/contactError.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.
----
-
-# ContactError
-
-A `ContactError` object is passed 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/97ae96ee/docs/en/edge/cordova/contacts/ContactField/contactfield.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactField/contactfield.md b/docs/en/edge/cordova/contacts/ContactField/contactfield.md
deleted file mode 100644
index 9757b6e..0000000
--- a/docs/en/edge/cordova/contacts/ContactField/contactfield.md
+++ /dev/null
@@ -1,156 +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 stored
-as `ContactField` objects include email addresses, phone numbers, and
-URLs.
-
-## Properties
-
-- __type__: A string that indicates what type of field this is, _home_ for example. _(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 represents
-contact fields generically. Each `ContactField` object contains a
-`value`, `type`, and `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 a
-`ContactField` object's __type__ attribute. For example, a phone
-number can specify __type__ values of _home_, _work_, _mobile_,
-_iPhone_, or any other value that is supported by a particular device
-platform's contact database. However, for the `Contact` __photos__
-field, the __type__ field indicates the format of the returned image:
-__url__ when the __value__ attribute contains a URL to the photo
-image, or _base64_ when the __value__ contains a base64-encoded image
-string.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
-
- 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__: Not supported, returning `false`.
-
-## BlackBerry 10 Quirks
-
-- __type__: Partially supported. Used for phone numbers.
-
-- __value__: Supported.
-
-- __pref__: Not supported, returning `false`.
-
-## iOS Quirks
-
-- __pref__: Not supported, returning `false`.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.md
deleted file mode 100644
index 1af5b89..0000000
--- a/docs/en/edge/cordova/contacts/ContactFindOptions/contactfindoptions.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.
----
-
-# 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 returns multiple contacts. _(Boolean)_ (Default: `false`)
-
-## Supported Platforms
-
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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>
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/ContactName/contactname.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactName/contactname.md b/docs/en/edge/cordova/contacts/ContactName/contactname.md
deleted file mode 100644
index 168b102..0000000
--- a/docs/en/edge/cordova/contacts/ContactName/contactname.md
+++ /dev/null
@@ -1,144 +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 different kinds of information about a `Contact` object's name.
-
-## Properties
-
-- __formatted__: The complete name of the contact. _(DOMString)_
-
-- __familyName__: The contact's family name. _(DOMString)_
-
-- __givenName__: The contact's given name. _(DOMString)_
-
-- __middleName__: The contact's middle name. _(DOMString)_
-
-- __honorificPrefix__: The contact's prefix (example _Mr._ or _Dr._) _(DOMString)_
-
-- __honorificSuffix__: The contact's suffix (example _Esq._). _(DOMString)_
-
-## Details
-
-The `ContactName` object stores a contact's name properties.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android 2.X
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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, and read-only. Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
-
-## BlackBerry 10 Quirks
-
-- __formatted__: Partially supported. Returns a concatenation of BlackBerry __firstName__ and __lastName__ fields.
-
-- __familyName__: Supported. Stored in BlackBerry __lastName__ field.
-
-- __givenName__: Supported. Stored in BlackBerry __firstName__ field.
-
-- __middleName__: Not supported, returning `null`.
-
-- __honorificPrefix__: Not supported, returning `null`.
-
-- __honorificSuffix__: Not supported, returning `null`.
-
-## iOS Quirks
-
-- __formatted__: Partially supported. Returns iOS Composite Name, but is read-only.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md b/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
deleted file mode 100644
index 4801e18..0000000
--- a/docs/en/edge/cordova/contacts/ContactOrganization/contactorganization.md
+++ /dev/null
@@ -1,151 +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 a `Contact` object's organization properties.
-
-## Properties
-
-- __pref__: Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_
-
-- __type__: A string that indicates what type of field this is, _home_ for example. _(DOMString)
-
-- __name__: The name of the organization. _(DOMString)_
-
-- __department__: The department the contract works for. _(DOMString)_
-
-- __title__: The contact's 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 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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__: Not supported by Android 2.X devices, returning `false`.
-
-## BlackBerry 10 Quirks
-
-- __pref__: Not supported by BlackBerry devices, returning `false`.
-
-- __type__: Not supported by BlackBerry devices, returning `null`.
-
-- __name__: Partially supported. The first organization name is stored in the BlackBerry __company__ field.
-
-- __department__: Not supported, returning `null`.
-
-- __title__: Partially supported. The first organization title is stored in the BlackBerry __jobTitle__ field.
-
-## iOS Quirks
-
-- __pref__: Not supported on iOS devices, returning `false`.
-
-- __type__: Not supported on iOS devices, returning `null`.
-
-- __name__: Partially supported. The first organization name is stored in the iOS __kABPersonOrganizationProperty__ field.
-
-- __department__: Partially supported. The first department name is stored in the iOS __kABPersonDepartmentProperty__ field.
-
-- __title__: Partially supported. The first title is stored in the iOS __kABPersonJobTitleProperty__ field.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/contacts.create.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.create.md b/docs/en/edge/cordova/contacts/contacts.create.md
deleted file mode 100644
index 67d5746..0000000
--- a/docs/en/edge/cordova/contacts/contacts.create.md
+++ /dev/null
@@ -1,72 +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
-
-The `contacts.create` method is synchronous, and returns a new `Contact` object.
-
-This method does not retain the Contact object in the device contacts
-database, for which you need to invoke the `Contact.save` method.
-
-## Supported Platforms
-
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-
-## 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.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- 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>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/contacts.find.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.find.md b/docs/en/edge/cordova/contacts/contacts.find.md
deleted file mode 100644
index 72cbb8e..0000000
--- a/docs/en/edge/cordova/contacts/contacts.find.md
+++ /dev/null
@@ -1,124 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# contacts.find
-
-Queries the device contacts database and returns one or more `Contact`
-objects, each containing the fields specified.
-
- navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions);
-
-## Description
-
-The `contacts.find` method executes asynchronously, querying the
-device contacts database and returning an array of `Contact` objects.
-The resulting objects are passed to the `contactSuccess` callback
-function specified by the __contactSuccess__ parameter.
-
-The __contactFields__ parameter specifies the fields to be used as a
-search qualifier, and only those results are passed to the
-__contactSuccess__ callback function. A zero-length __contactFields__
-parameter is invalid and results in
-`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
-`"*"` returns all contact fields.
-
-The __contactFindOptions.filter__ string can be used as a search
-filter when querying the contacts database. If provided, a
-case-insensitive, partial value match is applied to each field
-specified in the __contactFields__ parameter. If there's a match for
-_any_ of the specified fields, the contact is returned.
-
-## Parameters
-
-- __contactFields__: Contact fields to use as a search qualifier. The resulting `Contact` object only features values for these fields. _(DOMString[])_ [Required]
-
-- __contactSuccess__: Success callback function invoked with the contacts returned from the database. [Required]
-
-- __contactError__: Error callback function, invoked when an error occurs. [Optional]
-
-- __contactFindOptions__: Search options to filter contacts. [Optional]
-
-## Supported Platforms
-
-- Android
-- BlackBerry 10
-- iOS
-- Windows Phone 7 and 8
-- Windows 8
-
-## Quick Example
-
- function onSuccess(contacts) {
- alert('Found ' + contacts.length + ' contacts.');
- };
-
- function onError(contactError) {
- alert('onError!');
- };
-
- // find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter = "Bob";
- options.multiple = true;
- var fields = ["displayName", "name"];
- navigator.contacts.find(fields, onSuccess, onError, options);
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Contact Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
-
- function onDeviceReady() {
- // find all contacts with 'Bob' in any name field
- var options = new ContactFindOptions();
- options.filter = "Bob";
- var fields = ["displayName", "name"];
- navigator.contacts.find(fields, onSuccess, onError, options);
- }
-
- // onSuccess: Get a snapshot of the current contacts
-
- function onSuccess(contacts) {
- for (var i = 0; i < contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName);
- }
- }
-
- // onError: Failed to get the contacts
-
- function onError(contactError) {
- alert('onError!');
- }
- </script>
- </head>
-
- <body>
- <h1>Example</h1>
- <p>Find Contacts</p>
- </body>
- </html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md
deleted file mode 100644
index c2a96d9..0000000
--- a/docs/en/edge/cordova/contacts/contacts.md
+++ /dev/null
@@ -1,139 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# Contacts
-
-> The `contacts` object provides access to the device contacts database.
-
-__WARNING__: Collection and use of contact data raises
-important privacy issues. Your app's privacy policy should discuss
-how the app uses contact data and whether it is shared with any other
-parties. Contact information is considered sensitive because it
-reveals the people with whom a person communicates. Therefore, in
-addition to the app's privacy policy, you should strongly consider
-providing a just-in-time notice before the app accesses or uses
-contact data, if the device operating system doesn't do so
-already. That notice should provide the same information noted above,
-as well as obtaining the user's permission (e.g., by presenting
-choices for __OK__ and __No Thanks__). Note that some app
-marketplaces may require the app to provide a just-in-time notice and
-obtain the user's permission before accessing contact data. A
-clear and easy-to-understand user experience surrounding the use of
-contact data helps avoid user confusion and perceived misuse of
-contact data. For more information, please see the Privacy Guide.
-
-## Methods
-
-- contacts.create
-- contacts.find
-
-## Arguments
-
-- contactFields
-- contactSuccess
-- contactError
-- contactFindOptions
-
-## Objects
-
-- Contact
-- ContactName
-- ContactField
-- ContactAddress
-- ContactOrganization
-- ContactFindOptions
-- ContactError
-
-## Accessing the Feature
-
-As of version 3.0, Cordova implements device-level APIs as _plugins_.
-Use the CLI's `plugin` command, described in The Command-Line
-Interface, to add or remove this feature for a project:
-
- $ cordova plugin add org.apache.cordova.contacts
- $ cordova plugin ls
- [ 'org.apache.cordova.contacts' ]
- $ cordova plugin rm org.apache.cordova.contacts
-
-These commands apply to all targeted platforms, but modify the
-platform-specific configuration settings described below:
-
-* Amazon Fire OS
-
- (in app/res/xml/config.xml)
- <feature name="Contacts">
- <param name="android-package" value="org.apache.cordova.contacts.ContactManager" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.READ_CONTACTS" />
- <uses-permission android:name="android.permission.WRITE_CONTACTS" />
- <uses-permission android:name="android.permission.GET_ACCOUNTS" />
-
-* Android
-
- (in app/res/xml/config.xml)
- <feature name="Contacts">
- <param name="android-package" value="org.apache.cordova.contacts.ContactManager" />
- </feature>
-
- (in app/AndroidManifest.xml)
- <uses-permission android:name="android.permission.READ_CONTACTS" />
- <uses-permission android:name="android.permission.WRITE_CONTACTS" />
- <uses-permission android:name="android.permission.GET_ACCOUNTS" />
-
-* BlackBerry 10
-
- (in www/config.xml)
-
- <feature name="Contacts" value="Contacts"/>
- <rim:permit>access_pimdomain_contacts</rim:permit>
-
-* iOS (in the named application directory's `config.xml`)
-
- <feature name="Contacts">
- <param name="ios-package" value="CDVContacts" />
- </feature>
-
-* FirefoxOS
-
- Enable access to the API by changing [app permissions](https://developer.mozilla.org/en-US/Apps/Developing/App_permissions)
-
- (in platforms/firefoxos/www/manifest.webapp)
- "type": "privileged",
- "permissions": {
- "contacts": {
- "access": (choose from "readonly", "readwrite", "readcreate", or "createonly"),
- "description": "Describe why you need access to contacts API"
- }
- }
-
- All privileged apps enforce [Content Security Policy](https://developer.mozilla.org/en-US/Apps/CSP)
- which forbids inline scripts. Initialize your application in another way.
-
-* Windows Phone (in `Properties/WPAppManifest.xml`)
-
- <Capabilities>
- <Capability Name="ID_CAP_CONTACTS" />
- </Capabilities>
-
- Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx)
-
-Some platforms may support this feature without requiring any special
-configuration. See Platform Support for an overview.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/parameters/contactError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactError.md b/docs/en/edge/cordova/contacts/parameters/contactError.md
deleted file mode 100644
index 11ee57d..0000000
--- a/docs/en/edge/cordova/contacts/parameters/contactError.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# contactError
-
-Error callback function for contact functions.
-
- function(error) {
- // Handle the error
- }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/parameters/contactFields.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFields.md b/docs/en/edge/cordova/contacts/parameters/contactFields.md
deleted file mode 100644
index e2da390..0000000
--- a/docs/en/edge/cordova/contacts/parameters/contactFields.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# contactFields
-
-Required parameter for the `contacts.find` method, used to specify which fields should be included in the `Contact` objects resulting from a find operation.
-
- ["name", "phoneNumbers", "emails"]
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md b/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
deleted file mode 100644
index fb7e79c..0000000
--- a/docs/en/edge/cordova/contacts/parameters/contactFindOptions.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# contactFindOptions
-
-Optional parameter of the `contacts.find` method, used to filter the
-contacts returned from the contacts database.
-
- {
- filter: "",
- multiple: true,
- };
-
-## Options
-
-- __filter__: The search string used to filter contacts. _(DOMString)_ (Default: `""`)
-
-- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md b/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
deleted file mode 100644
index 543f5e3..0000000
--- a/docs/en/edge/cordova/contacts/parameters/contactSuccess.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# contactSuccess
-
-Success callback function that provides the `Contact` array resulting from a `contacts.find` operation.
-
- function(contacts) {
- // Do something
- }
-
-## Parameters
-
-- __contacts__: The contact array resulting from a find operation. _(Contact)_
-
-## Example
-
- function contactSuccess(contacts) {
- for (var i=0; i<contacts.length; i++) {
- console.log("Display Name = " + contacts[i].displayName);
- }
- }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/97ae96ee/docs/en/edge/cordova/device/device.cordova.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/device/device.cordova.md b/docs/en/edge/cordova/device/device.cordova.md
deleted file mode 100644
index 81f6d3f..0000000
--- a/docs/en/edge/cordova/device/device.cordova.md
+++ /dev/null
@@ -1,75 +0,0 @@
----
- license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# device.cordova
-
-Get the version of Cordova running on the device.
-
- var string = device.cordova;
-
-## Description
-
-`device.cordova` returns the version of Cordova running on the device.
-
-## Supported Platforms
-
-- Amazon Fire OS
-- Android
-- BlackBerry 10
-- iOS
-- Tizen
-- Windows Phone 7 and 8
-- Windows 8
-
-## Quick Example
-
- var name = device.cordova;
-
-## Full Example
-
- <!DOCTYPE html>
- <html>
- <head>
- <title>Device Properties Example</title>
-
- <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
- <script type="text/javascript" charset="utf-8">
-
- // Wait for device API libraries to load
- //
- document.addEventListener("deviceready", onDeviceReady, false);
-
- // device APIs are available
- //
- function onDeviceReady() {
- var element = document.getElementById('deviceProperties');
- element.innerHTML = 'Device Model: ' + device.model + '<br />' +
- 'Device Cordova: ' + device.cordova + '<br />' +
- 'Device Platform: ' + device.platform + '<br />' +
- 'Device UUID: ' + device.uuid + '<br />' +
- 'Device Version: ' + device.version + '<br />';
- }
-
- </script>
- </head>
- <body>
- <p id="deviceProperties">Loading device properties...</p>
- </body>
- </html>
-