You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by an...@apache.org on 2015/12/08 08:14:59 UTC
cordova-plugin-contacts git commit: CB-10053 Documents
ContactFieldType enumeration. This closes #93
Repository: cordova-plugin-contacts
Updated Branches:
refs/heads/master 4bb747fff -> f0314d710
CB-10053 Documents ContactFieldType enumeration. This closes #93
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/f0314d71
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/tree/f0314d71
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/diff/f0314d71
Branch: refs/heads/master
Commit: f0314d710c53ad49a06214a0bb769759c8162fca
Parents: 4bb747f
Author: Vladimir Kotikov <v-...@microsoft.com>
Authored: Mon Nov 30 12:29:50 2015 +0300
Committer: Vladimir Kotikov <v-...@microsoft.com>
Committed: Tue Dec 8 10:14:30 2015 +0300
----------------------------------------------------------------------
README.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts/blob/f0314d71/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b7e8345..2279173 100644
--- a/README.md
+++ b/README.md
@@ -145,6 +145,8 @@ specified in the __contactFields__ parameter. If there's a match for
_any_ of the specified fields, the contact is returned. Use __contactFindOptions.desiredFields__
parameter to control which contact properties must be returned back.
+Supported values for both __contactFields__ and __contactFindOptions.desiredFields__ parameters are enumerated in [`ContactFieldType`](#contactfieldtype) object.
+
### Parameters
- __contactFields__: Contact fields to use as a search qualifier. _(DOMString[])_ [Required]
@@ -791,3 +793,34 @@ properties. A `Contact` object stores one or more
- __pref__: Not supported, returning `false`.
- __type__: Not supported, returning `null`.
+
+## ContactFieldType
+The `ContactFieldType` object is an enumeration of possible field types, such as `'phoneNumbers'` or `'emails'`, that could be used to control which contact properties must be returned back from `contacts.find()` method (see `contactFindOptions.desiredFields`), or to specify fields to search in (through `contactFields` parameter). Possible values are:
+
+- `navigator.contacts.fieldType.addresses`
+- `navigator.contacts.fieldType.birthday`
+- `navigator.contacts.fieldType.categories`
+- `navigator.contacts.fieldType.country`
+- `navigator.contacts.fieldType.department`
+- `navigator.contacts.fieldType.displayName`
+- `navigator.contacts.fieldType.emails`
+- `navigator.contacts.fieldType.familyName`
+- `navigator.contacts.fieldType.formatted`
+- `navigator.contacts.fieldType.givenName`
+- `navigator.contacts.fieldType.honorificPrefix`
+- `navigator.contacts.fieldType.honorificSuffix`
+- `navigator.contacts.fieldType.id`
+- `navigator.contacts.fieldType.ims`
+- `navigator.contacts.fieldType.locality`
+- `navigator.contacts.fieldType.middleName`
+- `navigator.contacts.fieldType.name`
+- `navigator.contacts.fieldType.nickname`
+- `navigator.contacts.fieldType.note`
+- `navigator.contacts.fieldType.organizations`
+- `navigator.contacts.fieldType.phoneNumbers`
+- `navigator.contacts.fieldType.photos`
+- `navigator.contacts.fieldType.postalCode`
+- `navigator.contacts.fieldType.region`
+- `navigator.contacts.fieldType.streetAddress`
+- `navigator.contacts.fieldType.title`
+- `navigator.contacts.fieldType.urls`
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org