From 28f316e408e5f9600b322af995a5d195d6276245 Mon Sep 17 00:00:00 2001 From: Ibby Date: Thu, 15 Dec 2016 08:07:26 -0500 Subject: [PATCH] docs(contacts): remove old docs closes #865 --- src/plugins/contacts.ts | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/src/plugins/contacts.ts b/src/plugins/contacts.ts index 2501af43d..c19e2aaf8 100644 --- a/src/plugins/contacts.ts +++ b/src/plugins/contacts.ts @@ -231,9 +231,9 @@ export class ContactOrganization implements IContactOrganization { export interface IContactFindOptions { /** The search string used to find navigator.contacts. */ filter?: string; - /** Determines if the find operation returns multiple navigator.contacts. */ + /** Determines if the find operation returns multiple navigator.contacts. Defaults to true. */ multiple?: boolean; - /* Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. */ + /** Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. */ desiredFields?: string[]; /** * (Android only): Filters the search to only return contacts with a phone number informed. @@ -299,16 +299,8 @@ export class Contacts { /** * Search for contacts in the Contacts list. - * @param fields {ContactFieldType[]} Contact fields to be used as a search qualifier. - * A zero-length contactFields parameter is invalid and results in ContactError.INVALID_ARGUMENT_ERROR. - * A contactFields value of "*" searches all contact fields. - * - * @param options {IContactFindOptions} the options to query with: - * filter: The search string used to find navigator.contacts. (string) (Default: "") - * multiple: Determines if the find operation returns multiple navigator.contacts. (Boolean) (Default: false) - * desiredFields: Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. (DOMString[]) [Optional] - * hasPhoneNumber(Android only): Filters the search to only return contacts with a phone number informed. (Boolean) (Default: false) - * + * @param fields {ContactFieldType[]} Contact fields to be used as a search qualifier + * @param options {IContactFindOptions} Optional options for the query * @returns {Promise} Returns a Promise that resolves with the search results (an array of Contact objects) */ static find(fields: ContactFieldType[], options?: IContactFindOptions): Promise {