github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-22 01:19:36 +08:00
Code Issues Projects Releases Wiki Activity

docs(contacts): remove old docs

Browse Source 
closes #865
This commit is contained in:
Ibby 2016-12-15 08:07:26 -05:00
parent 9986e0d0b3
commit 28f316e408
1 changed files with 4 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/plugins/contacts.ts
View File

@ -231,9 +231,9 @@ export class ContactOrganization implements IContactOrganization {
export interface IContactFindOptions { export interface IContactFindOptions {
/** The search string used to find navigator.contacts. */ /** The search string used to find navigator.contacts. */
filter?: string; 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; 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[]; desiredFields?: string[];
/** /**
* (Android only): Filters the search to only return contacts with a phone number informed. * (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. * Search for contacts in the Contacts list.
* @param fields {ContactFieldType[]} Contact fields to be used as a search qualifier. * @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. * @param options {IContactFindOptions} Optional options for the query
* 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)
*
* @returns {Promise<Contact[]>} Returns a Promise that resolves with the search results (an array of Contact objects) * @returns {Promise<Contact[]>} Returns a Promise that resolves with the search results (an array of Contact objects)
*/ */
static find(fields: ContactFieldType[], options?: IContactFindOptions): Promise<Contact[]> { static find(fields: ContactFieldType[], options?: IContactFindOptions): Promise<Contact[]> {