[CB-7761] Misleading text in documentation

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Component/s: cordova-plugin-contacts (DEPRECATED)
• Assignee: Shazron Abdullah
• Reporter: Raymond Camden
• Created: 10/Oct/14 11:15
• Updated: 23/Aug/18 07:16
• Resolved: 14/Oct/14 00:40

Description

The docs for contactFields says this:

The contactFields parameter specifies the 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 "*" returns all contact fields.

The last sentence is confusing. You are not "returning" those fields, but searching those fields. What is returned is controlled by desiredFields passed to ptions.