canmove, Confirmed users
2,887
edits
WebAPI/ContactsAPI: Difference between revisions
Jump to navigation
Jump to search
→Methodology for inclusion: added questions to ask to help evaluate, more details
(→Considered changes: link to Gaia contacts requirements) |
(→Methodology for inclusion: added questions to ask to help evaluate, more details) |
||
| Line 107: | Line 107: | ||
The ContactsAPI includes properties as needed for the following: | The ContactsAPI includes properties as needed for the following: | ||
What is the Gaia Contacts Requirements priority level? | |||
1. [[Gaia/Contacts|Gaia Contacts App]] UI v1 milestone (must be present on linked wiki page).<br/> | |||
2. [[Gaia/Contacts|Gaia Contacts App]] UI v2 milestone (must be present on linked wiki page). | |||
Meeting one of those criteria is required for inclusion in the ContactsAPI. All other feature requests for the ContactsAPI will be prioritized, considered, and developed as follows: | Meeting one of those criteria is required for inclusion in the ContactsAPI. All other feature requests for the ContactsAPI will be prioritized, considered, and developed as follows: | ||
3. Interoperable properties on other devices (multiple). | |||
* '''If there is more than one implementation, are they interoperable?''' | |||
* Demonstrate that a feature is in the UI of multiple devices by attaching screenshots, and | |||
* Check this by importing the vCards from one device implementation on another device implementation (e.g. by emailing a contact from one device to another) and seeing if the same values are shown in the UI of both devices, both when each is the sender and receiver. Check that the value round-trips without loss of fidelity. | |||
4. More vCard4 features. | |||
* '''Is there an existing vCard feature for the requested feature?''' | |||
* E.g. properties left out from vCard4/hCard(2), why the above is a subset of vCard4/hCard(2). Some common reasons: | |||
** '''NU''' - Not commonly used in practice, either in address books or in publishing on the web. Reconsider such properties if usage changes. | ** '''NU''' - Not commonly used in practice, either in address books or in publishing on the web. Reconsider such properties if usage changes. | ||
** '''ER''' - Error prone whenever entered/published. Such properties are toast. Not getting added. | ** '''ER''' - Error prone whenever entered/published. Such properties are toast. Not getting added. | ||
** '''AB''' - Absent from typical device address books (if you've seen a specific device with such fields in the address book, please list it here as a nested list item, preferably with screenshot of the UI). Reconsider such properties if added to address book UIs, note such research/data accordingly in [[#Considered_changes]] section below. Specific deliberately omitted property notes: | ** '''AB''' - Absent from typical device address books (if you've seen a specific device with such fields in the address book, please list it here as a nested list item, preferably with screenshot of the UI). Reconsider such properties if added to address book UIs, note such research/data accordingly in [[#Considered_changes]] section below. Specific deliberately omitted property notes: | ||
* 'logo' - NU, 'photo' is used instead | |||
* 'post-office-box' - NU, AB | |||
* 'extended-address' - ER. in practice such data typically ends up in a long 'street-address'. | |||
* 'organization-name' and 'organization-unit' are rarely separately specified, users/publishers preferring to use the simple flat 'org' property instead. | |||
Added for B2G db (but not in any known existing device address books): | Added for B2G db (but not in any known existing device address books): | ||
* ContactAddress 'geo' property components 'latitude', 'longitude' and additional 'altitude' from GeoLocation API | |||
* Contact 'gender' property components 'sex', 'gender-identity' (from vCard4/hCard2 in particular) | |||
5. Feature parity with other devices. | |||
* '''Are there any existing shipping device implementations of the feature?''' | |||
* If so, please create a few contacts with various settings for the feature, export the contacts (by email etc.) as vCards, and attach those so we can analyze the current implementation(s). | |||
* One or more devices may support a contacts UI feature that does not exist or interoperate with other devices. Such features may be worthy of consideration if they're deemed essential from a competitive perspective. | |||
6. New stuff. Wish lists (typically from individuals) for what they want in their own super address books. | |||
These priority levels will be used to group/document all ContactsAPI requests. If you think a feature should be considered for a higher priority level, please provide the necessary research demonstrating that it deserves the higher priority level. | These priority levels will be used to group/document all ContactsAPI requests. If you think a feature should be considered for a higher priority level, please provide the necessary research demonstrating that it deserves the higher priority level. | ||