You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by pu...@apache.org on 2014/03/18 21:18:02 UTC

git commit: Update docs with Windows 8 support info, fix contacts.find example error

Repository: cordova-plugin-contacts
Updated Branches:
  refs/heads/master 2f76f2bfb -> a97110465


Update docs with Windows 8 support info, fix contacts.find example error


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/commit/a9711046
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/tree/a9711046
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/diff/a9711046

Branch: refs/heads/master
Commit: a97110465f11c9c4feb041bde8ac9aa9b954ea19
Parents: 2f76f2b
Author: Jesse MacFadyen <pu...@gmail.com>
Authored: Tue Mar 18 13:17:40 2014 -0700
Committer: Jesse MacFadyen <pu...@gmail.com>
Committed: Tue Mar 18 13:17:40 2014 -0700

----------------------------------------------------------------------
 doc/index.md | 32 +++++++++++++++++++++++++++-----
 1 file changed, 27 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/blob/a9711046/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index 0a78d4c..ea6a643 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -135,12 +135,12 @@ _any_ of the specified fields, the contact is returned.
 - Firefox OS
 - iOS
 - Windows Phone 7 and 8
-- Windows 8
+- Windows 8 ( read-only support, search requires user interaction, contactFields are ignored, only contactFindOptions.multiple is used )
 
 ### Example
 
     function onSuccess(contacts) {
-        alert('Found ' + navigator.contacts.length + ' navigator.contacts.');
+        alert('Found ' + contacts.length + ' contacts.');
     };
 
     function onError(contactError) {
@@ -257,8 +257,8 @@ for details.
         alert("Error = " + contactError.code);
     };
 
-        // remove the contact from the device
-        contact.remove(onSuccess,onError);
+    // remove the contact from the device
+    contact.remove(onSuccess,onError);
 
 
 ### Android 2.X Quirks
@@ -427,6 +427,10 @@ a `ContactAddress[]` array.
 
 - __formatted__: Currently not supported.
 
+### Windows 8 Quirks
+
+- __pref__: Not supported
+
 
 ## ContactError
 
@@ -515,6 +519,10 @@ string.
 
 - __pref__: Not supported, returning `false`.
 
+### Windows8 Quirks
+
+- __pref__: Not supported, returning `false`.
+
 
 ## ContactName
 
@@ -588,10 +596,25 @@ Contains different kinds of information about a `Contact` object's name.
 
 - __formatted__: Partially supported, and read-only.  Returns a concatenation of `honorificPrefix`, `givenName`, `middleName`, `familyName`, and `honorificSuffix`.
 
+
 ### iOS Quirks
 
 - __formatted__: Partially supported.  Returns iOS Composite Name, but is read-only.
 
+### Windows 8 Quirks
+
+- __formatted__: This is the only name property, and is identical to `displayName`, and `nickname`
+
+- __familyName__: not supported
+
+- __givenName__: not supported
+
+- __middleName__: not supported
+
+- __honorificPrefix__: not supported
+
+- __honorificSuffix__: not supported
+
 
 ## ContactOrganization
 
@@ -619,7 +642,6 @@ properties.  A `Contact` object stores one or more
 - Firefox OS
 - iOS
 - Windows Phone 7 and 8
-- Windows 8
 
 ### Example