--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/.htaccess Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+Header add Access-Control-Allow-Origin "*"
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/BlobWriter.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,231 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>
+ Contact Blob Writer
+ </title>
+ <meta
+ http-equiv='Content-Type'
+ content='text/html;charset=utf-8'>
+<script
+ type="text/javascript"
+ src='../ReSpec.js/js/respec.js'
+ class='remove'>
+</script>
+<script
+ type="text/javascript"
+ src='../ReSpec.js/js/sh_main.min.js'
+ class='remove'>
+</script>
+<script
+ type="text/javascript"
+ class='remove'>
+ var respecConfig = {
+ specStatus: "ED",
+ shortName: "contact-blob-writer",
+ editors: [{name: "Richard Tibbett", company: "Opera Software ASA", companyURL: "http://opera.com/"}],
+ //publishDate: "2010-07-01",
+ // previousPublishDate: "2010-01-21",
+ edDraftURI: "http://dev.w3.org/2009/dap/contacts/BlobWriter.html",
+ // lcEnd: "2009-08-05",
+ };
+</script>
+<script
+ type="text/javascript"
+ src='../common/config.js'
+ class='remove'>
+
+</script>
+ </head>
+ <body>
+ <section
+ id='abstract'>
+ <p>
+ The Contact Blob Writer provides an interface for developers to create contact objects from Javascript.
+ </p>
+ <p>
+ Contact objects can then be saved to the user's current device via the APIs and mechanisms defined in [[!FILE-API]] and shown
+ in this specification.
+ </p>
+ <p>
+ This specification is built on top of an accompanying specification [[CONTACTS-API]] that enables read access to a user's
+ unified address book.
+ </p>
+ </section>
+ <section
+ id='sotd'>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed Contact Blob Writer specification.
+ Issues and editors note in the document highlight some of the points on which the group is still working and would particularly like
+ to get feedback.
+ </p>
+ </section>
+ <section
+ id='conformance'>
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn>user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [[!WEBIDL]], as this specification uses that specification and
+ terminology.
+ </p>
+ </section>
+ <section
+ class="informative">
+ <h2>
+ Introduction
+ </h2>
+
+ <p>
+ This specification provides a method for creating objects consisting of standard contact card information such as names, addresses and phone numbers so that
+ these objects may be efficiently stored and saved on a user's device.
+ </p>
+ <p>
+ The interfaces and API defined in this specification have been built on top of [[!FILE-API]]. <a>Contact Blobs</a> can be presented, downloaded
+ and stored on the user's device by creating a <a>Blob URI</a> [[!FILE-API]] from a created <a>Contact Blob</a> object.
+ This <a>Blob URI</a> may be presented to the user or invoked wherever URLs can be used within the web platform.
+ </p>
+ <p>
+ The API is designed so that implementors of this specification are not required to implement a handler for <a title="valid Contact Blob Type">valid Contact Blob Types</a>.
+ The <a title="valid Contact Blob Type">valid Contact Blob Types</a> contained herein have been chosen for their ability to integrate with existing and legacy
+ address book systems while still allowing <a title="user agent">user agents</a> to handle the given media types as required.
+ </p>
+ </section>
+ <section>
+ <h2>Security and Privacy Considerations</h2>
+ <p>
+ This specification builds upon the security and privacy protections provided by the [[HTML5]] and [[!FILE-API]] specifications;
+ in particular, it is expected that any action to download the Contact information that has been created would require a
+ specific user interaction on an HTML element that is entirely controlled by the user agent.
+ </p>
+ </section>
+ <section>
+ <h2>
+ Contact Blob API
+ </h2>
+
+ <section>
+ <h2>
+ Example
+ </h2>
+ <p>
+ The following example illustrates how to create a Contact Blob, create a Blob URI and then a mechanism for saving the Contact object on the host device:
+ </p>
+<pre
+ class='example sh_javascript_dom'>
+<a id="contactcard">Save our business card</a>
+
+<script type="text/javascript">
+ // Define/Get some contact properties:
+ var contact = {
+ displayName: 'Robert',
+ emails: [
+ {
+ value: 'bob@foo.com'
+ }
+ ]
+ // ...
+ };
+
+ // Create a new Contact Blob:
+ var contactBlob = navigator.service.contacts.createContactBlob(contact);
+
+ // Create a Blob URI object:
+ // @see http://www.w3.org/TR/file-upload/#dfn-createObjectURL
+ var contactURL = createObjectURL(contactBlob);
+
+ // e.g. Assign contact URI to anchor element for user-initiated download:
+ document.getElementById('contactcard').href = contactURL;
+</script>
+</pre>
+ </section>
+
+ <section>
+ <h2><a>ContactBlobWriter</a> interface</h2>
+
+ <p>
+ The <a>ContactBlobWriter</a> interface allows users to create a <a>Contact Blob</a>.
+ </p>
+
+ <p>
+ The <a
+ href='#contactblobwriter-interface'><code>ContactBlobWriter</code></a> interface is exposed on the <a class="externalDFN" title="Contacts" href="http://dev.w3.org/2009/dap/contacts/Overview.html#contacts-interface">Contacts</a> object as defined in [[!CONTACTS-API]].
+ </p>
+ <div
+ class='idl'
+ title='Contacts implements ContactBlobWriter'>
+
+ </div>
+ <dl class='idl' title='[NoInterfaceObject] interface ContactBlobWriter'>
+ <dt>
+ Blob createContactBlob()
+ </dt>
+ <dd>
+ Returns a <a>Contact Blob</a> containing the attributes provided and processed according to the <a>rules for converting a Contact object to a Contact Blob</a>.
+ <dl class='parameters'>
+ <dt>
+ Contact attributes
+ </dt>
+ <dd>
+ <a class="externalDFN" title="Contact" href="http://dev.w3.org/2009/dap/contacts/Overview.html#contact-interface">Contact</a> [[!CONTACTS-API]] properties to assign to the resulting <a>Contact Blob</a> object.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section>
+ <h2>Contact Blobs</h2>
+
+ <p>
+ A <dfn>Contact Blob</dfn> is a <a class="externalDFN" title="Blob" href="http://www.w3.org/TR/file-upload/#blob">Blob</a> object [[!FILE-API]] with a <a class="externalDFN" title="Blob_type" href="http://www.w3.org/TR/file-upload/#dfn-type"><var>type</var></a> attribute that
+ matches one of the given <a title="valid Contact Blob Type">valid Contact Blob Types</a>.
+ </p>
+
+ <p>
+ A <dfn>valid Contact Blob Type</dfn> MUST be one of the following media types:
+ </p>
+
+ <ul>
+ <li><code>text/x-vcard</code></li>
+ <li><code>text/directory</code></li>
+ <li><code>text/directory;profile=vCard</code></li>
+ </ul>
+
+ <p>
+ ...
+ </p>
+
+ <p class="issue">
+ Define <a class="externalDFN" title="Fragment Idenfifier" href="http://www.w3.org/TR/file-upload/#fragmentIdentifier">fragment identifiers</a> [[!FILE-API]] for this media type(?)
+ </p>
+
+ <p>
+ ...
+ </p>
+
+ </section>
+ <section>
+ <h2>Converting a <code>Contact</code> object to a Contact Blob</h2>
+
+ <p>
+ The <dfn>rules for converting a Contact object to a Contact Blob</dfn> are defined as follows:
+ </p>
+
+ <p class="note">
+ To be written.
+ </p>
+
+ <p class="note">
+ Include mappings of <a class="externalDFN" title="Contact" href="http://dev.w3.org/2009/dap/contacts/Overview.html#contact-interface">Contact</a> object attributes to <a>Contact Blob</a> attributes.
+ </p>
+
+ <p class="note">
+ Include the special rule for assigning the <a class="externalDFN" href="http://dev.w3.org/2009/dap/contacts/Overview.html#widl-Contact-id">Contact.id</a> (if provided) to the X-ABUID attribute of the resulting <a>Contact Blob</a>.
+ </p>
+
+ </section>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/FPWD.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1344 @@
+<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
+<html lang="en" dir="ltr">
+<head>
+
+
+ <title>The Contacts API</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+
+
+
+
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec CSS
+ * Robin Berjon <robin at berjon dot com>
+ * v0.05 - 2009-07-31
+ *****************************************************************/
+
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: medium solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: medium dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- WEB IDL --- */
+pre.idl {
+ border-top: 1px solid #90b8de;
+ border-bottom: 1px solid #90b8de;
+ padding: 1em;
+ line-height: 120%;
+}
+
+pre.idl::before {
+ content: "WebIDL";
+ display: block;
+ width: 150px;
+ background: #90b8de;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+.idlType {
+ color: #ff4500;
+ font-weight: bold;
+ text-decoration: none;
+}
+
+/*.idlModule*/
+/*.idlModuleID*/
+/*.idlInterface*/
+.idlInterfaceID {
+ font-weight: bold;
+ color: #005a9c;
+}
+
+.idlSuperclass {
+ font-style: italic;
+ color: #005a9c;
+}
+
+/*.idlAttribute*/
+.idlAttrType {
+ color: #005a9c;
+}
+.idlAttrName {
+ color: #ff4500;
+}
+.idlAttrName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlMethod*/
+.idlMethType {
+ color: #005a9c;
+}
+.idlMethName {
+ color: #ff4500;
+}
+.idlMethName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlParam*/
+.idlParamType {
+ color: #005a9c;
+}
+.idlParamName {
+ font-style: italic;
+}
+
+.extAttr {
+ color: #666;
+}
+
+/*.idlConst*/
+.idlConstType {
+ color: #005a9c;
+}
+.idlConstName {
+ color: #ff4500;
+}
+.idlConstName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlException*/
+.idlExceptionID {
+ font-weight: bold;
+ color: #c00;
+}
+
+.idlTypedefID, .idlTypedefType {
+ color: #005a9c;
+}
+
+.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
+ color: #c00;
+ font-weight: normal;
+}
+
+.excName a {
+ font-family: monospace;
+}
+
+.idlRaises a.idlType, .excName a.idlType {
+ border-bottom: 1px dotted #c00;
+}
+
+.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
+ width: 45px;
+ text-align: center;
+}
+.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
+.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
+
+.idlImplements a {
+ font-weight: bold;
+}
+
+dl.attributes, dl.methods, dl.constants {
+ margin-left: 2em;
+}
+
+.attributes dt, .methods dt, .constants dt {
+ font-weight: normal;
+}
+
+.attributes dt code, .methods dt code, .constants dt code {
+ font-weight: bold;
+ color: #000;
+ font-family: monospace;
+}
+
+.attributes dt code {
+ background: #ffffd2;
+}
+
+.attributes dt .idlAttrType code {
+ color: #005a9c;
+ background: transparent;
+ font-family: inherit;
+ font-weight: normal;
+ font-style: italic;
+}
+
+.methods dt code {
+ background: #d9e6f8;
+}
+
+.constants dt code {
+ background: #ddffd2;
+}
+
+.attributes dd, .methods dd, .constants dd {
+ margin-bottom: 1em;
+}
+
+table.parameters, table.exceptions {
+ border-spacing: 0;
+ border-collapse: collapse;
+ margin: 0.5em 0;
+ width: 100%;
+}
+table.parameters { border-bottom: 1px solid #90b8de; }
+table.exceptions { border-bottom: 1px solid #deb890; }
+
+.parameters th, .exceptions th {
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+ font-family: initial;
+ font-weight: normal;
+ text-shadow: #666 1px 1px 0;
+}
+.parameters th { background: #90b8de; }
+.exceptions th { background: #deb890; }
+
+.parameters td, .exceptions td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+ vertical-align: top;
+}
+
+.parameters tr:first-child td, .exceptions tr:first-child td {
+ border-top: none;
+}
+
+.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
+ width: 100px;
+}
+
+.parameters td.prmType {
+ width: 120px;
+}
+
+table.exceptions table {
+ border-spacing: 0;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+/* --- TOC --- */
+.toc a {
+ text-decoration: none;
+}
+
+a .secno {
+ color: #000;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+
+/* --- EXAMPLES --- */
+pre.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ padding: 1em;
+ margin-top: 1em;
+}
+
+pre.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* --- EDITORIAL NOTES --- */
+.issue {
+ padding: 1em;
+ border: 1px solid #f00;
+ background: #ffc;
+}
+
+.issue::before {
+ content: "Issue";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #f00;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+.note {
+ padding: 1em;
+ border: 2px solid #cff6d9;
+ background: #e2fff0;
+}
+
+.note::before {
+ content: "Note";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #cff6d9;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+/* --- SYNTAX HIGHLIGHTING --- */
+pre.sh_sourceCode {
+ background-color: white;
+ color: black;
+ font-style: normal;
+ font-weight: normal;
+}
+
+pre.sh_sourceCode .sh_keyword { color: #005a9c; font-weight: bold; } /* language keywords */
+pre.sh_sourceCode .sh_type { color: #666; } /* basic types */
+pre.sh_sourceCode .sh_usertype { color: teal; } /* user defined types */
+pre.sh_sourceCode .sh_string { color: red; font-family: monospace; } /* strings and chars */
+pre.sh_sourceCode .sh_regexp { color: orange; font-family: monospace; } /* regular expressions */
+pre.sh_sourceCode .sh_specialchar { color: #ffc0cb; font-family: monospace; } /* e.g., \n, \t, \\ */
+pre.sh_sourceCode .sh_comment { color: #A52A2A; font-style: italic; } /* comments */
+pre.sh_sourceCode .sh_number { color: purple; } /* literal numbers */
+pre.sh_sourceCode .sh_preproc { color: #00008B; font-weight: bold; } /* e.g., #include, import */
+pre.sh_sourceCode .sh_symbol { color: blue; } /* e.g., <, >, + */
+pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */
+pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */
+pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: #00FFFF; } /* TODO and FIXME */
+
+/* Predefined variables and functions (for instance glsl) */
+pre.sh_sourceCode .sh_predef_var { color: #00008B; }
+pre.sh_sourceCode .sh_predef_func { color: #00008B; font-weight: bold; }
+
+/* for OOP */
+pre.sh_sourceCode .sh_classname { color: teal; }
+
+/* line numbers (not yet implemented) */
+pre.sh_sourceCode .sh_linenum { display: none; }
+
+/* Internet related */
+pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; }
+
+/* for ChangeLog and Log files */
+pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; }
+pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: #00008B; font-weight: bold; }
+pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: #006400; }
+
+/* for Prolog, Perl... */
+pre.sh_sourceCode .sh_variable { color: #006400; }
+
+/* for LaTeX */
+pre.sh_sourceCode .sh_italics { color: #006400; font-style: italic; }
+pre.sh_sourceCode .sh_bold { color: #006400; font-weight: bold; }
+pre.sh_sourceCode .sh_underline { color: #006400; text-decoration: underline; }
+pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; }
+pre.sh_sourceCode .sh_argument { color: #006400; }
+pre.sh_sourceCode .sh_optionalargument { color: purple; }
+pre.sh_sourceCode .sh_math { color: orange; }
+pre.sh_sourceCode .sh_bibtex { color: blue; }
+
+/* for diffs */
+pre.sh_sourceCode .sh_oldfile { color: orange; }
+pre.sh_sourceCode .sh_newfile { color: #006400; }
+pre.sh_sourceCode .sh_difflines { color: blue; }
+
+/* for css */
+pre.sh_sourceCode .sh_selector { color: purple; }
+pre.sh_sourceCode .sh_property { color: blue; }
+pre.sh_sourceCode .sh_value { color: #006400; font-style: italic; }
+
+/* other */
+pre.sh_sourceCode .sh_section { color: black; font-weight: bold; }
+pre.sh_sourceCode .sh_paren { color: red; }
+pre.sh_sourceCode .sh_attribute { color: #006400; }
+
+</style><link charset="utf-8" type="text/css" rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"></head><body style="display: inherit;"><div class="head"><p><a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a></p><h1>The Contacts API</h1><h2><acronym title="World Wide Web Consortium">W3C</acronym> Working Draft 21 January 2010</h2><dl><dt>This Version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100121/">http://www.w3.org/TR/2010/WD-contacts-api-20100121/</a></dd><dt>Latest Published Version:</dt><dd><a href="http://www.w3.org/TR/contacts-api/">http://www.w3.org/TR/contacts-api/</a></dd><dt>Latest Editor's Draft:</dt><dd><a href="http://dev.w3.org/2009/dap/contacts/">http://dev.w3.org/2009/dap/contacts/</a></dd><dt>Editor:</dt><dd>Richard Tibbett, France Telecom</dd></dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2010 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium"><acronym title="World Wide Web Consortium">W3C</acronym></acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology"><acronym title="Massachusetts Institute of Technology">MIT</acronym></acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. <acronym title="World Wide Web Consortium">W3C</acronym> <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p><hr></div>
+ <div class="introductory section" id="abstract"><h2>Abstract</h2>
+ <p>This specification defines an API that provides access to a user's unified address book.</p>
+ </div><div id="sotd" class="introductory section"><h2>Status of This Document</h2><p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current <acronym title="World Wide Web Consortium">W3C</acronym> publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/"><acronym title="World Wide Web Consortium">W3C</acronym> technical reports index</a> at http://www.w3.org/TR/.</em></p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the
+ proposed Contacts API. Issues and editors note in the document highlight some of the points
+ on which the group is still working and would particularly like to get feedback.
+ </p>
+ <p>This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a First Public Working Draft. This document is intended to become a <acronym title="World Wide Web Consortium">W3C</acronym> Recommendation. If you wish to make comments regarding this document, please send them to <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). All feedback is welcome.</p><p>Publication as a Working Draft does not imply endorsement by the <acronym title="World Wide Web Consortium">W3C</acronym> Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p><p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 <acronym title="World Wide Web Consortium">W3C</acronym> Patent Policy</a>. <acronym title="World Wide Web Consortium">W3C</acronym> maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the <acronym title="World Wide Web Consortium">W3C</acronym> Patent Policy</a>.</p></div><div class="section" id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li><a href="#conformance"><span class="secno">1. </span>Conformance</a></li><li><a href="#introduction"><span class="secno">2. </span>Introduction</a></li><li><ul class="toc"><li><a href="#usage-examples"><span class="secno">2.1 </span>Usage Examples</a></li></ul></li><li><a href="#security-and-privacy-considerations"><span class="secno">3. </span>Security and Privacy Considerations</a></li><li><ul class="toc"><li><a href="#privacy-considerations-for-implementors-of-the-contacts-api"><span class="secno">3.1 </span>Privacy considerations for implementors of the Contacts API</a></li><li><a href="#privacy-considerations-for-recipients-of-contact-information"><span class="secno">3.2 </span>Privacy considerations for recipients of contact information</a></li><li><a href="#additional-implementation-considerations"><span class="secno">3.3 </span>Additional implementation considerations</a></li></ul></li><li><a href="#api-description"><span class="secno">4. </span>API Description</a></li><li><ul class="toc"><li><a href="#servicecontacts-interface"><span class="secno">4.1 </span><span class="idlType formerLink idlType"><code>ServiceContacts</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes"><span class="secno">4.1.1 </span>Attributes</a></li></ul></li><li><a href="#contacts-interface"><span class="secno">4.2 </span><span class="idlType formerLink idlType"><code>Contacts</code></span> interface</a></li><li><ul class="toc"><li><a href="#methods"><span class="secno">4.2.1 </span>Methods</a></li></ul></li><li><a href="#contact-interface"><span class="secno">4.3 </span><span class="idlType formerLink idlType"><code>Contact</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-1"><span class="secno">4.3.1 </span>Attributes</a></li><li><a href="#methods-1"><span class="secno">4.3.2 </span>Methods</a></li></ul></li><li><a href="#contactproperties-interface"><span class="secno">4.4 </span><span class="idlType formerLink idlType"><code>ContactProperties</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-2"><span class="secno">4.4.1 </span>Attributes</a></li></ul></li><li><a href="#contactfield-interface"><span class="secno">4.5 </span><span class="idlType formerLink idlType"><code>ContactField</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-3"><span class="secno">4.5.1 </span>Attributes</a></li></ul></li><li><a href="#contactaddress-interface"><span class="secno">4.6 </span><span class="idlType formerLink idlType"><code>ContactAddress</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-4"><span class="secno">4.6.1 </span>Attributes</a></li></ul></li><li><a href="#contactoptions-interface"><span class="secno">4.7 </span><span class="idlType formerLink idlType"><code>ContactOptions</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-5"><span class="secno">4.7.1 </span>Attributes</a></li></ul></li><li><a href="#contactfindsuccesscb-interface"><span class="secno">4.8 </span><span class="idlType formerLink idlType"><code>ContactFindSuccessCB</code></span> interface</a></li><li><ul class="toc"><li><a href="#methods-2"><span class="secno">4.8.1 </span>Methods</a></li></ul></li><li><a href="#contactsuccesscb-interface"><span class="secno">4.9 </span><span class="idlType formerLink idlType"><code>ContactSuccessCB</code></span> interface</a></li><li><ul class="toc"><li><a href="#methods-3"><span class="secno">4.9.1 </span>Methods</a></li></ul></li><li><a href="#contacterrorcb-interface"><span class="secno">4.10 </span><span class="idlType formerLink idlType"><code>ContactErrorCB</code></span> interface</a></li><li><ul class="toc"><li><a href="#methods-4"><span class="secno">4.10.1 </span>Methods</a></li></ul></li><li><a href="#contacterror-interface"><span class="secno">4.11 </span><span class="idlType formerLink idlType"><code>ContactError</code></span> interface</a></li><li><ul class="toc"><li><a href="#constants"><span class="secno">4.11.1 </span>Constants</a></li></ul></li></ul></li><li><a href="#general-api-support"><span class="secno">5. </span>General API Support</a></li><li><ul class="toc"><li><a href="#genericerror-interface"><span class="secno">5.1 </span><span class="idlType formerLink idlType"><code>GenericError</code></span> interface</a></li><li><ul class="toc"><li><a href="#attributes-6"><span class="secno">5.1.1 </span>Attributes</a></li><li><a href="#constants-1"><span class="secno">5.1.2 </span>Constants</a></li></ul></li></ul></li><li><a href="#contact-search-processing-rules"><span class="secno">6. </span><span class="formerLink">Contact Search Processing Rules</span></a></li><li><a href="#use-cases-and-requirements"><span class="secno">7. </span>Use Cases and Requirements</a></li><li><ul class="toc"><li><a href="#use-cases"><span class="secno">7.1 </span>Use Cases</a></li><li><a href="#requirements"><span class="secno">7.2 </span>Requirements</a></li></ul></li><li><a href="#features-for-future-consideration"><span class="secno">A. </span>Features for Future Consideration</a></li><li><a href="#acknowledgements"><span class="secno">B. </span>Acknowledgements</a></li><li><a href="#references"><span class="secno">C. </span>References</a></li><li><ul class="toc"><li><a href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li><a href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></div>
+
+ <div class="section" id="conformance"><h2><span class="secno">1. </span>Conformance</h2><p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
+<p>The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>, and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<a href="#bib-RFC2119" rel="biblioentry" class="bibref">RFC2119</a>].</p>
+
+ <p>
+ This specification defines conformance criteria that apply to a single product: the
+ <dfn id="dfn-user-agent">
+ user agent
+ </dfn>
+ that implements the interfaces that it contains.
+ </p>
+ </div>
+ <div id="introduction" class="informative section">
+ <h2><span class="secno">2. </span>Introduction</h2><p><em>This section is non-normative.</em></p>
+ <p>
+ The Contacts API defines a high-level interface to provide access to the user's unified contact information, such as names,
+ addresses and other contact information.
+ </p>
+ <p>
+ The API itself is agnostic of any underlying address book sources and data formats.
+ </p>
+ <div class="section" id="usage-examples">
+ <h3><span class="secno">2.1 </span>Usage Examples</h3>
+ <p>
+ The following code extracts illustrate how to search, add, remove and update contact information in a given address book:
+ </p>
+ <div>
+ <p>
+ Searching for matching contacts.
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_comment">// for (var i in contacts) alert(contacts[i].name);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_comment">// alert(error.code);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">(</span> <span class="sh_cbracket">{</span><span class="sh_predef_var">name</span><span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB <span class="sh_symbol">);</span></pre>
+ </div>
+ <div>
+ <p>
+ Creating a new contact.
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_comment">// Create new contact </span>
+<span class="sh_keyword">var</span> myContact <span class="sh_symbol">=</span> <span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">create</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span><span class="sh_predef_var">name</span><span class="sh_symbol">:</span> <span class="sh_string">'Mr. Robert Smith Jr'</span><span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+
+<span class="sh_comment">// Add additional contact attributes as required...</span>
+<span class="sh_comment">// myContact.nicknames.push('bobby');</span></pre>
+ </div>
+ <div>
+ <p>
+ Adding a new contact.
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">successContactCallback</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact object</span>
+ <span class="sh_comment">// alert(contact.name);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Add new contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">save</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ </div>
+
+ <div>
+ <p>
+ Editing an existing contact.
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_comment">// e.g. add a new phone number</span>
+myContact<span class="sh_symbol">.</span>phones<span class="sh_symbol">.</span><span class="sh_function">push</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'home'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span> <span class="sh_string">'+440000000002'</span><span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+
+<span class="sh_comment">// Update existing contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">save</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ </div>
+
+ <div>
+ <p>
+ Removing an existing contact.
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_comment">// Remove existing contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">remove</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ </div>
+
+
+ </div>
+
+ </div>
+ <div class="section" id="security-and-privacy-considerations">
+ <h2><span class="secno">3. </span>Security and Privacy Considerations</h2>
+
+ <p class="note">
+ <strong>This section is under development.</strong>
+
+ <br><br>This section has been inspired (verbatim where necessary) from the <a href="http://www.w3.org/2008/geolocation/">Geolocation WG</a> <a href="http://www.w3.org/TR/2009/WD-geolocation-API-20090707/">latest public working draft specification</a>.
+
+ <br><br>There are a number of reasons for this approach:
+
+ <br><br>1. The programmatic styles of the Contacts API and Geolocation API are very similar and because they both have the the same implied user experience within
+ the same implied User Agent the general security and privacy considerations of both APIs should remain common.
+
+ <br><br>2. The ability to align the security and privacy considerations of the Geolocation API with DAP APIs is important for the potential future benefit
+ of making any security and privacy mechanisms developed within the DAP WG applicable to the Geolocation API at some point in its own ongoing development.
+ </p>
+
+ <p>
+ The API defined in this specification can be used to create, retrieve, update and remove contact information from a
+ user's address books. All API methods disclose information related to a user's contacts such as their phone number(s),
+ email address(es) and other personally identifying information. The distribution of this information could potentially
+ compromise the user's privacy. A conforming implementation of this specification <em title="must" class="rfc2119">must</em> provide a mechanism that protects
+ the user's privacy and this mechanism should ensure that no contact information is creatable, retrivable, updateable or
+ removable without the user's express permission.
+ </p>
+
+ <div class="section" id="privacy-considerations-for-implementors-of-the-contacts-api">
+ <h3><span class="secno">3.1 </span>Privacy considerations for implementors of the Contacts API</h3>
+
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must not create, retrieve, update or delete contact information to Web sites without the express permission
+ of the user. A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must acquire permission through a user interface, unless they have prearranged trust
+ relationships with users, as described below. The user interface must include the URI of the document origin, as defined in [<a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a>].
+ Those permissions that are acquired through the user interface and that are preserved beyond the
+ current browsing session (i.e. beyond the time when the browsing context, as defined in [<a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a>], is navigated to another URL)
+ <em title="must" class="rfc2119">must</em> be revocable and a <a class="internalDFN" href="#dfn-user-agent">user agent</a> must respect revoked permissions.
+ </p>
+
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted permission for the same
+ Web site to access other methods provided by this API, or to access the same method with a different set of arguments, as part of the same permission context. If a user has expressed
+ permission for an implementation to, e.g. find a set of existing contacts, the implementation must seek the user's express
+ permission if and when any additional create, find, update or remove function is called on this API.
+ </p>
+
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> may have prearranged trust relationships that do not require such user interfaces. For example,
+ while a Web browser will present a user interface when a Web site performs an address book request, a Widget Runtime
+ <em title="may" class="rfc2119">may</em> have a prearranged, delegated security relationship with the user and, as such, a suitable alternative security
+ and privacy mechanism with which to authorize the creation, retrieval, update and/or removal of contact information.
+ </p>
+ </div>
+
+ <div class="section" id="privacy-considerations-for-recipients-of-contact-information">
+ <h3><span class="secno">3.2 </span>Privacy considerations for recipients of contact information</h3>
+
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> only request contact information when necessary. Recipients <em title="must" class="rfc2119">must</em> only use the contact information for
+ the task for which it was provided to them. Recipients <em title="must" class="rfc2119">must</em> dispose of contact information once that task is completed,
+ unless expressly permitted to retain it by the user. Recipients <em title="must" class="rfc2119">must</em> also take measures to protect this information
+ against unauthorized access. If contact information is stored, users should be allowed to update and delete this
+ information.
+ </p>
+
+ <p>
+ The recipient of contact information <em title="must" class="rfc2119">must</em> not retransmit the contact information without the user’s express permission.
+ Care should be taken when retransmitting and use of encryption is encouraged.
+ </p>
+
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> clearly and conspicuously disclose the fact that they are collecting contact data, the purpose for the
+ collection, how long the data is retained, how the data is secured, how the data is shared if it is shared, how users
+ can access, update and delete the data, and any other choices that users have with respect to the data. This disclosure
+ <em title="must" class="rfc2119">must</em> include an explanation of any exceptions to the guidelines listed above.
+ </p>
+ </div>
+
+ <div id="additional-implementation-considerations" class="informative section">
+ <h3><span class="secno">3.3 </span>Additional implementation considerations</h3><p><em>This section is non-normative.</em></p>
+
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are also advised to consider
+ the following aspects that can negatively affect the privacy of their users: in certain cases, users can inadvertently
+ grant permission to the User Agent to disclose their contacts to Web sites. In other cases, the content hosted at a certain
+ URL changes in such a way that the previously granted contact permissions no longer apply as far as the user is concerned.
+ Or the users might simply change their minds.
+ </p>
+
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive measures are an
+ implementation responsibility and not prescribed by this specification. However, in designing these measures, implementers
+ are advised to enable user awareness of contact sharing, and to provide easy access to interfaces that enable revocation of
+ permissions.
+ </p>
+ </div>
+
+ </div>
+ <div class="section" id="api-description">
+ <h2><span class="secno">4. </span>API Description</h2>
+ <div class="section" id="servicecontacts-interface">
+ <h3><span class="secno">4.1 </span><a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface</h3>
+
+<p class="issue">The actual object of which the API will be hanging off is still under discussion (e.g. <code>navigator.service</code> vs from <code>navigator.device</code>); see <a href="http://www.w3.org/2009/dap/track/issues/67">ISSUE-67</a></p>
+
+ <p>
+ The <a href="#servicecontacts-interface"><code>ServiceContacts</code></a> interface is exposed on the <code>navigator.service</code> object, as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>].
+ </p>
+
+ <pre class="idl"><span class="idlImplements"><a>Service</a> implements <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a>;</span></pre><div class="idlImplementsDesc"><p>All instances of the <code><a>Service</a></code> type are defined to also implement the <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface.</p></div>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ServiceContacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ServiceContacts</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span> <span class="idlAttrName"><a href="#widl-ServiceContacts-contacts">contacts</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes"><h4><span class="secno">4.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ServiceContacts-contacts"><code>contacts</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span>, readonly</dt><dd>
+ The root node from which the contacts functionality can be accessed.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+
+ </div>
+
+
+ <div class="section" id="contacts-interface">
+ <h3><span class="secno">4.2 </span><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface</h3>
+
+ <p>
+ The <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface exposes a database collecting contacts information, such that they may be created, found,
+ read, updated, and deleted.
+ </p>
+
+ <p>
+ Multiple address books, taken
+ from different sources, can be represented within this unified address book interface. Contacts from different sources can be distinguished using the <a href="#widl-ContactProperties-serviceId"><code>serviceId</code></a> field.. In addition, multiple address books can be displayed by filtering
+ on the required <a href="#widl-ContactProperties-serviceId"><code>serviceId</code></a> value via the <code>Contacts</code> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+
+ <p>
+ Equally, multiple contact groups can be represented within this unified address book by specifying a consistent <a href="#widl-ContactProperties-categories"><code>categories</code></a>
+ value(s) as part of individual <a href="#contact-interface"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering
+ on the required <a href="#widl-ContactProperties-categories"><code>categories</code></a> value(s) via the <code>Contacts</code> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contacts</span> {
+<span class="idlMethod"> <span class="idlMethType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlMethName"><a href="#widl-Contacts-create">create</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></span> <span class="idlParamName">attributes</span></span>);</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contacts-find">find</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></span> <span class="idlParamName">filter</span></span>, <span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactOptions"><code>ContactOptions</code></a></span> <span class="idlParamName">options</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods"><h4><span class="secno">4.2.1 </span>Methods</h4><dl class="methods"><dt id="widl-Contacts-create"><code>create</code></dt><dd>
+ Create a new <code>Contact</code> object.
+
+ <p>This method takes one argument. When called, it returns
+ a <a href="#contact=interface"><code>Contact</code></a> object.</p>
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">attributes</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The attributes to assign to the resulting object.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></div></dd><dt id="widl-Contacts-find"><code>find</code></dt><dd>
+ <p>Find contacts in the address book based on a <a href="#contactproperties-interface"><code>ContactProperties</code></a> object acting as a filter.</p>
+
+ <p>This method takes two, three or four arguments. When called, it immediately returns
+ a <code>PendingOp</code> object , as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-find-contacts-process">find contacts process</dfn> defined as follows:</p>
+
+ <p>
+ </p><ol>
+ <li>Search for contacts in the address book according to the <a href="#contact-search-processing-rules">contact search processing rules</a>.</li>
+ <li>If successful, invoke the associated <code>successCB</code>.
+ If the attempt fails, and the method was invoked with a non-<code>null</code> <code>errorCB</code> argument, this method must
+ invoke the <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.</li>
+ </ol>
+
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">filter</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The filter used in order to select which contacts are returned.
+ </td></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr><tr><td class="prmName">options</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactOptions"><code>ContactOptions</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ The options to apply to the output of this method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd></dl></div>
+
+ </div>
+
+ <div class="section" id="contact-interface">
+ <h3><span class="secno">4.3 </span><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface</h3>
+
+ <p>The <a href="#contact-interface"><code>Contact</code></a> interface captures a single contact item. This interface extends <a href="#contactproperties-interface"><code>ContactProperties</code></a> attributes.</p>
+
+ <p>All <a href="#contact-interface"><code>Contact</code></a> objects <em title="must" class="rfc2119">must</em> include all attributes supported by the implementation, regardless of whether these attributes have been assigned a non-<code>null</code> value or a <code>null</code> value. If a supported attribute
+ has not been assigned a value by the user and/or implementation, then this attribute <em title="must" class="rfc2119">must</em> still be present in the resulting <a href="#contact-interface"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.</p>
+
+ <p>Each resulting <a href="#contact-interface"><code>Contact</code></a> object <em title="must" class="rfc2119">must</em> include a non-<code>null</code> <a href="#widl-ContactProperties-name"><code>name</code></a> attribute.
+ All other attributes <em title="may" class="rfc2119">may</em> be optionally assigned a value by the user and/or implementation.</p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contact">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contact</span> : <span class="idlSuperclass"><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-id">id</a></span>;</span>
+<span class="idlMethod"> <span class="idlMethType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlMethName"><a href="#widl-Contact-clone">clone</a></span> ();</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contact-save">save</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>);</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contact-remove">remove</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>);</span>
+};</span>
+</pre><div class="section" id="attributes-1"><h4><span class="secno">4.3.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-Contact-id"><code>id</code> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly</dt><dd>
+ <p class="note">
+ Perhaps we don't want to recommend the use of <abbr title="Universally Unique IDentifier">UUID</abbr> URN here. Saying that id must be globally unique could suffice, and there may be good reasons why someone would want to use something else (e.g. a SHA mailbox as in FOAF).
+ </p>
+ <p>A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> referenced from <code>Contacts</code> <em title="must" class="rfc2119">must</em> include a non-empty <code>id</code> value.</p>
+ <p>An implementation <em title="must" class="rfc2119">must</em> maintain this globally unique resource identifier when a Contact is added to, or present within, an Address Book.</p>
+ <p>An implementation <em title="may" class="rfc2119">may</em> use an IANA registered identifier format. The value can also be a non-standard format.</p>
+ <p>It is <em title="recommended" class="rfc2119">recommended</em> that an implementation assign the id attribute as a <abbr title="Universally Unique IDentifier"><abbr title="Universally Unique IDentifier">UUID</abbr></abbr> URN as defined in [<a href="#bib-RFC4122" rel="biblioentry" class="bibref">RFC4122</a>].</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>id<span class="sh_symbol">:</span> <span class="sh_string">'urn:uuid:d13d4fd0-4ce9-1cef-b1f2-10a9c1446bf0'</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="methods-1"><h4><span class="secno">4.3.2 </span>Methods</h4><dl class="methods"><dt id="widl-Contact-clone"><code>clone</code></dt><dd>
+ <p>Create a deep clone copy of the current object minus the current object's <a href="#widl-Contact-id"><code>id</code></a> attribute.</p>
+
+ <p>The resulting object <em title="must" class="rfc2119">must</em> be provided with a newly generated <a href="#widl-Contact-id"><code>id</code></a> attribute to distiguish the cloned object from the original object.</p>
+ <div><em>No parameters.</em></div><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></div></dd><dt id="widl-Contact-remove"><code>remove</code></dt><dd>
+ <p>Remove the current contact from the address book.</p>
+
+ <p>
+ In the case that the current <a href="#widl-Contact-id"><code>id</code></a> attribute is <code>NULL</code> and this method is invoked, a <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> <em title="must" class="rfc2119">must</em> be
+ triggered as part of the <a class="internalDFN" href="#dfn-remove-contact-process">remove contact process</a>. This error <em title="must" class="rfc2119">must</em> consist of a <a href="#contacterror-interface"><code>ContactError</code></a> object with a <a href="#widl-ContactError-code"><code>code</code></a> of
+ <a href="#widl-ContactError-CONTACT_NOT_FOUND_ERROR"><code>ContactError::CONTACT_NOT_FOUND_ERROR</code></a>.
+ </p>
+
+
+ <p>This method takes one or two arguments. When called, it immediately returns
+ a <code>PendingOp</code> object , as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-remove-contact-process">remove contact process</dfn> defined as follows:</p>
+
+ <p>
+ </p><ol>
+ <li>Remove the current object from <a href="#contacts-interface"><code>Contacts</code></a>.</li>
+ <li>If successful, invoke the associated
+ <code>successCB</code>. If the attempt fails, and the method was
+ invoked with a non-<code>null</code> <code>errorCB</code> argument, this method must invoke the
+ <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.</li>
+ </ol>
+
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd><dt id="widl-Contact-save"><code>save</code></dt><dd>
+ <p>Add or update (as appropriate) the current <a href="#contact-interface"><code>Contact</code></a> object to the <a href="#contacts-interface"><code>Contacts</code></a>.</p>
+
+ <p>
+ In the case that the <a href="#widl-ContactProperties-name"><code>name</code></a> attribute is <code>null</code> and this method is invoked, an <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> <em title="must" class="rfc2119">must</em> be
+ triggered as part of the <a class="internalDFN" href="#dfn-save-contact-process">save contact process</a>. This error <em title="must" class="rfc2119">must</em> consist of a <a href="#contacterror-interface"><code>ContactError</code></a> object with a <a href="#widl-ContactError-code"><code>code</code></a> of
+ <a href="#widl-ContactError-CONTACT_INVALID_ERROR"><code>ContactError::CONTACT_INVALID_ERROR</code></a>.
+ </p>
+
+ <p>This method takes one or two arguments. When called, it immediately returns
+ a <code>PendingOp</code> object , as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-save-contact-process">save contact process</dfn> defined as follows:</p>
+
+ <p>
+ </p><ol>
+ <li>If the <a href="#widl-Contact-id"><code>Contact.id</code></a> already exists in <a href="#contacts-interface"><code>Contacts</code></a> then update the existing object in <a href="#contacts-interface"><code>Contacts</code></a>.</li>
+ <li>If a current <a href="#widl-Contact-id"><code>Contact.id</code></a> value does not current exist in <a href="#contacts-interface"><code>Contacts</code></a> or the current <a href="#widl-Contact-id"><code>Contact.id</code></a> value has not been set, add the current object as a new object to <a href="#contacts-interface"><code>Contacts</code></a>.</li>
+ <li>If successful, invoke the associated
+ <code>successCB</code>. If the attempt fails, and the method was
+ invoked with a non-<code>null</code> <code>errorCB</code> argument, this method must invoke the
+ <code>errorCB</code> with a <a href="#contacterror-interface">ContactError</a> object as an argument.</li>
+ </ol>
+
+
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactproperties-interface">
+ <h3><span class="secno">4.4 </span><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a> interface</h3>
+ <p>
+ The <a href="#contactproperties-interface"><code>ContactProperties</code></a>
+ interface captures the settable properties of a contact.
+ </p>
+ <a href="#contactproperties-interface"><code>ContactProperties</code></a> is used as part of the <a href="#contact-interface"><code>Contact</code></a> object. <a href="#contactproperties-interface"><code>ContactProperties</code></a> can also be used as the basis of the <a href="#widl-Contacts-find"><code>Contacts.find()</code></a> searches within the address book.
+
+ <p>Attributes of the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface that expect a singular value have singular spelling (e.g. <a href="#widl-ContactProperties-name"><code>name</code></a>) and attributes that may have one or more values have plural spelling (e.g. <a href="#widl-ContactProperties-phones"><code>phones</code></a>) to make the distinction of these fields easier.</p>
+ <p>
+ When <a href="#contactproperties-interface"><code>ContactProperties</code></a> is used as an input parameter to <a href="#widl-Contacts-find"><code>Contacts.find()</code></a> methods, fields that are set to
+ <code>
+ null
+ </code>
+ are considered to match anything.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactProperties">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactProperties</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactProperties-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-nicknames">nicknames</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-phones">phones</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-emails">emails</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-addresses">addresses</a></span>;</span>
+<span class="idlAttribute"> [<span class="extAttr">PutForwards=value</span>]
+ attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-impps">impps</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactProperties-serviceId">serviceId</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-categories">categories</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-2"><h4><span class="secno">4.4.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactProperties-addresses"><code>addresses</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a></span></dt><dd>
+ <p class="note">
+ Aligned with <a href="http://dev.w3.org/geo/api/spec-source-v2.html#address_interface">Geolocation v2 specification</a>.
+ </p>
+ <p>One or more addresses associated with the contact.</p>
+ <p>The first object in this sequence is inferred to be the user's preferred/default address.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>addresses<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_cbracket">{</span>streetNumber<span class="sh_symbol">:</span> <span class="sh_string">'123'</span><span class="sh_symbol">,</span>
+ street<span class="sh_symbol">:</span> <span class="sh_string">'Main Street'</span><span class="sh_symbol">,</span>
+ city<span class="sh_symbol">:</span> <span class="sh_string">'My Town'</span><span class="sh_symbol">,</span>
+ region<span class="sh_symbol">:</span> <span class="sh_string">'CA'</span><span class="sh_symbol">,</span>
+ postalCode<span class="sh_symbol">:</span> <span class="sh_string">'91921-1234'</span><span class="sh_symbol">,</span>
+ country<span class="sh_symbol">:</span> <span class="sh_string">'USA'</span><span class="sh_cbracket">}</span><span class="sh_symbol">]</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-categories"><code>categories</code> of type array of <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>One or more contact categories/groups to associate the contact with.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>categories<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'friends'</span><span class="sh_symbol">,</span> <span class="sh_string">'w3c'</span><span class="sh_symbol">,</span> <span class="sh_string">'information technology'</span><span class="sh_symbol">,</span> <span class="sh_string">'engineers'</span><span class="sh_symbol">]</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-emails"><code>emails</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>One or more email addresses associated with the contact.</p>
+ <p>The first object in this sequence is inferred to be the user's preferred/default email address.</p>
+
+ <p>The following constants are defined for use in the <code>types</code> attribute for email addresses:</p>
+ <pre>'home', 'work', 'personal', 'business'.</pre>
+ <p>Additional values may be provided for the <code>types</code> attribute.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>emails<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'work'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span> <span class="sh_string">'john.q.quinlan@barfooinc.com'</span><span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'home'</span><span class="sh_symbol">,</span> <span class="sh_string">'mobile'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span> <span class="sh_string">'jquinlan@mail.com'</span><span class="sh_cbracket">}</span><span class="sh_symbol">]</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-impps"><code>impps</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>One or more instant messaging and presence protocol addresses associated with the contact.</p>
+ <p>The first object in this sequence is inferred to be the user's preferred/default instant messaging and presence protocol address.</p>
+
+ <p>The following constants are defined for use in the <code>types</code> attribute for instant messaging and presence protocol addresses:</p>
+ <pre>'home', 'work', 'personal', 'business'.</pre>
+ <p>Additional values may be provided for the <code>types</code> attribute.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>impps<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'work'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span><span class="sh_string">'im:jquinlan@foobarinc.com'</span><span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'work'</span><span class="sh_symbol">,</span> <span class="sh_string">'mobile'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span><span class="sh_string">'sip:jquinlan@foobarinc.com'</span><span class="sh_cbracket">}</span><span class="sh_symbol">]</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-name"><code>name</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>The contact's name represented in a formatted manner</p>
+ <p>Each contact <em title="must" class="rfc2119">must</em> include a non-empty <code>name</code> value.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>name<span class="sh_symbol">:</span> <span class="sh_string">'Mr. John Q. Public, Esq.'</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-nicknames"><code>nicknames</code> of type array of <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>One or more nicknames associated with the contact</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>nicknames<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'jim'</span><span class="sh_symbol">,</span> <span class="sh_string">'jimmie'</span><span class="sh_symbol">]</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-phones"><code>phones</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>One or more telephone numbers associated with the contact.</p>
+
+ <p>The first object in this sequence is inferred to be the user's preferred/default phone number.</p>
+
+ <p>The following constants are defined for use in the <code>types</code> attribute for phone numbers:</p>
+ <pre>'home', 'work', 'voice', 'fax', 'fixed', 'mobile', 'car', 'video', 'isdn', 'pager', 'modem', 'pcs'.</pre>
+ <p>Additional values may be provided for the <code>types</code> attribute.</p>
+
+ <pre class="example sh_javascript sh_sourceCode"><span class="sh_cbracket">{</span>phones<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'home'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span> <span class="sh_string">'+442088450343'</span><span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>types<span class="sh_symbol">:</span> <span class="sh_symbol">[</span><span class="sh_string">'work'</span><span class="sh_symbol">],</span> value<span class="sh_symbol">:</span> <span class="sh_string">'+442088450343'</span><span class="sh_cbracket">}</span><span class="sh_symbol">]</span> <span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-serviceId"><code>serviceId</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>An identifier that <em title="may" class="rfc2119">may</em> be provided that represents the address book owner of the current contact object.</p>
+ <p>This attribute enables multiple address book sources to be tagged and filtered on Contact objects.</p>
+ <p>It is recommended that an implementation assign the serviceId attribute as a URI.</p>
+
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_cbracket">{</span>serviceId<span class="sh_symbol">:</span> <span class="sh_string">'http://foobar.com/myservices/v1/addressbook'</span><span class="sh_cbracket">}</span></pre>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactfield-interface">
+ <h3><span class="secno">4.5 </span><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface</h3>
+ <p>
+ The ContactField/Field interface is a reusable component that is used to support contact fields within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ It defines an optional <a href="#widl-ContactField-types"><code>types</code></a> parameter that can be provided with a standard <a href="#widl-ContactField-value"><code>value</code></a>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactField">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactField</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType">sequence<<a>DOMString</a>>?</span> <span class="idlAttrName"><a href="#widl-ContactField-types">types</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-value">value</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-3"><h4><span class="secno">4.5.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactField-types"><code>types</code> of type <span class="idlAttrType">sequence<<a>DOMString</a>></span>, nullable</dt><dd>
+ One or more contexts to associate with the given <code>value</code>.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-value"><code>value</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The value of the current object.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactaddress-interface">
+ <h3><span class="secno">4.6 </span><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface</h3>
+ <p>
+ The ContactAddress interface is a reusable component that is used to support address information within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAddress">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAddress</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-country">country</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-region">region</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-county">county</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-city">city</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-street">street</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-streetNumber">streetNumber</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-premises">premises</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-additionalInformation">additionalInformation</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-postalCode">postalCode</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-4"><h4><span class="secno">4.6.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAddress-additionalInformation"><code>additionalInformation</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ Additional information (e.g. floor number in a building, an apartment number, the name of an office occupant, etc) not captured in other <a href="#contactaddress-interface"><code>ContactAddress</code></a> properties.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-city"><code>city</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The city of the address.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-country"><code>country</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The country of the address, specified using the two-letter [ISO 3166-1] code.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-county"><code>county</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The name of a land area within the larger <a href="#widl-ContactAddress-region"><code>region</code></a>.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-postalCode"><code>postalCode</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The postal code of the address.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-premises"><code>premises</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ Details of the premises (e.g. block of flats, building name) of the address.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-region"><code>region</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The country subdivision (e.g state) of the address.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-street"><code>street</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The street of the address.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-streetNumber"><code>streetNumber</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ The street number of the address.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactoptions-interface">
+ <h3><span class="secno">4.7 </span><a class="idlType" href="#idl-def-ContactOptions"><code>ContactOptions</code></a> interface</h3>
+ <p class="note">
+ Rename this to "ContactSearchFilter" or similar?
+ </p>
+
+ <p>
+ The <a href="#contactoptions-interface"><code>ContactOptions</code></a>
+ interface describes the options that can be applied to contact searching.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactOptions">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactOptions</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactOptions-limit">limit</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactOptions-page">page</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOptions-sort">sort</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOptions-group">group</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-5"><h4><span class="secno">4.7.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactOptions-group"><code>group</code> of type <span class="idlAttrType"><a>boolean</a></span>, nullable</dt><dd>
+ <p class="note">
+ The ECMA-262 specification says in, section 12.6.4, "[for the for-in Statement t]he mechanics and order of enumerating the
+ properties [...] is not specified."
+ <br><br>
+ However, all major browsers loop over the properties of an object in the order in which they were defined (ref:
+ <a href="http://stackoverflow.com/questions/648139/is-the-order-of-fields-in-a-javascript-object-predicatble-when-looping-through-th/648163#648163">[1]</a>
+ but independently verified). Chrome has some minor issues, but due to the overwhelming implementation of this behaviour in all other major browsers,
+ the Chrome development team have marked this as a bug and it is due for fix in an upcoming release
+ <a href="http://code.google.com/p/chromium/issues/detail?id=20144">[2]</a>.
+ </p>
+ <p>
+ Whether the first property in the related <a href="#contactproperties-interface"><code>ContactProperties</code></a> object (in the order in which those properties were defined) should be grouped.
+ </p>
+ <p>
+ Only the first <a href="#contactproperties-interface"><code>ContactProperties</code></a> property provided can be grouped.
+ </p>
+
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOptions-limit"><code>limit</code> of type <span class="idlAttrType"><a>unsigned short</a></span></dt><dd>
+ <p>
+ The maximum number of results to return from the contacts search.
+ </p>
+ <p>
+ If no value is provided, the search will return all search results.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOptions-page"><code>page</code> of type <span class="idlAttrType"><a>unsigned short</a></span></dt><dd>
+ <p>
+ The page number of the contacts search to return. If the requested page index does not exist, this parameter <em title="must" class="rfc2119">must</em> be assigned the default value.
+ </p>
+ <p>
+ If no value is provided, the search will return all search results.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOptions-sort"><code>sort</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p class="note">
+ The ECMA-262 specification says in, section 12.6.4, "[for the for-in Statement t]he mechanics and order of enumerating the
+ properties [...] is not specified."
+ <br><br>
+ However, all major browsers loop over the properties of an object in the order in which they were defined (ref:
+ <a href="http://stackoverflow.com/questions/648139/is-the-order-of-fields-in-a-javascript-object-predicatble-when-looping-through-th/648163#648163">[1]</a>
+ but independently verified). Chrome has some minor issues, but due to the overwhelming implementation of this behaviour in all other major browsers,
+ the Chrome development team have marked this as a bug and it is due for fix in an upcoming release
+ <a href="http://code.google.com/p/chromium/issues/detail?id=20144">[2]</a>.
+ </p>
+ <p class="note">
+ Would it be better to have sort: ['field1', 'field2'] and descending: true|false where the latter is only meaningful if sort was specified?
+ </p>
+ <p>
+ The direction in which to sort the first property in the related <a href="#contactproperties-interface"><code>ContactProperties</code></a> object (in the order in which those properties were defined).
+ </p>
+ <p>
+ Only the first <a href="#contactproperties-interface"><code>ContactProperties</code></a> property provided is sortable.
+ </p>
+ <p>
+ This attribute <em title="must" class="rfc2119">must</em> be one of the following constants:
+ </p>
+ <pre>'asc', 'desc'</pre>
+ <p>If a different value is provided, this field defaults to <code>null</code></p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactfindsuccesscb-interface">
+ <h3><span class="secno">4.8 </span><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a> interface</h3>
+
+ <!-- interface intro here -->
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindSuccessCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindSuccessCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactFindSuccessCB-onSuccess">onSuccess</a></span> (<span class="idlParam">in <span class="idlParamType">sequence<<a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>></span> <span class="idlParamName">contactObjs</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-2"><h4><span class="secno">4.8.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactFindSuccessCB-onSuccess"><code>onSuccess</code></dt><dd>
+ <!-- interface description here -->
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObjs</td><td class="prmType"><code>sequence<<a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The sequence of Contact objects resulting from the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactsuccesscb-interface">
+ <h3><span class="secno">4.9 </span><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a> interface</h3>
+
+ <!-- interface intro here -->
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactSuccessCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactSuccessCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactSuccessCB-onSuccess">onSuccess</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlParamName">contactObj</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-3"><h4><span class="secno">4.9.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactSuccessCB-onSuccess"><code>onSuccess</code></dt><dd>
+ <!-- interface description here -->
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObj</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact object resulting from the given <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-save">commmit()</a> or <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-remove">remove()</a> method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contacterrorcb-interface">
+ <h3><span class="secno">4.10 </span><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> interface</h3>
+
+ <!-- interface intro here -->
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactErrorCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactErrorCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactErrorCB-onError">onError</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></span> <span class="idlParamName">error</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-4"><h4><span class="secno">4.10.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactErrorCB-onError"><code>onError</code></dt><dd>
+ <!-- interface description here -->
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">error</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact API related error object of an unsuccessful asynchronous operation.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+
+ </div>
+
+ <div class="section" id="contacterror-interface">
+ <h3><span class="secno">4.11 </span><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface</h3>
+ <p class="note">
+ Add Contacts API specific error codes...
+ </p>
+ <p>
+ The <a href="#contacterror-interface"><code>ContactError</code></a> interface encapsulates all errors in the manipulation of <a href="#contact-interface"><code>Contact</code></a> objects in the Contacts API.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactError</span> : <span class="idlSuperclass"><a class="idlType" href="#idl-def-GenericError"><code>GenericError</code></a></span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-CONTACT_NOT_FOUND_ERROR">CONTACT_NOT_FOUND_ERROR</a></span> = <span class="idlConstValue">30</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-CONTACT_INVALID_ERROR">CONTACT_INVALID_ERROR</a></span> = <span class="idlConstValue">31</span>;</span>
+};</span>
+</pre><div class="section" id="constants"><h4><span class="secno">4.11.1 </span>Constants</h4><dl class="constants"><dt id="widl-ContactError-CONTACT_INVALID_ERROR"><code>CONTACT_INVALID_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The <a href="#contact-interface"><code>Contact</code></a> object does not include all mandatory attributes required in <a href="#contacts-interface"><code>Contacts</code></a>.
+ </dd><dt id="widl-ContactError-CONTACT_NOT_FOUND_ERROR"><code>CONTACT_NOT_FOUND_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The <a href="#contact-interface"><code>Contact</code></a> object requested could not be found in <a href="#contacts-interface"><code>Contacts</code></a>.
+ </dd></dl></div>
+ </div>
+
+
+ </div>
+ <!-- end api description section -->
+
+ <div class="section" id="general-api-support">
+ <h2><span class="secno">5. </span>General API Support</h2>
+
+ This section defines the general API interfaces required by this specification that <em title="may" class="rfc2119">may</em> also be in use in other DAP APIs.
+
+ <p class="note">The following interfaces may be general interfaces for use throughout all APIs. They are included here for now for API spec completion.</p>
+
+ <div class="section" id="genericerror-interface">
+ <h3><span class="secno">5.1 </span><a class="idlType" href="#idl-def-GenericError"><code>GenericError</code></a> interface</h3>
+ <p>
+ The <a href="#genericerror-interface"><code>GenericError</code></a> interface encapsulates all general errors and is the basis of all errors produced by DAP APIs.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-GenericError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">GenericError</span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-UNKNOWN_ERR">UNKNOWN_ERR</a></span> = <span class="idlConstValue">0</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-INVALID_ARGUMENT_ERROR">INVALID_ARGUMENT_ERROR</a></span> = <span class="idlConstValue">1</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-NOT_FOUND_ERROR">NOT_FOUND_ERROR</a></span> = <span class="idlConstValue">2</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-PENDING_OPERATION_ERROR">PENDING_OPERATION_ERROR</a></span> = <span class="idlConstValue">3</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-IO_ERROR">IO_ERROR</a></span> = <span class="idlConstValue">4</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-NOT_SUPPORTED_ERROR">NOT_SUPPORTED_ERROR</a></span> = <span class="idlConstValue">5</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-GenericError-PERMISSION_DENIED_ERROR">PERMISSION_DENIED_ERROR</a></span> = <span class="idlConstValue">20</span>;</span>
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-GenericError-code">code</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-6"><h4><span class="secno">5.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-GenericError-code"><code>code</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, readonly</dt><dd>
+ An error code assigned by an implementation when an error has occurred in Contacts API processing.
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="constants-1"><h4><span class="secno">5.1.2 </span>Constants</h4><dl class="constants"><dt id="widl-GenericError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An invalid parameter was provided when the requested method was invoked.
+ </dd><dt id="widl-GenericError-IO_ERROR"><code>IO_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An error occurred in the underlying implementation that meant the requested method could not complete.
+ </dd><dt id="widl-GenericError-NOT_FOUND_ERROR"><code>NOT_FOUND_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If no response information can be provided from the requested method.
+ </dd><dt id="widl-GenericError-NOT_SUPPORTED_ERROR"><code>NOT_SUPPORTED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method is not supported by the current implementation.
+ </dd><dt id="widl-GenericError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If the <code>PendingOp</code> (as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>]) associated with the requested callback produces an error on <a href="../device/#widl-PendingOp-cancel">cancel()</a>.
+ </dd><dt id="widl-GenericError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method was rejected permission was denied at the implementation or by the user.
+ </dd><dt id="widl-GenericError-UNKNOWN_ERR"><code>UNKNOWN_ERR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An unknown error occurred.
+ </dd></dl></div>
+ </div>
+
+ </div>
+ <!-- end api description section -->
+ <div class="section" id="contact-search-processing-rules">
+ <h2><span class="secno">6. </span><a>Contact Search Processing Rules</a></h2>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> interface <a href="#widl-Contacts-find">find()</a> method
+ provides a method to search for contacts according to the input of a
+ <a href="#contactproperties-interface"><code>ContactProperties</code></a>
+ object.
+
+ </p><p>
+ All fields within a <a href="#contactproperties-interface"><code>ContactProperties</code></a> object provided to this method represent a logical UNION of value matching.
+ Fields provided with a <code>null</code> value are considered to match anything.
+ </p>
+ <p>
+ For example, the following <a href="#contactproperties-interface"><code>ContactProperties</code></a> object is supplied for Contact searching:
+ </p><pre class="example sh_javascript sh_sourceCode">navigator<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span>
+ name<span class="sh_symbol">:</span><span class="sh_string">'Robert'</span><span class="sh_symbol">,</span>
+ nicknames<span class="sh_symbol">:[</span><span class="sh_string">'Bob'</span><span class="sh_symbol">]</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_comment">/*...*/</span><span class="sh_symbol">);</span></pre>
+
+ The above example logically implies: <em>"find contact objects that contain a name of 'Robert' AND a nickname of 'Bob'"</em>.
+
+
+ <p class="note">
+ We need to be a lot clearer about partial matching included below. It might just be simpler to use pass RegExp objects around. Then again it might not...
+ </p>
+ <p>
+ All contact searching <em title="should" class="rfc2119">should</em> apply a loose-matching policy. If a <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute being searched in <a href="#contacts-interface"><code>Contacts</code></a>
+ <em>partially matches</em> the input filter value, a <a href="#contact-interface"><code>Contact</code></a> object representing the contact
+ <em title="should" class="rfc2119">should</em> be returned as part of the resulting <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a>.
+ </p>
+
+ <p>The <dfn id="rules-for-processing-filter-combinations">rules for processing filter combinations</dfn> is defined below and is always provided with an <var title="">input</var> parameter and, an optional <var title="">options</var> parameter. Its behaviour depends on the type of <var title="">input</var>:</p>
+
+ <dl class="switch">
+
+ <dt></dt>
+ <dd>Let <var title="">contactsset</var> be initially the set of all known contacts</dd>
+
+ <dt>If <var title="">input</var> is an Object object</dt>
+
+ <dd>
+ <ol>
+ <li>Let <var title="">singlefilter</var> be the <var title="">input</var> parameter being parsed.</li>
+ <li>Let <var title="">item</var> be the next enumerable property in <var title="">singlefilter</var>. If there are no more enumerable properties, go to step 6.</li>
+ <li>If the value of <var title="">item</var> is <code>null</code>, go to step 2.</li>
+ <li>Let <var title="">contactsset</var> be the subset of <var title="">contactsset</var> whose elements have the item value set to the value of <var title="">item</var>.</li>
+ <li>Go to step 2.</li>
+ <li>If the value of <var title="">options</var> is not <code>null</code>. apply the provided <var title="">options</var> to <var title="">contactsset</var>.</li>
+ <li>Return <var title="">contactsset</var>.</li>
+ </ol>
+ </dd>
+
+ <dt>If <var title="">input</var> is another native object type</dt>
+
+ <dd><p>Return a <code>null</code> value.
+
+ </p></dd></dl>
+
+
+
+ <p> </p>
+
+ </div>
+
+ <div class="section" id="use-cases-and-requirements">
+ <h2><span class="secno">7. </span>Use Cases and Requirements</h2>
+
+ <div class="section" id="use-cases">
+ <h3><span class="secno">7.1 </span>Use Cases</h3>
+
+ <p>
+ </p><h4 id="uc1">Use Case 1: Upload a set of contact details to a user's social network</h4>
+ A user is registered on a number of different social networking sites and would like to upload some or all of their
+ address book contacts to the service. Using the Contacts API, the Web application has access to the user's address book,
+ subject to user opt-in, and it is therefore able to import the user's selected contacts in to their service.
+
+
+ <p>
+ </p><h4 id="uc2">Use Case 2: Download a set of contact details from a user's social network</h4>
+ A social networking user would like to download some or all of their social network contacts to their native address book, in to their native
+ phone dialling application or in to another application for offline / non-web use. Using the Contacts API, the Web application provides the user with an export
+ function and, subject to user opt-in, the selected contacts can be downloaded and imported in to the user's address book.
+
+
+ <p>
+ </p><h4 id="uc3">Use Case 3: A user would like to keep their work address book and personal address book seperate</h4>
+ The Contacts API will provide all address book contacts in a unified way but the user would like to associate individual contacts
+ to individual address books - keeping their work and social address books seperated. The Contacts API must allow Web Applications to
+ distinguish between multiple address book stores and allow the user to manage different address books according to their needs.
+
+
+ <p>
+ </p><h4 id="uc4">Use Case 4: A user maintains a single unified address book but would like to maintain groups of contacts within that address book</h4>
+ A user has a number of friends, family, colleagues and other contacts in their address book. They would like to create groups and assign
+ existing contacts to these groups. The user can create, update or remove as many groups as they like and equally they would like to be able to
+ add, remove and update the members assigned to those groups whenever they need to. The user's contacts can belong to multiple groups at the
+ any one time.
+
+
+ <p>
+ </p><h4 id="uc5">Use Case 5: Use a web interface to manage contact details on both the user's device and the web</h4>
+ A Web Application is built that allows users to add, update and remove friend's contact details stored in their native address book.
+ The Web Application can add, remove and update contact details, subject to user opt-in, and these details are automatically propagated
+ from the web interface to the user's address book.
+
+
+ <p>
+ </p><h4 id="uc6">Use Case 6: A user would like to export contacts from the one address book store and import them to another address book store</h4>
+ The user maintains multiple address books that are stored on both the web and on their device(s). The user would like to move some or all of
+ their contacts from one address book store to another. Using the Contacts API, the user can assign contact details to different address book
+ stores. The underlying implementation will action the import/export process when the user changes to which address book store a contact is
+ associated and the user makes an active request, via the Contacts API, to update the modified contacts.
+
+
+ <p>
+ </p><h4 id="uc7">Use Case 7: A user would like to be notified when friends have a birthday coming up</h4>
+ A user would like their favorite Web Application to inform them when all their friend's birthdays are coming up. The user imports some or all
+ of their address book contacts to the Web Application. The web application can read in the contacts' birthdays as well as other useful identifying
+ information (e.g. the contacts' names). The Web Application can then email, SMS or otherwise notify the user when a contact's birthday is coming
+ up.
+
+
+ <p>
+ </p><h4 id="uc8">Use Case 8: A user would like his/her contacts to update their own contact details via a mediating Web Application and sync any changes to their
+ current address book</h4>
+ User's contact details are constantly changing and being updated. A user has uploaded their address book to a Web Application which has then allowed
+ the user's contacts to update the details contained therein in a collaborative way. The user can then synchronise any changes made by his/her contacts
+ when they e.g. visit that Web Application at any point in the future.
+
+ </div>
+
+ <div class="section" id="requirements">
+ <h3><span class="secno">7.2 </span>Requirements</h3>
+
+ <ul>
+ <li>The Contacts API <em title="must" class="rfc2119">must</em> enable listing all available address books on the device;</li>
+ <li>The Contacts API <em title="must" class="rfc2119">must</em> enable listing all contacts in the address book(s);</li>
+ <li>The Contacts API <em title="must" class="rfc2119">must</em> enable reading the details for a contact;</li>
+ <li>The Contacts API <em title="should" class="rfc2119">should</em> enable creating a new contact;</li>
+ <li>The Contacts API <em title="should" class="rfc2119">should</em> enable updating a contact;</li>
+ <li>The Contacts API <em title="should" class="rfc2119">should</em> enable deleting a contact;</li>
+
+ <li>The Contacts API <em title="should" class="rfc2119">should</em> enable filtering the list of contacts to search for a subset.</li>
+ </ul>
+
+
+ </div>
+
+ </div>
+
+ <div id="features-for-future-consideration" class="appendix section">
+ <h2><span class="secno">A. </span>Features for Future Consideration</h2>
+ <p>
+ The requirements document contains a list of features that were considered for this version
+ but deferred to future work [<a href="#bib-DAP-REQS" rel="biblioentry" class="bibref">DAP-REQS</a>].
+ </p>
+ </div>
+
+ <div id="acknowledgements" class="appendix section">
+ <h2><span class="secno">B. </span>Acknowledgements</h2>
+ <p>
+ The editor would like to thank the input from the PhoneGap, Nokia, and OMTP BONDI groups and the feedback received from <acronym title="World Wide Web Consortium">W3C</acronym> DAP members to date ...
+ </p>
+ </div>
+ <div class="appendix section" id="references"><h2><span class="secno">C. </span>References</h2><div class="section" id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a> </dd></dl></div><div class="section" id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><dl class="bibliography"><dt id="bib-CORE-DEVICE">[CORE-DEVICE]</dt><dd>Robin Berjon. <a href="http://dev.w3.org/2009/dap/device/"><cite>Core Device Interfaces.</cite></a> 02 December 2009. W3C Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/device/">http://dev.w3.org/2009/dap/device/</a> </dd><dt id="bib-DAP-REQS">[DAP-REQS]</dt><dd>Robin Berjon; et al. <a href="http://dev.w3.org/2009/dap/api-reqs/"><cite>Device API Requirements.</cite></a> 05 October 2009. Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/api-reqs/">http://dev.w3.org/2009/dap/api-reqs/</a> </dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2009/WD-html5-20090825/"><cite>HTML 5.</cite></a> 25 August 2009. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2009/WD-html5-20090825/">http://www.w3.org/TR/2009/WD-html5-20090825/</a> </dd><dt id="bib-RFC4122">[RFC4122]</dt><dd>P. Leach; M. Mealling; R. Salz. <a href="http://www.ietf.org/rfc/rfc4122.txt"><cite>A Universally Unique IDentifier (UUID) URN Namespace</cite></a> July 2005. Internet RFC 4122. URL: <a href="http://www.ietf.org/rfc/rfc4122.txt">http://www.ietf.org/rfc/rfc4122.txt</a> </dd></dl></div></div></body></html>
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/HTML.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,295 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>HTML Contact Sharing</title>
+ <meta http-equiv='Content-Type' content='text/html;charset=utf-8'/>
+ <script src='../ReSpec.js/js/respec.js' class='remove'></script>
+<script
+ type="text/javascript"
+ src='../ReSpec.js/js/sh_main.min.js'
+ class='remove'>
+</script>
+<script
+ type="text/javascript"
+ class='remove'>
+ var respecConfig = {
+ specStatus: "unofficial",
+ shortName: "contacts-html-api",
+ editors: [{name: "Richard Tibbett", url: "http://richt.me", company: "Opera Software ASA", companyURL: "http://www.opera.com"}],
+ //publishDate: "2010-08-17",
+ //previousPublishDate: "2010-08-17",
+ //previousMaturity: "WD",
+ edDraftURI: "http://dev.w3.org/2009/dap/contacts/HTML.html",
+ // lcEnd: "2009-08-05",
+ };
+</script>
+<script
+ type="text/javascript"
+ src='../common/config.js'
+ class='remove'>
+</script>
+<style
+ type="text/css">
+/* ReSpec.js CSS optimizations (Richard Tibbett) */
+
+div.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ background: #fff;
+ padding: 1em;
+ font-size: 0.9em;
+ margin-top: 1em;
+}
+div.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ padding-left: 5px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* Clean up pre.idl */
+pre.idl::before {
+ font-size:0.9em;
+}
+
+/* Add better spacing to sections */
+section, .section {
+ margin-bottom: 2em;
+}
+
+/* Reduce note & issue render size */
+.note, .issue {
+ font-size:0.8em;
+}
+
+/* Add addition spacing to <ol> and <ul> for rule definition */
+ol.rule li, ul.rule li {
+ padding:0.2em;
+}
+</style>
+ </head>
+ <body>
+ <section id='abstract'>
+ This specification defines HTML enhancements that provide access to a user's address book.
+ </section>
+
+ <section
+ id='conformance'>
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn>user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to provide the callbacks defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [[!WEBIDL]], as this specification uses that specification and
+ terminology.
+ </p>
+ </section>
+
+ <section id="sotd">
+ <p>Information presented in this document is for informational purposes only, and does not reflect final choices in the integration of Device
+ APIs with HTML within Opera or elsewhere. As such, this document or the need to work on this document has not been formall ratified by the
+ W3C.</p>
+ <p>
+ Other routes for integrating Device API access with HTML are also being explored on an active basis
+ within the <a href="http://www.w3.org/2009/dap/">W3C DAP Working Group</a>.</p>
+
+ <p>All comments on this draft should be directed to the <a href="http://lists.w3.org/Archives/Public/public-device-apis/">W3C DAP mailing list</a>.</p>
+ </section>
+
+ <section class='informative'>
+ <h2>Introduction</h2>
+ <p>
+ This HTML Contact Sharing recommendation defines an HTML extension to enable websites to quickly and unobtrusively obtain a list of
+ contacts from the current user based on the records available in their address book.
+ </p>
+ <p>
+ This specification builds on the existing HTML <code>device</code> element [[!HTML-DEVICE]].
+ </p>
+ <p>
+ In addition, this recommednation also reuses the basic security and privacy principles and existing low-level parts of the Contacts API [[!CONTACTS-API]] to provide address book data to a web application.
+ </p>
+ <p>
+ ...
+ </p>
+
+ <div
+ class="example">
+ <p>
+ The following code illustrates how to obtain contact information from a user's address book.
+ </p>
+<pre
+ class="sh_javascript">
+<device type="contact" params="fields=name,emails;filter=Bob;updatedSince=2010-05-23T00:00:00Z"
+ onchange="successContactFindCallback(this.data)" />
+
+<script type="text/javascript">
+ function successContactFindCallback(contacts) {
+ // do something with resulting contact objects
+ for (var i in contacts) alert(contacts[i].name.formatted);
+ // ...
+ }
+</script>
+</pre>
+</div>
+ </section>
+
+ <section>
+ <h2>
+ HTML Device Element Integration
+ </h2>
+ <p
+ class="issue">
+ This section is likely to evolve significantly over time due to [[!HTML-DEVICE]] not currently being a mature proposal. This is included to illustrate an HTML integration model for this and
+ other select Device APIs, hooking in to the same low-level objects of a corresponding programmatic API being actively developed within the W3C DAP WG.<br>
+ <br>
+ Feedback on this section is encouraged from implementors.
+ </p>
+ <p>
+ This section details an extension to the HTML Device specification [[!HTML-DEVICE]] to enable contact information to be shared
+ through graphical controls embedded on a web page.
+ </p>
+ <p>
+ The <code>device</code> element's <code>type</code> attribute MUST be set to <var>contact</var> to indicate the device element is in the <dfn>contacts
+ state</dfn>, according to the table below.
+ </p>
+ <table
+ class='simple'
+ summary='Device Element in the Contacts Database state'>
+ <thead>
+ <tr>
+ <th>
+ Keyword
+ </th>
+ <th>
+ State
+ </th>
+ <th>
+ Device Description
+ </th>
+ <th>
+ Example
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>contact</code>
+ </td>
+ <td>
+ Contacts
+ </td>
+ <td>
+ Contacts Database/Storage
+ </td>
+ <td>
+ Access to a group of contacts residing on the user's system or in the current <a>user agent</a>.
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ <p>
+ A <code>device</code> element in the <a>contacts database state</a> SHOULD render as a graphical control on the current web page.
+ </p>
+ <p
+ class="note">
+ TBW: Passing parameters via <code>params</code> in to the UI control widget...
+ </p>
+ <p>
+ Once the user has selected the graphical control they MAY be presented with a modal, UI control widget dialog to select and review
+ contact sharing with the current web page. If the user selects one or more contacts from this dialog then:
+ </p>
+ <ol
+ class="rule">
+ <li>
+ The modal UI Widget control dialog used to select the contact objects MUST be terminated.
+ </li>
+ <li>
+ The originating <code>device</code> element's <code>data</code> attribute MUST be set to a corresponding <code>Contact</code> Array object (<code>Contact[]</code>) as defined in [[!CONTACTS-API]].
+ </li>
+ <li>
+ The originating <code>device</code> element's <code>change</code> event MUST be triggered.
+ </li>
+ </ol>
+ <p
+ class="issue">
+ [[!HTML-DEVICE]] is not currently provisioned as being a HTML web form element. If serialization of the resulting data is required
+ for use in a web forms context neither the [[!HTML-DEVICE]] specification or this specification currently provide any
+ recommendations to that effect.
+ </p>
+ </section>
+
+ <section class="informative appendix">
+ <h3>
+ User Interaction Guidelines
+ </h3>
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+ <div
+ class="example">
+<pre
+ class="sh_javascript">
+<html>
+<body>
+ <h1>Contacts API Test Page</h1>
+ <device type="contact" params="fields=name,emails;filter=Bob" onchange="successContactFindCallback(this.data)" />
+ <script type="text/javascript">
+ function successContactFindCallback(contacts) {
+ // do something with resulting contact objects
+ for (var i in contacts) alert(contacts[i].name.formatted);
+ // ...
+ }
+ </script>
+</body>
+</html>
+</pre>
+ </div>
+ <p>
+ This page may render in the <a>user agent</a> as follows:
+ </p>
+ <p
+ align="center">
+ <img
+ src="contacts_element.png"
+ alt="Device Element in Contacts State"><br>
+ (<a
+ href="contacts_element.png">View as PNG</a>)
+ </p>
+ <p>
+ If the user clicks on the rendered device control, the <a>user agent</a> may provide the <a>contact picker</a>, utilising all of
+ the parameters provided in the originating device element.
+ </p>
+ <p
+ align="center">
+ <img
+ src="contacts_picker.png"
+ alt="Contact Picker"><br>
+ (<a
+ href="contacts_picker.png">View as PNG</a>)
+ </p>
+ <p>
+ If the user clicks 'Cancel', then the user is returned to the page and no further action is taken.
+ </p>
+ <p>
+ If the user clicks 'Select', the <var>data</var> attribute of the originating device element is set to the contact
+ information selected by the user as defined in <a
+ href="#html-device-element-integration">HTML Device Element Integration</a>.
+ </p>
+ </section>
+
+ <section class='appendix'>
+ <h2>Acknowledgements</h2>
+ <p>
+ Many thanks to Wojciech Maslowski for helping to put this initial proposal together.
+ </p>
+ </section>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/LC/CVS/Entries Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,5 @@
+/contacts_element.png/1.1/Wed Jun 15 14:47:06 2011/-kb/
+/contacts_notification.png/1.1/Wed Jun 15 14:47:06 2011/-kb/
+/contacts_picker.png/1.1/Wed Jun 15 14:47:06 2011/-kb/
+/Overview.html/1.4/Wed Jun 15 15:04:47 2011//
+D
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/LC/CVS/Repository Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+2009/dap/contacts/LC
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/LC/CVS/Root Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+rberjon2@dev.w3.org:/sources/public
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/LC/Overview.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1981 @@
+<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
+<html lang="en" dir="ltr">
+<head>
+ <title>Contacts API</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+
+
+
+
+ <style type="text/css">
+ /* ReSpec.js CSS optimizations (Richard Tibbett) */
+ div.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ background: #fff;
+ padding: 1em;
+ font-size: 0.9em;
+ margin-top: 1em;
+ }
+ div.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ padding-left: 5px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+ }
+
+ /* Clean up pre.idl */
+ pre.idl::before {
+ font-size:0.9em;
+ }
+
+ /* Add better spacing to sections */
+ section, .section {
+ margin-bottom: 2em;
+ }
+
+ /* Reduce note & issue render size */
+ .note, .issue {
+ font-size:0.8em;
+ }
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li {
+ padding:0.2em;
+ }
+ /*
+ IDL wrapping fix
+ http://perishablepress.com/press/2010/06/01/wrapping-content/
+
+ [RB] This isn't a fix, it kills indentation!
+
+ pre.idl {
+ white-space: pre;
+ white-space: pre-wrap;
+ white-space: pre-line;
+ white-space: -pre-wrap;
+ white-space: -o-pre-wrap;
+ white-space: -moz-pre-wrap;
+ white-space: -hp-pre-wrap;
+ word-wrap: break-word;
+ }
+ */
+ </style>
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec CSS
+ * Robin Berjon (robin at berjon dot com)
+ * v0.05 - 2009-07-31
+ *****************************************************************/
+
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: 1px solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: medium dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- WEB IDL --- */
+pre.idl {
+ border-top: 1px solid #90b8de;
+ border-bottom: 1px solid #90b8de;
+ padding: 1em;
+ line-height: 120%;
+}
+
+pre.idl::before {
+ content: "WebIDL";
+ display: block;
+ width: 150px;
+ background: #90b8de;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+.idlType {
+ color: #ff4500;
+ font-weight: bold;
+ text-decoration: none;
+}
+
+/*.idlModule*/
+/*.idlModuleID*/
+/*.idlInterface*/
+.idlInterfaceID {
+ font-weight: bold;
+ color: #005a9c;
+}
+
+.idlSuperclass {
+ font-style: italic;
+ color: #005a9c;
+}
+
+/*.idlAttribute*/
+.idlAttrType, .idlFieldType {
+ color: #005a9c;
+}
+.idlAttrName, .idlFieldName {
+ color: #ff4500;
+}
+.idlAttrName a, .idlFieldName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlMethod*/
+.idlMethType {
+ color: #005a9c;
+}
+.idlMethName {
+ color: #ff4500;
+}
+.idlMethName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlParam*/
+.idlParamType {
+ color: #005a9c;
+}
+.idlParamName {
+ font-style: italic;
+}
+
+.extAttr {
+ color: #666;
+}
+
+/*.idlConst*/
+.idlConstType {
+ color: #005a9c;
+}
+.idlConstName {
+ color: #ff4500;
+}
+.idlConstName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlException*/
+.idlExceptionID {
+ font-weight: bold;
+ color: #c00;
+}
+
+.idlTypedefID, .idlTypedefType {
+ color: #005a9c;
+}
+
+.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
+ color: #c00;
+ font-weight: normal;
+}
+
+.excName a {
+ font-family: monospace;
+}
+
+.idlRaises a.idlType, .excName a.idlType {
+ border-bottom: 1px dotted #c00;
+}
+
+.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
+ width: 45px;
+ text-align: center;
+}
+.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
+.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
+
+.idlImplements a {
+ font-weight: bold;
+}
+
+dl.attributes, dl.methods, dl.constants, dl.fields {
+ margin-left: 2em;
+}
+
+.attributes dt, .methods dt, .constants dt, .fields dt {
+ font-weight: normal;
+}
+
+.attributes dt code, .methods dt code, .constants dt code, .fields dt code {
+ font-weight: bold;
+ color: #000;
+ font-family: monospace;
+}
+
+.attributes dt code, .fields dt code {
+ background: #ffffd2;
+}
+
+.attributes dt .idlAttrType code, .fields dt .idlFieldType code {
+ color: #005a9c;
+ background: transparent;
+ font-family: inherit;
+ font-weight: normal;
+ font-style: italic;
+}
+
+.methods dt code {
+ background: #d9e6f8;
+}
+
+.constants dt code {
+ background: #ddffd2;
+}
+
+.attributes dd, .methods dd, .constants dd, .fields dd {
+ margin-bottom: 1em;
+}
+
+table.parameters, table.exceptions {
+ border-spacing: 0;
+ border-collapse: collapse;
+ margin: 0.5em 0;
+ width: 100%;
+}
+table.parameters { border-bottom: 1px solid #90b8de; }
+table.exceptions { border-bottom: 1px solid #deb890; }
+
+.parameters th, .exceptions th {
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+ font-family: initial;
+ font-weight: normal;
+ text-shadow: #666 1px 1px 0;
+}
+.parameters th { background: #90b8de; }
+.exceptions th { background: #deb890; }
+
+.parameters td, .exceptions td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+ vertical-align: top;
+}
+
+.parameters tr:first-child td, .exceptions tr:first-child td {
+ border-top: none;
+}
+
+.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
+ width: 100px;
+}
+
+.parameters td.prmType {
+ width: 120px;
+}
+
+table.exceptions table {
+ border-spacing: 0;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+/* --- TOC --- */
+.toc a {
+ text-decoration: none;
+}
+
+a .secno {
+ color: #000;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+
+/* --- EXAMPLES --- */
+pre.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ padding: 1em;
+ margin-top: 1em;
+}
+
+pre.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* --- EDITORIAL NOTES --- */
+.issue {
+ padding: 1em;
+ margin: 1em 0em 0em;
+ border: 1px solid #f00;
+ background: #ffc;
+}
+
+.issue::before {
+ content: "Issue";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #f00;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+.note {
+ margin: 1em 0em 0em;
+ padding: 1em;
+ border: 2px solid #cff6d9;
+ background: #e2fff0;
+}
+
+.note::before {
+ content: "Note";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #cff6d9;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+/* --- Best Practices --- */
+div.practice {
+ border: solid #bebebe 1px;
+ margin: 2em 1em 1em 2em;
+}
+
+span.practicelab {
+ margin: 1.5em 0.5em 1em 1em;
+ font-weight: bold;
+ font-style: italic;
+}
+
+span.practicelab { background: #dfffff; }
+
+span.practicelab {
+ position: relative;
+ padding: 0 0.5em;
+ top: -1.5em;
+}
+
+p.practicedesc {
+ margin: 1.5em 0.5em 1em 1em;
+}
+
+@media screen {
+ p.practicedesc {
+ position: relative;
+ top: -2em;
+ padding: 0;
+ margin: 1.5em 0.5em -1em 1em;
+}
+
+/* --- SYNTAX HIGHLIGHTING --- */
+pre.sh_sourceCode {
+ background-color: white;
+ color: black;
+ font-style: normal;
+ font-weight: normal;
+}
+
+pre.sh_sourceCode .sh_keyword { color: #005a9c; font-weight: bold; } /* language keywords */
+pre.sh_sourceCode .sh_type { color: #666; } /* basic types */
+pre.sh_sourceCode .sh_usertype { color: teal; } /* user defined types */
+pre.sh_sourceCode .sh_string { color: red; font-family: monospace; } /* strings and chars */
+pre.sh_sourceCode .sh_regexp { color: orange; font-family: monospace; } /* regular expressions */
+pre.sh_sourceCode .sh_specialchar { color: #ffc0cb; font-family: monospace; } /* e.g., \n, \t, \\ */
+pre.sh_sourceCode .sh_comment { color: #A52A2A; font-style: italic; } /* comments */
+pre.sh_sourceCode .sh_number { color: purple; } /* literal numbers */
+pre.sh_sourceCode .sh_preproc { color: #00008B; font-weight: bold; } /* e.g., #include, import */
+pre.sh_sourceCode .sh_symbol { color: blue; } /* e.g., *, + */
+pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */
+pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */
+pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: #00FFFF; } /* TODO and FIXME */
+
+/* Predefined variables and functions (for instance glsl) */
+pre.sh_sourceCode .sh_predef_var { color: #00008B; }
+pre.sh_sourceCode .sh_predef_func { color: #00008B; font-weight: bold; }
+
+/* for OOP */
+pre.sh_sourceCode .sh_classname { color: teal; }
+
+/* line numbers (not yet implemented) */
+pre.sh_sourceCode .sh_linenum { display: none; }
+
+/* Internet related */
+pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; }
+
+/* for ChangeLog and Log files */
+pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; }
+pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: #00008B; font-weight: bold; }
+pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: #006400; }
+
+/* for Prolog, Perl... */
+pre.sh_sourceCode .sh_variable { color: #006400; }
+
+/* for LaTeX */
+pre.sh_sourceCode .sh_italics { color: #006400; font-style: italic; }
+pre.sh_sourceCode .sh_bold { color: #006400; font-weight: bold; }
+pre.sh_sourceCode .sh_underline { color: #006400; text-decoration: underline; }
+pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; }
+pre.sh_sourceCode .sh_argument { color: #006400; }
+pre.sh_sourceCode .sh_optionalargument { color: purple; }
+pre.sh_sourceCode .sh_math { color: orange; }
+pre.sh_sourceCode .sh_bibtex { color: blue; }
+
+/* for diffs */
+pre.sh_sourceCode .sh_oldfile { color: orange; }
+pre.sh_sourceCode .sh_newfile { color: #006400; }
+pre.sh_sourceCode .sh_difflines { color: blue; }
+
+/* for css */
+pre.sh_sourceCode .sh_selector { color: purple; }
+pre.sh_sourceCode .sh_property { color: blue; }
+pre.sh_sourceCode .sh_value { color: #006400; font-style: italic; }
+
+/* other */
+pre.sh_sourceCode .sh_section { color: black; font-weight: bold; }
+pre.sh_sourceCode .sh_paren { color: red; }
+pre.sh_sourceCode .sh_attribute { color: #006400; }
+
+</style><link charset="utf-8" type="text/css" rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"></head>
+
+ <body style="display: inherit;"><div class="head"><p><a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a></p><h1 class="title" id="title">Contacts API</h1><h2 id="w3c-working-draft-16-june-2011">W3C Working Draft 16 June 2011</h2><dl><dt>This version:</dt><dd><a href="http://www.w3.org/TR/2011/WD-contacts-api-20110616/">http://www.w3.org/TR/2011/WD-contacts-api-20110616/</a></dd><dt>Latest published version:</dt><dd><a href="http://www.w3.org/TR/contacts-api/">http://www.w3.org/TR/contacts-api/</a></dd><dt>Latest editor's draft:</dt><dd><a href="http://dev.w3.org/2009/dap/contacts/">http://dev.w3.org/2009/dap/contacts/</a></dd><dt>Previous version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20101209/">http://www.w3.org/TR/2010/WD-contacts-api-20101209/</a></dd><dt>Editor:</dt><dd><a href="http://richt.me">Richard Tibbett</a>, <a href="http://www.opera.com">Opera Software ASA</a></dd>
+</dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2011 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p><hr></div>
+ <div class="introductory section" id="abstract"><h2>Abstract</h2>
+ <p>
+ The Contacts API defines the high-level interfaces required to obtain read access to a user's unified
+ address book.
+ </p>
+ <p>
+ This API includes the following key interfaces:
+ </p>
+ <ul>
+ <li>A <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface, which provides the method
+ needed to access a user's unified address book.</li>
+ <li>A <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface, which captures the individual
+ contact information that can be returned following a successful read operation.</li>
+ </ul>
+ </div><div id="sotd" class="introductory section"><h2>Status of This Document</h2><p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed
+ Contacts API. Issues and editors note in the document highlight some of the points on which the group is
+ still working and would particularly like to get feedback.
+ </p>
+ <p>This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a Last Call Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). The Last Call period ends 14 July 2011. All feedback is welcome.</p><p>Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p><p>This is a Last Call Working Draft and thus the Working Group has determined that this document has satisfied the relevant technical requirements and is sufficiently stable to advance through the Technical Recommendation process.</p><p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 W3C Patent Policy</a>. W3C maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>.</p></div><div class="section" id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a class="tocxref" href="#introduction"><span class="secno">1. </span>Introduction</a></li><li class="tocline"><a class="tocxref" href="#conformance"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#terminology"><span class="secno">2.1 </span>Terminology</a></li></ul></li><li class="tocline"><a class="tocxref" href="#security-and-privacy-considerations"><span class="secno">3. </span>Security and Privacy Considerations</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-implementors-of-the-contacts-api"><span class="secno">3.1 </span>Privacy considerations for implementors of the Contacts API</a></li><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-recipients-of-contact-information"><span class="secno">3.2 </span>Privacy considerations for recipients of contact information</a></li><li class="tocline"><a class="tocxref" href="#additional-implementation-considerations"><span class="secno">3.3 </span>Additional implementation considerations</a></li></ul></li><li class="tocline"><a class="tocxref" href="#api-description"><span class="secno">4. </span>API Description</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#servicecontacts-interface"><span class="secno">4.1 </span><span class="idlType formerLink idlType"><code>ServiceContacts</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes"><span class="secno">4.1.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacts-interface"><span class="secno">4.2 </span><span class="idlType formerLink idlType"><code>Contacts</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods"><span class="secno">4.2.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-interface"><span class="secno">4.3 </span><span class="idlType formerLink idlType"><code>Contact</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-1"><span class="secno">4.3.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactname-interface"><span class="secno">4.4 </span><span class="idlType formerLink idlType"><code>ContactName</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-2"><span class="secno">4.4.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfield-interface"><span class="secno">4.5 </span><span class="idlType formerLink idlType"><code>ContactField</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-3"><span class="secno">4.5.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaddress-interface"><span class="secno">4.6 </span><span class="idlType formerLink idlType"><code>ContactAddress</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-4"><span class="secno">4.6.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactorganization-interface"><span class="secno">4.7 </span><span class="idlType formerLink idlType"><code>ContactOrganization</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-5"><span class="secno">4.7.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindoptions-interface"><span class="secno">4.8 </span><span class="idlType formerLink idlType"><code>ContactFindOptions</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-6"><span class="secno">4.8.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindcb-interface"><span class="secno">4.9 </span><span class="idlType formerLink idlType"><code>ContactFindCB</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-1"><span class="secno">4.9.1 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#event-handler-attributes"><span class="secno">4.9.2 </span>Event Handler Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterrorcb-interface"><span class="secno">4.10 </span><span class="idlType formerLink idlType"><code>ContactErrorCB</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-2"><span class="secno">4.10.1 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#event-handler-attributes-1"><span class="secno">4.10.2 </span>Event Handler Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterror-interface"><span class="secno">4.11 </span><span class="idlType formerLink idlType"><code>ContactError</code></span> interface</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-7"><span class="secno">4.11.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#constants"><span class="secno">4.11.2 </span>Constants</a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-search-processing"><span class="secno">5. </span><span class="formerLink">Contact Search Processing</span></a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-qualifiers"><span class="secno">5.1 </span>Search Qualifiers</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#advanced-search-qualifiers"><span class="secno">5.1.1 </span>Advanced Search Qualifiers</a></li></ul></li><li class="tocline"><a class="tocxref" href="#options-processing"><span class="secno">5.2 </span>Options Processing</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-cardinality"><span class="secno">5.2.1 </span>Search Cardinality</a></li><li class="tocline"><a class="tocxref" href="#search-filters"><span class="secno">5.2.2 </span>Search Filters</a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#extended-contact-properties-and-parameters"><span class="secno">6. </span>Extended Contact Properties and Parameters</a></li><li class="tocline"><a class="tocxref" href="#api-invocation-via-dom-events"><span class="secno">7. </span>API Invocation via DOM Events</a></li><li class="tocline"><a class="tocxref" href="#user-interaction-guidelines"><span class="secno">A. </span>User Interaction Guidelines</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#accessing-contact-information---example--1"><span class="secno">A.1 </span>Accessing Contact Information - Example #1</a></li><li class="tocline"><a class="tocxref" href="#accessing-contact-information---example--2"><span class="secno">A.2 </span>Accessing Contact Information - Example #2</a></li></ul></li><li class="tocline"><a class="tocxref" href="#adding-and-updating-contacts"><span class="secno">B. </span>Adding and Updating Contacts</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#adding-a-new-contact"><span class="secno">B.1 </span>Adding a new Contact</a></li><li class="tocline"><a class="tocxref" href="#updating-an-existing-contact"><span class="secno">B.2 </span>Updating an existing Contact</a></li></ul></li><li class="tocline"><a class="tocxref" href="#references"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li class="tocline"><a class="tocxref" href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></div>
+
+
+
+ <div id="introduction" class="informative section">
+ <!--OddPage--><h2><span class="secno">1. </span>Introduction</h2><p><em>This section is non-normative.</em></p>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of
+ representing address book information. Most users are required to maintain a plurality of contact lists
+ which leads to multiple copies of address book data. This in turn
+ often leads to disjointed and inconsistent information being stored across a user's
+ address book providers.
+ </p>
+ <p>
+ When sharing contact data with third parties users are, more often than not, required to hand over access to
+ their whole address book. Users are implicitly required to trust third parties with all of their data
+ when, in reality, the user may only wish, or need, to share a subset of their address book information so
+ that an application can fulfil its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may
+ be sourced from a plurality of sources - both online and locally. It then defines the
+ interfaces through which third party applications can access a user's unified address book, with explicit user
+ permission and filtering. The focus of this data sharing is on making the user aware of the data that
+ they will share and putting them at the centre of the data sharing process; free to select both the
+ extent to which they share their address book information and the ability to restrict which pieces of
+ information related to which contact gets shared.
+ </p>
+ <p>
+ A set of <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> are
+ presented for the discretion of both implementors of the Contacts API and recipients of contact
+ information (i.e. web pages). This specification provides a set of non-normative
+ <a href="#user-interaction-guidelines">User Interaction Guidelines</a> demonstrating an example user experience
+ that is compliant with the Security and Privacy Considerations described herein.
+ </p>
+ <p>
+ This specification also provides informative examples illustrating how to
+ <a href="#adding-and-updating-contacts">add and update contact information</a>, utilising existing web platform
+ APIs.
+ </p>
+ <p>
+ The following code illustrates how to obtain contact information from a user's address book:
+ </p>
+ <pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">success</span> <span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span><span class="sh_predef_var">name</span><span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">error</span> <span class="sh_symbol">(</span>err<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting error</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>err<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">(</span> <span class="sh_symbol">[</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span> success<span class="sh_symbol">,</span> error<span class="sh_symbol">,</span> <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span> <span class="sh_symbol">);</span>
+<span class="sh_comment">// ..is equivalent to: navigator.contacts(/* parameters */)</span></pre>
+ </div>
+
+ <div class="section" id="conformance"><!--OddPage--><h2><span class="secno">2. </span>Conformance</h2><p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
+<p>The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>, and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<cite><a href="#bib-RFC2119" rel="biblioentry" class="bibref">RFC2119</a></cite>].</p>
+
+ <p>
+ This specification defines conformance criteria that apply to a single product: the
+ <dfn id="ua">user agent</dfn> that implements the interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement
+ them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification
+ [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>], as this specification uses that specification and terminology.
+ </p>
+ <p>
+ A conforming implementation is required to implement all fields defined in this specification.
+ </p>
+
+ <div class="section" id="terminology">
+ <h3><span class="secno">2.1 </span>Terminology</h3>
+ <p>
+ The terms <dfn id="dfn-document-base-url">document base URL</dfn>, <dfn id="dfn-browsing-context">browsing context</dfn>, <dfn id="dfn-event-handler-attribute">event handler attribute</dfn>,
+ <dfn id="dfn-event-handler-event-type">event handler event type</dfn>, <dfn id="dfn-task">task</dfn>, <dfn id="dfn-task-source">task source</dfn> and <dfn id="dfn-task-queues">task queues</dfn>
+ are defined by the HTML5 specification [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>].
+ </p>
+ <p>
+ The <a class="internalDFN" href="#dfn-task-source">task source</a> used by this specification is the <dfn id="dfn-device-task-source">device task source</dfn>.
+ </p>
+ <p>
+ To <dfn id="dfn-dispatch-a-success-event">dispatch a <code>success</code> event</dfn> means that an event with the name
+ <code>success</code>, which does not bubble and is not cancellable, and which uses the
+ <code>Event</code> interface, is to be dispatched at the <a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a> object.
+ </p>
+ <p>
+ To <dfn id="dfn-dispatch-an-error-event">dispatch an <code>error</code> event</dfn> means that an event with the name
+ <code>error</code>, which does not bubble and is not cancellable, and which uses the <code>Event</code>
+ interface, is to be dispatched at the <a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> object.
+ </p>
+ </div>
+ </div>
+
+ <div class="section" id="security-and-privacy-considerations">
+ <!--OddPage--><h2><span class="secno">3. </span>Security and Privacy Considerations</h2>
+ <p>
+ The API defined in this specification can be used to find contact information from a user's address
+ books. This discloses information related to a user's contacts such as their phone numbers, email
+ addresses and other personally identifying information. The distribution of this information could
+ potentially compromise the user's privacy, or the user's contacts' privacy. A conforming implementation
+ of this specification <em title="must" class="rfc2119">must</em> provide a mechanism that protects the user's privacy and this mechanism should
+ ensure that no contact information is retrievable without the user's express permission.
+ </p>
+ <div class="section" id="privacy-considerations-for-implementors-of-the-contacts-api">
+ <h3><span class="secno">3.1 </span>Privacy considerations for implementors of the Contacts API</h3>
+ <p>
+ A <a class="product-ua" href="#ua">user agent</a> <em title="must not" class="rfc2119">must not</em> provide contact information to Web sites without the express
+ permission of the user. A <a class="internalDFN" href="#ua">user agent</a> <em title="must" class="rfc2119">must</em> acquire permission through a user interface, unless
+ they have prearranged trust relationships with users, as described below. The user interface <em title="must" class="rfc2119">must</em>
+ include the <a class="internalDFN" href="#dfn-document-base-url">document base URL</a>. Those permissions that are acquired through the user interface
+ and that are preserved beyond the current browsing session (i.e. beyond the time when the <a class="internalDFN" href="#dfn-browsing-context">browsing
+ context</a> is navigated to another URL) <em title="must" class="rfc2119">must</em> be revocable and a <a class="internalDFN" href="#ua">user agent</a> <em title="must" class="rfc2119">must</em> respect revoked
+ permissions.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted
+ permission for the same Web site to access other methods provided by this API, or to access the same
+ method with a different set of arguments, as part of the same permission context. If a user has
+ expressed permission for an implementation to, e.g. find a set of existing contacts, the implementation
+ <em title="must" class="rfc2119">must</em> seek the user's express permission if and when any additional <code>find</code> function is called
+ on this API.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#ua">user agent</a> may have prearranged trust relationships that do not require such user
+ interfaces. For example, while a Web browser will present a user interface when a Web site performs an
+ address book request, a Widget [<cite><a href="#bib-WIDGETS" rel="biblioentry" class="bibref">WIDGETS</a></cite>] runtime <em title="may" class="rfc2119">may</em> have a prearranged, delegated security
+ relationship with the user and, as such, a suitable alternative security and privacy mechanism with
+ which to authorise the retrieval of contact information.
+ </p>
+ </div>
+
+ <div id="privacy-considerations-for-recipients-of-contact-information" class="informative section">
+ <h3><span class="secno">3.2 </span>Privacy considerations for recipients of contact information</h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Web sites operators that retrieve contacts information using this API are denoted as recipients
+ below.
+ </p>
+ <p>
+ Recipients should only request contact information when necessary, and only use the contact
+ information for the task for which it was provided to them.
+ </p>
+ <p>
+ Recipients should dispose of contact information once that task is completed, unless expressly
+ permitted to retain it by the user. Recipients should also take measures to protect this information
+ against unauthorised access. If contact information is stored, users should be allowed to update and
+ delete this information.
+ </p>
+ <p>
+ The recipient of contact information should not retransmit the contact information without the
+ user's express permission. Care should be taken when retransmitting and use of encryption is
+ encouraged.
+ </p>
+ <p>
+ Recipients should clearly and conspicuously disclose the fact that they are collecting contact data,
+ the purpose for the collection, how long the data is retained, how the data is secured, how the data is
+ shared if it is shared, how users can access, update and delete the data, and any other choices that
+ users have with respect to the data. This disclosure should include an explanation of any exceptions to
+ the guidelines listed above.
+ </p>
+ <p>
+ Note that even if a user gives permission to share their contact information this can have serious
+ privacy implications for those parties whose contacts are shared, as they may not wish such sharing to
+ occur. This should be considered by web services when requesting and using such information.
+ </p>
+ </div>
+ <div id="additional-implementation-considerations" class="informative section">
+ <h3><span class="secno">3.3 </span>Additional implementation considerations</h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are
+ also advised to consider the following aspects that can negatively affect the privacy of their users:
+ in certain cases, users can inadvertently grant permission to the <a class="internalDFN" href="#ua">user agent</a> to disclose their contacts
+ to Web sites. In other cases, the content hosted at a certain URL changes in such a way that the
+ previously granted contact permissions no longer apply as far as the user is concerned. Or the users
+ might simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive
+ measures are an implementation responsibility and not prescribed by this specification. However, in
+ designing these measures, implementers are advised to enable user awareness of contact sharing, and to
+ provide easy access to interfaces that enable revocation of permissions that web applications have to
+ access this API.
+ </p>
+ </div>
+ </div>
+
+ <div class="section" id="api-description">
+ <!--OddPage--><h2><span class="secno">4. </span>API Description</h2>
+
+ <div class="section" id="servicecontacts-interface">
+ <h3><span class="secno">4.1 </span><a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface</h3>
+ <p id="ta-aa" class="product-ua">
+ The <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface is exposed on the <a class="externalDFN">Navigator</a>
+ object [<cite><a href="#bib-NAVIGATOR" rel="biblioentry" class="bibref">NAVIGATOR</a></cite>]. Its goal is to provide an access point to the functionality in this
+ specification.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ServiceContacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ServiceContacts</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span> <span class="idlAttrName"><a href="#widl-ServiceContacts-contacts">contacts</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes"><h4><span class="secno">4.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ServiceContacts-contacts"><code>contacts</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span>, readonly</dt><dd>The object through which the contacts functionality can be accessed.<div><em>No exceptions.</em></div></dd></dl></div>
+ <pre class="idl"><span class="idlImplements"><a>Navigator</a> implements <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a>;</span></pre><div class="idlImplementsDesc"><p>All instances of the <code><a>Navigator</a></code> type are defined to also implement the <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface.</p></div>
+ </div>
+
+ <div class="section" id="contacts-interface">
+ <h3><span class="secno">4.2 </span><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface</h3>
+ <p>
+ The <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface exposes a database of contact information that may be retrieved.
+ </p>
+ <p>
+ Multiple contact groups can be represented within this unified address book by specifying consistent
+ <a href="#widl-Contact-categories"><code>categories</code></a> values as part of individual
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering on the required
+ <a href="#widl-Contact-categories"><code>categories</code></a> values via
+ the <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contacts</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>caller void</a></span> <span class="idlMethName"><a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find</a></span> (<span class="idlParam"><span class="idlParamType"><a>DOMString</a>[]</span> <span class="idlParamName">fields</span></span>, <span class="idlParam"><span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></span> <span class="idlParamName">errorCB</span></span>, <span class="idlParam">optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a></span> <span class="idlParamName">options</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods"><h4><span class="secno">4.2.1 </span>Methods</h4><dl class="methods"><dt id="widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options"><code>find</code></dt><dd>
+ <p>
+ Find contacts in the address book according to the <a class="internalDFN" href="#dfn-find-contacts-process">find contacts process</a> detailed
+ below.
+ </p>
+ <p>
+ This method takes two, three or four arguments. When called, it starts the following
+ <dfn id="dfn-find-contacts-process">find contacts process</dfn>:
+ </p>
+ <ol class="rule">
+ <li>
+ Let <var>successCallback</var> be the callback indicated by the method's second argument.
+ </li>
+ <li>
+ Let <var>errorCallback</var> be the callback indicated by the method's third argument, if any, or null otherwise.
+ </li>
+ <li id="ta-ai" class="product-ua">If <var>successCallback</var> is null, then throw a TypeError (as defined in [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>]).</li>
+ <li class="product-ua" id="ta-ag">
+ If there is a <a class="internalDFN" href="#dfn-task">task</a> from the <a class="internalDFN" href="#dfn-device-task-source">device task source</a> in one of the <a class="internalDFN" href="#dfn-task-queues">task
+ queues</a> (e.g. an existing <code>find()</code> operation is still pending a response), run these
+ substeps:
+ <ol>
+ <li>
+ If <var>errorCallback</var> is not null, let <var>error</var> be a <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a>
+ object whose code attribute has the value <code>PENDING_OPERATION_ERROR</code> and
+ queue a task to invoke <var>errorCallback</var> with <var>error</var> as its argument.
+ </li>
+ <li>Abort this operation.</li>
+ </ol>
+ </li>
+ <li>
+ Return, and run the remaining steps asynchronously.
+ </li>
+ <li>
+ Let <var>results</var> be the array of <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> objects obtained by searching contacts in the address book
+ according to the rules defined in <a href="#contact-search-processing">Contact Search Processing</a>,
+ or null if the search has failed.
+ </li>
+ <li>
+ If <var>results</var> is null, run these substeps:
+ <ol>
+ <li>
+ If <var>errorCallback</var> is not null, let <var>error</var> be a <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a>
+ object whose code attribute has its value set according to the type of failure that occurred and
+ queue a task to invoke <var>errorCallback</var> with <var>error</var> as its argument.
+ </li>
+ <li>Abort this operation.</li>
+ </ol>
+ </li>
+ <li>Queue a task to invoke <var>successCallback</var> with <var>results</var> as its argument.</li>
+ </ol>
+
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">fields</td><td class="prmType"><code><a>DOMString</a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.</td></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">Function to call when the asynchronous operation completes successfully.</td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptTrue">✔</td><td class="prmDesc">Function to call when the asynchronous operation fails.</td></tr><tr><td class="prmName">options</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptTrue">✔</td><td class="prmDesc">The options to apply to the output of this method.</td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>caller void</a></code></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contact-interface">
+ <h3><span class="secno">4.3 </span><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface</h3>
+ <p>
+ The <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface captures the properties of a contact object. All properties included in this
+ interface have a corresponding definition in [<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>], [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] (aka vCard), and [<cite><a href="#bib-OMA-CAB" rel="biblioentry" class="bibref">OMA-CAB</a></cite>], thereby
+ allowing the API to be supported across implementations supporting these various contact formats.
+ </p>
+ <p id="ta-ac" class="product-ua">
+ All <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> objects <em title="must" class="rfc2119">must</em> include all attributes supported by the implementation, regardless
+ of whether these attributes have been assigned a <code>null</code> value or not. If a supported attribute has not been
+ assigned a value by the user or the implementation, then this attribute <em title="must" class="rfc2119">must</em> still be present in the
+ resulting <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+ <p>
+ Additional attributes <em title="may" class="rfc2119">may</em> be included according to the provisions detailed in
+ <a href="#extended-contact-properties-and-parameters">Extended Contact Properties and Parameters</a>. If an
+ extended attribute is supported by the current implementation and has not been assigned a value by the
+ user or the implementation, then this extended attribute <em title="must" class="rfc2119">must</em> still be present in the resulting
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contact">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contact</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-id">id</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-Contact-displayName">displayName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a>?</span> <span class="idlAttrName"><a href="#widl-Contact-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-Contact-nickname">nickname</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-phoneNumbers">phoneNumbers</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-emails">emails</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-addresses">addresses</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-ims">ims</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-organizations">organizations</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>Date</a>?</span> <span class="idlAttrName"><a href="#widl-Contact-birthday">birthday</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-Contact-note">note</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-photos">photos</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-categories">categories</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]?</span> <span class="idlAttrName"><a href="#widl-Contact-urls">urls</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-1"><h4><span class="secno">4.3.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-Contact-addresses"><code>addresses</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more physical addresses associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-birthday"><code>birthday</code> of type <span class="idlAttrType"><a>Date</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains birthday of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <p>
+ The year value <em title="may" class="rfc2119">may</em> be set to 0000 when the age of the <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> is private or the year is not
+ available.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-categories"><code>categories</code> of type array of <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains one or more user-defined categories/tags/labels associated with this
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>. e.g. "family", "favourite", "cryptozoologists".
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-displayName"><code>displayName</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the name of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> in a form that is suitable for display
+ to the user.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-emails"><code>emails</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more email addresses associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-id"><code>id</code> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly</dt><dd>
+ <p>
+ A globally unique identifier for the given <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> object.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> maintain this globally unique identifier when a <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> is added
+ to an address book.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-ims"><code>ims</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more instant messaging identifiers associated with this
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-name"><code>name</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents the full name of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> indicated by the name components
+ associated with the <a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> object.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-nickname"><code>nickname</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the nickname (or a casual name) for this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-note"><code>note</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the personal notes (free-text) for this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> that is managed by the
+ user of the address book.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-organizations"><code>organizations</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more organizations associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-phoneNumbers"><code>phoneNumbers</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute captures one or more phone numbers associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-photos"><code>photos</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more photos associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <p>
+ The photos <em title="must" class="rfc2119">must</em> be specified in the <code>value</code> attribute of the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> object
+ by using a URL pointing to an image resource. The <code>data:</code> URI scheme may be used in order
+ to provide inline data.
+ </p>
+ <p class="note">
+ This attribute <em title="should not" class="rfc2119">should not</em> be used to send down arbitrary photos taken by this user,
+ but specifically profile photos of the contact suitable for display when describing the
+ contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-urls"><code>urls</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span>, nullable</dt><dd>
+ <p>
+ This attribute represents one or more URLs associated with this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> e.g. personal web page,
+ blog.
+ </p>
+ <p>
+ The web resources <em title="must" class="rfc2119">must</em> be specified using the <code>value</code> attribute of the
+ <code>ContactField</code> object, and its <code>type</code> field may be set to "blog" or
+ "profile".
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactname-interface">
+ <h3><span class="secno">4.4 </span><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> interface</h3>
+
+ <p>
+ The <a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> interface describes a contact's name.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactName">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactName</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-familyName">familyName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-givenName">givenName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-middleName">middleName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-honorificPrefix">honorificPrefix</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactName-honorificSuffix">honorificSuffix</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-2"><h4><span class="secno">4.4.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactName-familyName"><code>familyName</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the family name (also referred to as the last name) of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the full name, including all the individual components such as
+ <code>givenName</code>, <code>middleName</code>, <code>familyName</code>, <code>prefix</code>,
+ <code>suffix</code> as appropriate for the user's culture, and formatted for display (e.g. <code>Mr. Joe Smith
+ Jr</code>).
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-givenName"><code>givenName</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the given name (also referred to as the first name) of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificPrefix"><code>honorificPrefix</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the honorific prefix (or title) of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>. E.g. Mr., Dr., Ms.,
+ Mrs.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificSuffix"><code>honorificSuffix</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the honorific suffix of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>. E.g. Jr, III, Sr.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-middleName"><code>middleName</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the middle name of this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactfield-interface">
+ <h3><span class="secno">4.5 </span><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface</h3>
+
+ <p>
+ The <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface is a reusable component that is used to capture contact fields of the
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface that have some modicum of structure.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactField">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactField</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactField-value">value</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactField-pref">pref</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-3"><h4><span class="secno">4.5.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactField-pref"><code>pref</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ This attribute indicates whether this instance of the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is the
+ preferred, or primary, value for the contact property this <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is
+ representing in the <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface. By default, the value is <code>false</code>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the type information for this <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> and its content varies subject
+ to the contact property this <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is representing. For example, if the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>
+ is representing a <code>phoneNumber</code> property, the <code>type</code> attribute can be set to
+ <code>home</code>, <code>mobile</code>; if the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is representing the <code>ims</code>
+ property, the type attribute could be set to <code>xmpp</code>, <code>irc</code>, <code>bbm</code>, etc.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-value"><code>value</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the value for this <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> and its content varies subject to the
+ contact property this <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is representing. For example, if the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is
+ representing an <code>email</code>, the value attribute could be set to <code>JoeSmith@example.com</code>,
+ and if the <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> is representing a <code>url</code>, the value attribute can be set to
+ <code>http://www.example.org/joesmith</code>, etc.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactaddress-interface">
+ <h3><span class="secno">4.6 </span><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface</h3>
+
+ <p>
+ The <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface is a reusable component that is used to capture addresses
+ within the <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAddress">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAddress</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-pref">pref</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-streetAddress">streetAddress</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-locality">locality</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-region">region</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-postalCode">postalCode</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactAddress-country">country</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-4"><h4><span class="secno">4.6.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAddress-country"><code>country</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the country name corresponding to this <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the full physical address including <code>street</code>, <code>locality</code>,
+ <code>region</code>, <code>postalCode</code>, and <code>country</code> as appropriate, and formatted for
+ display.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-locality"><code>locality</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the locality (or city) name corresponding to this <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-postalCode"><code>postalCode</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the postal code (or zip) corresponding to this <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-pref"><code>pref</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ This attribute indicates whether this instance of the <code>ContactAddress</code> is the preferred, or primary, value for the contact.
+ By default, the value is <code>false</code>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-region"><code>region</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the region (or state/province) name corresponding to this <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-streetAddress"><code>streetAddress</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the street address corresponding to this <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the type of address this object is representing (e.g. <code>work</code>, <code>home</code>, <code>premises</code>, etc).
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactorganization-interface">
+ <h3><span class="secno">4.7 </span><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a> interface</h3>
+
+ <p>
+ The <a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a> interface is a reusable component that is used to support contact
+ organisations within the <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactOrganization">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactOrganization</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-pref">pref</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOrganization-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOrganization-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOrganization-department">department</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactOrganization-title">title</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-5"><h4><span class="secno">4.7.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactOrganization-department"><code>department</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ The department within which this <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> works.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-name"><code>name</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ The name of the organisation.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-pref"><code>pref</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ This attribute indicates whether this instance of the <code>ContactOrganization</code> is the preferred, or
+ primary, value for the contact. By default, the value is <code>false</code>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-title"><code>title</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ The job title that the <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> holds inside this organisation.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p>
+ This attribute contains the type of organization this object is representing.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactfindoptions-interface">
+ <h3><span class="secno">4.8 </span><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> interface</h3>
+ <p>
+ The <a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> interface describes the options that can be applied to contact searching.
+ When a <a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> parameter is provided to the <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation, it should be processed according to the provisions detailed in
+ <a href="#options-processing">Options Processing</a>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindOptions">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindOptions</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-filter">filter</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-multiple">multiple</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-6"><h4><span class="secno">4.8.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactFindOptions-filter"><code>filter</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ A string-based <a class="internalDFN" href="#dfn-search-filter">search filter</a> which provides a hint to the user agent to facilitate contacts selection by the user.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-multiple"><code>multiple</code> of type <span class="idlAttrType"><a>boolean</a></span>, nullable</dt><dd>
+ A boolean value to indicate whether multiple Contact objects are wanted as part of the
+ <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ By default this option is set to <code>false</code>.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+
+ <div class="section" id="contactfindcb-interface">
+ <h3><span class="secno">4.9 </span><a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a> interface</h3>
+ <p>
+ This is the wrapper interface for callbacks indicating success of the <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactFindCB-onsuccess-void-ContactArray-contactObjs">onsuccess</a></span> (<span class="idlParam"><span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</span> <span class="idlParamName">contactObjs</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-1"><h4><span class="secno">4.9.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactFindCB-onsuccess-void-ContactArray-contactObjs"><code>onsuccess</code></dt><dd>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObjs</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ An array of <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> objects resulting from the given <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a>
+ <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+
+ <div class="section" id="event-handler-attributes">
+ <h4><span class="secno">4.9.2 </span>Event Handler Attributes</h4>
+ <p>
+ The following is the <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a> (and its corresponding <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event
+ type</a>) that <em title="must" class="rfc2119">must</em> be supported as a DOM attribute by the <a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a> object.
+ </p>
+ <table class="simple">
+ <thead>
+ <tr>
+ <th><a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a></th>
+ <th><a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code>onsuccess</code></strong></td>
+ <td><code>success</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+
+ <div class="section" id="contacterrorcb-interface">
+ <h3><span class="secno">4.10 </span><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> interface</h3>
+ <p>
+ This is the wrapper interface for callbacks indicating failure of the <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactErrorCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactErrorCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactErrorCB-onerror-void-ContactError-error">onerror</a></span> (<span class="idlParam"><span class="idlParamType"><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></span> <span class="idlParamName">error</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-2"><h4><span class="secno">4.10.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactErrorCB-onerror-void-ContactError-error"><code>onerror</code></dt><dd>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">error</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">The <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> object capturing the type of the error.</td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+
+ <div class="section" id="event-handler-attributes-1">
+ <h4><span class="secno">4.10.2 </span>Event Handler Attributes</h4>
+ <p>
+ The following is the <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a> (and its corresponding <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event
+ type</a>) that <em title="must" class="rfc2119">must</em> be supported as a DOM attribute by the <a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> object.
+ </p>
+
+ <table class="simple">
+ <thead>
+ <tr>
+ <th><a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a></th>
+ <th><a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code><strong>onerror</strong></code></strong></td>
+ <td><code>error</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+
+ <div class="section" id="contacterror-interface">
+ <h3><span class="secno">4.11 </span><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface</h3>
+ <p>
+ The <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface encapsulates all errors in the manipulation of
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> objects.
+ </p>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactError</span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-UNKNOWN_ERROR">UNKNOWN_ERROR</a></span> = <span class="idlConstValue">0</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-INVALID_ARGUMENT_ERROR">INVALID_ARGUMENT_ERROR</a></span> = <span class="idlConstValue">1</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-TIMEOUT_ERROR">TIMEOUT_ERROR</a></span> = <span class="idlConstValue">2</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PENDING_OPERATION_ERROR">PENDING_OPERATION_ERROR</a></span> = <span class="idlConstValue">3</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-IO_ERROR">IO_ERROR</a></span> = <span class="idlConstValue">4</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_SUPPORTED_ERROR">NOT_SUPPORTED_ERROR</a></span> = <span class="idlConstValue">5</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PERMISSION_DENIED_ERROR">PERMISSION_DENIED_ERROR</a></span> = <span class="idlConstValue">20</span>;</span>
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactError-code">code</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-7"><h4><span class="secno">4.11.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactError-code"><code>code</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, readonly</dt><dd>An error code assigned by an implementation when an error has occurred in Contacts API
+ processing.<div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="constants"><h4><span class="secno">4.11.2 </span>Constants</h4><dl class="constants"><dt id="widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>An invalid parameter was provided when the requested method was invoked.</dd><dt id="widl-ContactError-IO_ERROR"><code>IO_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>An error occurred in communication with the underlying implementation that meant the requested
+ method could not complete.</dd><dt id="widl-ContactError-NOT_SUPPORTED_ERROR"><code>NOT_SUPPORTED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>The requested method is not supported by the current implementation.</dd><dt id="widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>There is already a <a class="internalDFN" href="#dfn-task">task</a> in the <a class="internalDFN" href="#dfn-device-task-source">device task source</a>.</dd><dt id="widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>Access to the requested information was denied by the implementation or by the user.</dd><dt id="widl-ContactError-TIMEOUT_ERROR"><code>TIMEOUT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>The requested method timed out before it could be completed.</dd><dt id="widl-ContactError-UNKNOWN_ERROR"><code>UNKNOWN_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>An unknown error occurred.</dd></dl></div>
+ </div>
+ </div>
+
+ <div class="section" id="contact-search-processing">
+ <!--OddPage--><h2><span class="secno">5. </span><a>Contact Search Processing</a></h2>
+
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ method provides an operation to search for one of more <a href="#contact-interface"><code>Contact</code></a> objects within the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+
+ <div class="section" id="search-qualifiers">
+ <h3><span class="secno">5.1 </span>Search Qualifiers</h3>
+
+ <p>
+ The <dfn id="dfn-search-qualifier">search qualifier</dfn> provides an application with a way to request the specific subset of
+ <a href="#contact-interface"><code>Contact</code></a> properties it wishes to obtain in any resulting
+ successful callback. The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is deployed to minimize the data that needs to be
+ shared with an application in order to let that application fulfill its function on behalf of the user.
+ The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is included within a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation as
+ the <code>fields</code> parameter.
+ </p>
+
+ <p id="ta-aj" class="product-ua">
+ A <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> <em title="must" class="rfc2119">must</em> be specified from a requesting application as a part of any <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p id="ta-ab" class="product-ua">
+ If the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation and
+ the current find() operation was invoked with a non-<code>null</code>
+ <code>errorCB</code> parameter, then the user agent <em title="must" class="rfc2119">must</em> invoke the <code>errorCB</code> function
+ with an error code of <a href="#widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code></a>.
+ </p>
+
+ <p id="ta-ak" class="product-ua">
+ In the case that the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>non-zero-length</em> then the
+ current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation <em title="must" class="rfc2119">must</em> return only the matching <a href="#contact-interface"><code>Contact</code></a> properties within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+
+ <p id="ta-al" class="product-ua">
+ If a provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> element (<code>fields[x]</code>) does not match a <a href="#contact-interface"><code>Contact</code></a> attribute, <code>fields[x]</code> <em title="should" class="rfc2119">should</em> be ignored when
+ executing the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <div class="section" id="advanced-search-qualifiers">
+ <h4><span class="secno">5.1.1 </span>Advanced Search Qualifiers</h4>
+
+ <p>
+ We call <dfn id="dfn-composed-attributes">composed attributes</dfn> <a href="#contact-interface"><code>Contact</code></a>
+ attributes of types <code>object</code>, which contain information only available
+ only through child attributes of that object, or <code>array</code>.
+ </p>
+
+ <p class="product-ua" id="ta-ad">
+ A requesting application <em title="must" class="rfc2119">must</em> be able to request both the full composed <a href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts
+ of a composed <a href="#contact-interface"><code>Contact</code></a> attribute in the <a class="internalDFN" href="#dfn-search-qualifier">search
+ qualifier</a> provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p>
+ For example, the <code>name</code> attribute of a <a href="#contact-interface"><code>Contact</code></a> object is defined to be of composed type <a href="#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may
+ request either the full composed attribute (i.e. <code>name</code>) or specific individual attributes
+ of this composed attribute (i.e. <code>name.formatted</code>, <code>name.familyName</code>,
+ <code>name.givenName</code>, <code>name.middleName</code>, <code>name.honorificPrefix</code>,
+ <code>name.honorificSuffix</code>) as part of a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation's
+ <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </p>
+
+ <p id="ta-af" class="product-ua">
+ In the case that a composed <a href="#contact-interface"><code>Contact</code></a> attribute is
+ defined as an array of composed objects, specific individual attributes can be referenced
+ by using the composed attribute name, a dot (<code>.</code>) character and the individual attribute
+ to be retrieved.
+ </p>
+
+ <p>
+ For example, the <code>addresses</code> attribute of <a href="#contact-interface"><code>Contact</code></a> allows multiple <a href="#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request
+ individual attributes of this composed attribute an application would request e.g.
+ <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ </p>
+ </div>
+
+ <div class="example">
+ <p>
+ The following Contact search is initiated:
+ </p>
+ <pre class="sh_javascript sh_sourceCode">
+ navigator<span class="sh_symbol">.</span><span class="sh_function">contacts</span><span class="sh_symbol">(</span> <span class="sh_symbol">[</span><span class="sh_string">'emails.value'</span><span class="sh_symbol">,</span> <span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'friends'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>j <span class="sh_keyword">in</span> contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">)</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">[</span>j<span class="sh_symbol">]);</span>
+ <span class="sh_cbracket">}</span>
+ <span class="sh_cbracket">}</span> <span class="sh_symbol">);</span>
+ </pre>
+
+ <p>
+ The above example logically implies:
+ </p>
+
+ <ol class="rule">
+ <li>Return only the valid <a href="#contact-interface"><code>Contact</code></a> attributes
+ requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> (<code>name</code>, <code>emails.value</code> -
+ <code>friends</code> is not a valid <a href="#contact-interface"><code>Contact</code></a> attribute
+ so ignore this element).</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="section" id="options-processing">
+ <h3><span class="secno">5.2 </span>Options Processing</h3>
+
+ <div class="section" id="search-cardinality">
+ <h4><span class="secno">5.2.1 </span>Search Cardinality</h4>
+
+ <p id="ta-am" class="product-ua">
+ By default, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence or a single <a href="#contact-interface"><code>Contact</code></a> object, accessible as part of the sequence returned in
+ the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+
+ <p id="ta-ae" class="product-ua">
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is
+ provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation and its <code>multiple</code> attribute is set to
+ <code>true</code>, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence, a single <a href="#contact-interface"><code>Contact</code></a> object or <var>[X]</var> number of <a href="#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in
+ the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+ </div>
+
+ <div class="section" id="search-filters">
+ <h4><span class="secno">5.2.2 </span>Search Filters</h4>
+
+ <p>
+ A <dfn id="dfn-search-filter">search filter</dfn> may be specified from a requesting web application to provide a hint to the user agents as to which contacts the user can select to share with the application.</p>
+
+ <p>The <a class="internalDFN" href="#dfn-search-filter">search filter</a> is defined through the <code>filter</code>
+ attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object
+ provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p>The actual usage of this <a class="internalDFN" href="#dfn-search-filter">search filter</a> is user-agent dependant, but is expected to represent
+ the logical union of provided values that are matched therein.
+ </p>
+ </div>
+ </div>
+ </div>
+
+ <div class="section" id="extended-contact-properties-and-parameters">
+ <!--OddPage--><h2><span class="secno">6. </span>Extended Contact Properties and Parameters</h2>
+
+ <p>
+ The properties and parameters defined on the <a href="#contact-interface"><code>Contact</code></a>
+ interface <em title="may" class="rfc2119">may</em> be extended by implementors of this specification.
+ </p>
+
+ <p>
+ Non-standard, private properties and parameters <em title="should" class="rfc2119">should</em> have a prefixed name starting with
+ <code>X</code> (U+0058 LATIN CAPITAL LETTER X) or use a vendor-specific prefix. Extended properties and
+ parameters can be defined bilaterally between <a class="internalDFN" href="#ua" title="user agent">user agents</a> without outside
+ registration or standardization.
+ </p>
+
+ <p>
+ It is <em title="recommended" class="rfc2119">recommended</em> that authors define both a formal vCard grammar and a WebIDL grammar for their
+ proposed extension to ensure interoperability between vCard databases and other non-standard Contact
+ databases and formats. It is also <em title="recommended" class="rfc2119">recommended</em> that authors provide documentation of their extension
+ properties and parameters within the public domain.
+ </p>
+
+ <div class="example">
+ <p>
+ A new parameter is required by Company X to provide information related to a user's accounts
+ registered across different networks and services.
+ </p>
+
+ <p>
+ The [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>] syntax for this parameter is defined as follows:
+ </p>
+
+ <pre class="idl"><span class="idlImplements"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> implements <a class="idlType" href="#idl-def-ContactExtended"><code>ContactExtended</code></a>;</span></pre><div class="idlImplementsDesc">
+
+ </div>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactExtended">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactExtended</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactExtended-Xaccounts">Xaccounts</a></span>;</span>
+};</span>
+</pre><div class="section"><h3 id="attributes-8">Attributes</h3><dl class="attributes"><dt id="widl-ContactExtended-Xaccounts"><code>Xaccounts</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a></span></dt><dd>One or more user accounts. See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>accounts</code>].<div><em>No exceptions.</em></div></dd></dl></div>
+
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAccount">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAccount</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-domain">domain</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-username">username</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-userid">userid</a></span>;</span>
+};</span>
+</pre><div class="section"><h3 id="attributes-9">Attributes</h3><dl class="attributes"><dt id="widl-ContactAccount-domain"><code>domain</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>domain</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-userid"><code>userid</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>userid</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-username"><code>username</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>username</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+
+ <p>
+ The corresponding vCard [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] notation for this parameter is defined as follows:
+ </p>
+ <pre> The following ABNF grammar extends the grammar found in [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] (Section 4).
+
+ <strong>X-ACCOUNT</strong>
+
+ Purpose: To specify the components of the accounts for the vCard
+ object.
+
+ Value type: A single structured text value, separated by the SEMI-
+ COLON character (ASCII decimal 59).
+
+ Cardinality: (0,n)
+
+ Special notes: The structured type value consists of a sequence of
+ account components. The component values must be specified in
+ their corresponding position. The structured type value
+ corresponds, in sequence, to the domain; the username; the userid.
+ When a component value is missing, the associated component
+ separator must still be specified.
+
+ The text components are separated by the SEMI-COLON character
+ (ASCII decimal 59).
+
+ ABNF:
+
+ X-ACCOUNT-param = ; no parameter allowed
+ X-ACCOUNT-value = list-component 3(";" list-component)
+ </pre>
+
+ <p>
+ This parameter will be used within the Contacts API as follows:
+ </p>
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_keyword">var</span> contact <span class="sh_symbol">=</span> <span class="sh_symbol">...;</span> <span class="sh_comment">// ...obtain individual contact object</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>domain<span class="sh_symbol">);</span> <span class="sh_comment">// thesocialnetwork.com</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>username<span class="sh_symbol">);</span> <span class="sh_comment">// null</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>userid<span class="sh_symbol">);</span> <span class="sh_comment">// 344aesq2</span>
+ <span class="sh_cbracket">}</span>
+ </pre>
+
+ <p>
+ This parameter will be used within the vCard format [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>]] as follows:
+ </p>
+ <pre> X-ACCOUNT;thesocialnetwork.com;;344aesq2
+ </pre>
+ </div>
+ </div>
+
+ <div class="section" id="api-invocation-via-dom-events">
+ <!--OddPage--><h2><span class="secno">7. </span>API Invocation via DOM Events</h2>
+
+ <p>
+ The API contained in this document can be invoked either programmatically (for example, inline within
+ a general script) or resulting from the <a class="internalDFN" href="#dfn-interaction-of-a-user">interaction of a user</a>.
+ </p>
+
+ <p>
+ The <dfn id="dfn-interaction-of-a-user">interaction of a user</dfn> is when a user invokes the API from an <a href="http://dev.w3.org/html5/markup/elements.html"><code>HTMLElement</code></a> [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>] within the current
+ <a class="internalDFN" href="#dfn-browsing-context">browsing context</a> via a <a class="internalDFN" href="#dfn-valid-auto-invocation-event">valid auto-invocation event</a>.
+ </p>
+
+ <p>
+ A <dfn id="dfn-valid-auto-invocation-event">valid auto-invocation event</dfn> includes any of the following event types, as defined in
+ [<cite><a href="#bib-DOM-LEVEL-3-EVENTS" rel="biblioentry" class="bibref">DOM-LEVEL-3-EVENTS</a></cite>]:
+ </p>
+
+ <ul>
+ <li><code>click</code></li>
+
+ <li><code>dblclick</code></li>
+
+ <li><code>mouseup</code></li>
+ </ul>
+
+ <p>
+ The <code>find()</code> method on <a href="#contacts-interface"><code>Contacts</code></a> should, if
+ the method was invoked by an <a class="internalDFN" href="#dfn-interaction-of-a-user">interaction of a user</a> (as opposed to having been created and executed
+ in general script), display the <a class="internalDFN" href="#dfn-contact-picker-1">Contact Picker</a> directly.
+ </p>
+ </div>
+
+ <div id="user-interaction-guidelines" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">A. </span>User Interaction Guidelines</h2><p><em>This section is non-normative.</em></p>
+
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the
+ contact information that may be shared from their unified address book. This annex provides some examples
+ of a conformant user experience that this specification enables.
+ </p>
+
+ <div class="section" id="accessing-contact-information---example--1">
+ <h3><span class="secno">A.1 </span>Accessing Contact Information - Example #1</h3>
+
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+ <span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+ navigator<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span>
+
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+
+ <p>
+ As a result of executing this code, the <a class="internalDFN" href="#ua">user agent</a> may provide a non-blocking <dfn id="dfn-contact-search-notification">contact
+ search notification</dfn> as follows:
+ </p>
+
+ <p align="center"><img src="contacts_notification.png" alt="Contact Search Notification"><br>
+ (<a href="contacts_notification.png">View as PNG</a>)
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a class="internalDFN" href="#ua">user agent</a> may provide a <dfn id="dfn-contact-picker">contact picker</dfn>,
+ utilizing all of the parameters provided in the find() operation as follows:
+ </p>
+
+ <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is
+ requesting and the option to select one or more contacts (as appropriate) from the user interface.
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
+ associated to the current find() operation will be invoked with the contact information selected by the
+ user provided as the only parameter.
+ </p>
+
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
+ user should easily be able to review and revoke access that web applications have to this API
+ at a later time.
+ </p>
+ </div>
+
+ <div class="section" id="accessing-contact-information---example--2">
+ <h3><span class="secno">A.2 </span>Accessing Contact Information - Example #2</h3>
+
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>input type<span class="sh_symbol">=</span><span class="sh_string">"button"</span> value<span class="sh_symbol">=</span><span class="sh_string">"Share Contacts"</span> onclick<span class="sh_symbol">=</span><span class="sh_string">"getContacts()"</span> <span class="sh_symbol">/></span>
+
+ <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">getContacts</span><span class="sh_symbol">()</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+ <span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+ navigator<span class="sh_symbol">.</span><span class="sh_function">contacts</span><span class="sh_symbol">(</span> <span class="sh_symbol">[</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span> filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span> <span class="sh_cbracket">}</span> <span class="sh_symbol">);</span>
+ <span class="sh_comment">// is equivalent to: navigator.contacts.find(/* parameters */);</span>
+ <span class="sh_cbracket">}</span>
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+
+ <p>
+ This code may render as follows within the <a class="internalDFN" href="#ua">user agent</a>:
+ </p>
+
+ <p align="center"><img src="contacts_element.png" alt="Contact Search via DOM Events"><br>
+ (<a href="contacts_element.png">View as PNG</a>)
+ </p>
+
+ <p>
+ If the user clicks on the rendered button element then the <a class="internalDFN" href="#ua">user agent</a> may directly provide a
+ <dfn id="dfn-contact-picker-1">contact picker</dfn>, as defined in <a href="#api-invocation-via-dom-events">API Invocation via
+ DOM Events</a>, utilizing all of the parameters provided in the <code>find()</code> operation as
+ follows:
+ </p>
+
+ <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is
+ requesting and the option to select one or more contacts (as appropriate) from the user interface.
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
+ associated to the current find() operation will be invoked with the contact information selected by the
+ user provided as the only parameter.
+ </p>
+
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
+ user should easily be able to review and revoke access that web applications have to this API
+ at a later time.
+ </p>
+ </div>
+ </div>
+
+ <div id="adding-and-updating-contacts" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">B. </span>Adding and Updating Contacts</h2><p><em>This section is non-normative.</em></p>
+
+ <p>
+ The ability to add and update contact information is not a function of the API provided in this
+ specification. Instead, the intention is to reuse existing web platform APIs and paradigms in order to
+ acheive add and update functionality.
+ </p>
+
+ <p>
+ In this section we show how the existing web platform would be used to provide add and update
+ writeback functionality to allow users to add new contacts or update existing contacts from a web page to
+ their unified address book.
+ </p>
+
+ <p>
+ A <dfn id="dfn-valid-contact-resource">valid Contact resource</dfn> is a web resource with a <code>.vcard</code> or <code>.vcf</code>
+ filename extension or a web resource with a MIME-type matching a <a class="internalDFN" href="#dfn-valid-media-type">valid media type</a>. A <dfn id="dfn-vcard-object">vCard
+ object</dfn> is a text-based representation of contact information provided according to any version of
+ the vCard family of specifications.
+ </p>
+
+ <p class="note">Need to add informative references to all specs within the 'vCard family of
+ specifications'.
+ </p>
+
+ <p>
+ To handle the saving of a new Contact, a <a class="internalDFN" href="#ua">user agent</a> should register as the default handler for
+ any <a class="internalDFN" href="#dfn-valid-contact-resource">valid Contact resource</a>.
+ </p>
+
+ <p>
+ A <dfn id="dfn-valid-media-type">valid media type</dfn> will be one of the following web resource MIME types:
+ </p>
+
+ <ul>
+ <li><code>text/vcard</code></li>
+ <li><code>text/x-vcard</code></li>
+ <li><code>text/directory</code></li>
+ <li><code>text/directory;profile=vCard</code></li>
+ </ul>
+
+ <p>
+ On invocation of a <a class="internalDFN" href="#dfn-valid-contact-resource">valid Contact resource</a>, the <a class="internalDFN" href="#ua">user agent</a> should, on successful download
+ of the <a class="internalDFN" href="#dfn-valid-contact-resource">valid Contact resource</a>, store the given resource in the user's unified address book
+ according to the <a class="internalDFN" href="#dfn-rule-for-storing-a-contact-resource">rule for storing a Contact resource</a>. As part of this standard download process,
+ the <a class="internalDFN" href="#ua">user agent</a> may present a dialog to the user allowing them to select a different application
+ with which to handle the given resource, thereby overriding the use of the unified address book for the
+ storage of the data contained therein and bypassing the <a class="internalDFN" href="#dfn-rule-for-storing-a-contact-resource">rule for storing a Contact resource</a>.
+ </p>
+
+ <p>
+ The <dfn id="dfn-rule-for-storing-a-contact-resource">rule for storing a Contact resource</dfn> is defined as follows:
+ </p>
+
+ <p>
+ Let <var>Contact</var> be the parsed key/value pairs contained in the <a class="internalDFN" href="#dfn-valid-contact-resource">valid Contact
+ resource</a>.
+ </p>
+
+ <ol>
+ <li>If <var>Contact</var> contains a <code>UID</code> key then process the <a class="internalDFN" href="#dfn-valid-contact-resource">valid Contact
+ resource</a> as follows.
+
+ <ol>
+ <li>Let <var>MatchedContact</var> be the result of obtaining a Contact object from the user's
+ unified address book that matches exactly the value of the <code>UID</code> provided.</li>
+
+ <li>If a <var>MatchedContact</var> has been found (i.e <var>MatchedContact</var> is
+ not-<code>null</code>) then update the contents of <var>MatchedContact</var> with the contents of
+ <var>Contact</var> and exit this rule.</li>
+ </ol>
+ </li>
+
+ <li>Save the contents of <var>Contact</var> in the user's unified address book as a new Contact
+ object.</li>
+ </ol>
+
+ <p>
+ As part of the <a class="internalDFN" href="#dfn-rule-for-storing-a-contact-resource">rule for storing a Contact resource</a>, the <a class="internalDFN" href="#ua">user agent</a> may provide
+ additional dialogs to the user after successful completion of the download and before the Contact
+ information is saved to the unified address book, such as to show a preview of the Contact information
+ contained therein as it will be stored in the user's unified address book. The user may be able to
+ override the information provided before accepting the additions and permanently storing the given data
+ in their unified address book.
+ </p>
+
+ <div id="adding-a-new-contact" class="informative section">
+ <h3><span class="secno">B.1 </span>Adding a new Contact</h3><p><em>This section is non-normative.</em></p>
+
+ <p>
+ A web page can dynamically generate a <a class="internalDFN" href="#dfn-vcard-object">vCard object</a> on the client side for download to the
+ user's unified address book via either data: URIs [<cite><a href="#bib-RFC2397" rel="biblioentry" class="bibref">RFC2397</a></cite>] or using the [<cite><a href="#bib-FILE-WRITER" rel="biblioentry" class="bibref">FILE-WRITER</a></cite>] and
+ [<cite><a href="#bib-FILE-API" rel="biblioentry" class="bibref">FILE-API</a></cite>] interfaces. The following examples show two methods for creating a <a class="internalDFN" href="#dfn-vcard-object">vCard object</a>
+ dynamically and then presenting this to the user. The user may then save this information by clicking
+ on the presented information, download the dynamically generated <a class="internalDFN" href="#dfn-vcard-object">vCard object</a> and invoke a
+ suitable application with which to handle the dynamic resource.
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>a id<span class="sh_symbol">=</span><span class="sh_string">"vcard"</span><span class="sh_symbol">></span>Save our Contact Details<span class="sh_symbol"></</span>a<span class="sh_symbol">></span>
+
+ <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_keyword">var</span> vcard <span class="sh_symbol">=</span> <span class="sh_string">'BEGIN:VCARD</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'VERSION:2.1</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'N:Doe;John</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'FN:John Doe</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'TEL;WORK;VOICE:123456</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'END:VCARD'</span><span class="sh_symbol">;</span>
+
+ <span class="sh_comment">// assign vCard as a Data URI to an anchor element for presentation and download by the user</span>
+ document<span class="sh_symbol">.</span><span class="sh_function">getElementById</span><span class="sh_symbol">(</span><span class="sh_string">'vcard'</span><span class="sh_symbol">).</span>href <span class="sh_symbol">=</span> <span class="sh_string">"data:text/x-vcard;charset=utf-8,"</span> <span class="sh_symbol">+</span> <span class="sh_predef_func">encodeURIComponent</span><span class="sh_symbol">(</span> vcard <span class="sh_symbol">);</span>
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>a id<span class="sh_symbol">=</span><span class="sh_string">"vcard"</span><span class="sh_symbol">></span>Save our Contact Details<span class="sh_symbol"></</span>a<span class="sh_symbol">></span>
+
+ <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_comment">// obtain an ArrayBuffer consisting of valid vCard syntax (out of scope)</span>
+ <span class="sh_keyword">var</span> vCardObj <span class="sh_symbol">=</span> <span class="sh_function">getVCard</span><span class="sh_symbol">(</span> <span class="sh_comment">/* ... */</span> <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// create a new vCard Blob [</span><cite><a href="#bib-FILE-WRITER" rel="biblioentry" class="bibref"><span class="sh_comment">FILE-WRITER</span></a></cite><span class="sh_comment">]</span>
+ <span class="sh_keyword">var</span> contactBlobBuilder <span class="sh_symbol">=</span> <span class="sh_keyword">new</span> <span class="sh_function">BlobBuilder</span><span class="sh_symbol">();</span>
+ contactBlobBuilder<span class="sh_symbol">.</span><span class="sh_function">append</span><span class="sh_symbol">(</span> vCardObj <span class="sh_symbol">);</span>
+ <span class="sh_keyword">var</span> contactBlob <span class="sh_symbol">=</span> contactBlobBuilder<span class="sh_symbol">.</span><span class="sh_function">getBlob</span><span class="sh_symbol">(</span> <span class="sh_string">"text/x-vcard"</span> <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// obtain a vCard Blob URL [</span><cite><a href="#bib-FILE-API" rel="biblioentry" class="bibref"><span class="sh_comment">FILE-API</span></a></cite><span class="sh_comment">]</span>
+ <span class="sh_keyword">var</span> contactBlobURL <span class="sh_symbol">=</span> window<span class="sh_symbol">.</span>URL<span class="sh_symbol">.</span><span class="sh_function">createObjectUrl</span><span class="sh_symbol">(</span> contactBlob <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// assign vCard Blob URL to an anchor element for presentation and download by the user</span>
+ document<span class="sh_symbol">.</span><span class="sh_function">getElementById</span><span class="sh_symbol">(</span><span class="sh_string">'vcard'</span><span class="sh_symbol">).</span>href <span class="sh_symbol">=</span> contactBlobURL<span class="sh_symbol">;</span>
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+ </div>
+
+ <div id="updating-an-existing-contact" class="informative section">
+ <h3><span class="secno">B.2 </span>Updating an existing Contact</h3><p><em>This section is non-normative.</em></p>
+
+ <p>
+ To update an existing Contact, the user must have already shared the contact information to edit
+ with the current web page via the <a href="#widl-Contacts-find-caller-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation of the <a href="#contacts-interface"><code>Contacts</code></a> interface. This section assumes that the user is
+ already sharing some contact information with the current web page via this process.
+ </p>
+
+ <p>
+ If this existing Contact information is to be updated in the user's unified address book then the
+ developer will assign the <code>id</code> attribute, as returned in the <code>Contact</code> object, as
+ the <code>UID</code> property of any resulting <a class="internalDFN" href="#dfn-vcard-object">vCard object</a> to be processed by the <a class="internalDFN" href="#ua">user
+ agent</a> according to the <a class="internalDFN" href="#dfn-rule-for-storing-a-contact-resource">rule for storing a Contact resource</a>.
+ </p>
+
+ <p>
+ The examples below show two methods for updating an existing Contact in the user's unified address
+ book by maintaining a valid UID property while changing other parameters of the Contact card. The user
+ is then required to click on the resulting anchor element to download the modified Contact
+ resource.
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>a id<span class="sh_symbol">=</span><span class="sh_string">"vcard"</span><span class="sh_symbol">></span>Save our Contact Details<span class="sh_symbol"></</span>a<span class="sh_symbol">></span>
+
+ <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_comment">// Obtain a single existing Contact object resulting from navigator.contacts.find()</span>
+ <span class="sh_keyword">var</span> existingContactObj <span class="sh_symbol">=</span> <span class="sh_symbol">...;</span>
+
+ <span class="sh_keyword">var</span> vcard <span class="sh_symbol">=</span> <span class="sh_string">'BEGIN:VCARD</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'VERSION:3.0</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'UID:'</span> <span class="sh_symbol">+</span> existingContactObj<span class="sh_symbol">.</span>id <span class="sh_symbol">+</span> <span class="sh_string">'</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span> <span class="sh_comment">// assign the Contact.id to a UID property </span>
+ <span class="sh_string">'N:Doe;John</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'FN:John Doe</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'TEL;HOME;VOICE:654321</span><span class="sh_specialchar">\r\n</span><span class="sh_string">'</span> <span class="sh_symbol">+</span>
+ <span class="sh_string">'END:VCARD'</span><span class="sh_symbol">;</span>
+
+ <span class="sh_comment">// assign vCard as a Data URI to an anchor element for presentation and download by the user</span>
+ document<span class="sh_symbol">.</span><span class="sh_function">getElementById</span><span class="sh_symbol">(</span><span class="sh_string">'vcard'</span><span class="sh_symbol">).</span>href <span class="sh_symbol">=</span> <span class="sh_string">"data:text/x-vcard;charset=utf-8,"</span> <span class="sh_symbol">+</span> <span class="sh_predef_func">encodeURIComponent</span><span class="sh_symbol">(</span> vcard <span class="sh_symbol">);</span>
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+
+ <div class="example">
+ <pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>a id<span class="sh_symbol">=</span><span class="sh_string">"vcard"</span><span class="sh_symbol">></span>Update our Contact Details<span class="sh_symbol"></</span>a<span class="sh_symbol">></span>
+
+ <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_comment">// Obtain a single existing Contact object resulting from navigator.contacts.find()</span>
+ <span class="sh_keyword">var</span> existingContactObj <span class="sh_symbol">=</span> <span class="sh_symbol">...;</span>
+
+ <span class="sh_comment">// Modify some parameters as required. e.g. add a new phone number</span>
+ existingContactObj<span class="sh_symbol">.</span>phoneNumbers<span class="sh_symbol">.</span><span class="sh_function">push</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span>
+ type<span class="sh_symbol">:</span> <span class="sh_string">'home'</span><span class="sh_symbol">,</span>
+ value<span class="sh_symbol">:</span> <span class="sh_string">'654321'</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// With the existing Contact object, create an ArrayBuffer consisting of valid vCard </span>
+ <span class="sh_comment">// syntax (out of scope) making sure to set the resulting vCard UID property to </span>
+ <span class="sh_comment">// the id parameter returned in the existing Contact object</span>
+ <span class="sh_keyword">var</span> vCardObj <span class="sh_symbol">=</span> <span class="sh_function">getVCard</span><span class="sh_symbol">(</span> existingContactObj <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// create a new vCard Blob [</span><cite><a href="#bib-FILE-WRITER" rel="biblioentry" class="bibref"><span class="sh_comment">FILE-WRITER</span></a></cite><span class="sh_comment">]</span>
+ <span class="sh_keyword">var</span> contactBlobBuilder <span class="sh_symbol">=</span> <span class="sh_keyword">new</span> <span class="sh_function">BlobBuilder</span><span class="sh_symbol">();</span>
+ contactBlobBuilder<span class="sh_symbol">.</span><span class="sh_function">append</span><span class="sh_symbol">(</span> vCardObj <span class="sh_symbol">);</span>
+ <span class="sh_keyword">var</span> contactBlob <span class="sh_symbol">=</span> contactBlobBuilder<span class="sh_symbol">.</span><span class="sh_function">getBlob</span><span class="sh_symbol">(</span> <span class="sh_string">"text/x-vcard"</span> <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// obtain a vCard Blob URL [</span><cite><a href="#bib-FILE-API" rel="biblioentry" class="bibref"><span class="sh_comment">FILE-API</span></a></cite><span class="sh_comment">]</span>
+ <span class="sh_keyword">var</span> contactBlobURL <span class="sh_symbol">=</span> window<span class="sh_symbol">.</span>URL<span class="sh_symbol">.</span><span class="sh_function">createObjectUrl</span><span class="sh_symbol">(</span> contactBlob <span class="sh_symbol">);</span>
+
+ <span class="sh_comment">// assign vCard Blob URL to an anchor element for presentation and download by the user</span>
+ document<span class="sh_symbol">.</span><span class="sh_function">getElementById</span><span class="sh_symbol">(</span><span class="sh_string">'vcard'</span><span class="sh_symbol">).</span>href <span class="sh_symbol">=</span> contactBlobURL<span class="sh_symbol">;</span>
+ <span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+ </pre>
+ </div>
+ </div>
+ </div>
+
+
+<div class="appendix section" id="references"><!--OddPage--><h2><span class="secno">C. </span>References</h2><div class="section" id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-DOM-LEVEL-3-EVENTS">[DOM-LEVEL-3-EVENTS]</dt><dd>Björn Höhrmann; Tom Pixley; Philippe Le Hégaret. <a href="http://www.w3.org/TR/2011/WD-DOM-Level-3-Events-20110531/"><cite>Document Object Model (DOM) Level 3 Events Specification.</cite></a> 31 May 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2011/WD-DOM-Level-3-Events-20110531/">http://www.w3.org/TR/2011/WD-DOM-Level-3-Events-20110531/</a>
+</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2011/WD-html5-20110525/"><cite>HTML5.</cite></a> 25 May 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2011/WD-html5-20110525/">http://www.w3.org/TR/2011/WD-html5-20110525/</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219"><cite>Web IDL.</cite></a> 19 December 2008. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219">http://www.w3.org/TR/2008/WD-WebIDL-20081219</a>
+</dd></dl></div><div class="section" id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><dl class="bibliography"><dt id="bib-FILE-API">[FILE-API]</dt><dd>Arun Ranganathan. <a href="http://www.w3.org/TR/2009/WD-FileAPI-20091117/"><cite>File API.</cite></a> 17 November 2009. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2009/WD-FileAPI-20091117/">http://www.w3.org/TR/2009/WD-FileAPI-20091117/</a>
+</dd><dt id="bib-FILE-WRITER">[FILE-WRITER]</dt><dd>Eric Uhrhane. <a href="http://dev.w3.org/2009/dap/file-system/file-writer.html"><cite>File Writer API.</cite></a> W3C Working Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/file-system/file-writer.html">http://dev.w3.org/2009/dap/file-system/file-writer.html</a>
+</dd><dt id="bib-NAVIGATOR">[NAVIGATOR]</dt><dd>Ian Hickson, David Hyatt. <a href="http://dev.w3.org/html5/spec/timers.html#navigator"><cite>Navigator interface in HTML5.</cite></a> 15 April 2011. Editors' draft. (Work in progress.) URL: <a href="http://dev.w3.org/html5/spec/timers.html#navigator">http://dev.w3.org/html5/spec/timers.html#navigator</a>
+</dd><dt id="bib-OMA-CAB">[OMA-CAB]</dt><dd>Converged Address Book Enabler, Version 1.0, Open Mobile Alliance, URL: http://www.openmobilealliance.org/
+</dd><dt id="bib-POCO-SCHEMA">[POCO-SCHEMA]</dt><dd>Joseph Smarr. <a href="http://portablecontacts.net/draft-spec.html#schema"><cite>Portable Contacts 1.0 Draft C: Contact Schema</cite></a> 5 August 2008. URL: <a href="http://portablecontacts.net/draft-spec.html#schema">http://portablecontacts.net/draft-spec.html#schema</a>
+</dd><dt id="bib-RFC2397">[RFC2397]</dt><dd>L. Masinter. <a href="http://www.ietf.org/rfc/rfc2397.txt"><cite>The "data" URL scheme.</cite></a> August 1998. Internet RFC 2397. URL: <a href="http://www.ietf.org/rfc/rfc2397.txt">http://www.ietf.org/rfc/rfc2397.txt</a>
+</dd><dt id="bib-RFC2426">[RFC2426]</dt><dd>F. Dawson, T. Howes. <a href="http://www.ietf.org/rfc/rfc2426.txt"><cite>vCard MIME Directory Profile.</cite></a> September 1998. URL: <a href="http://www.ietf.org/rfc/rfc2426.txt">http://www.ietf.org/rfc/rfc2426.txt</a>
+</dd><dt id="bib-WIDGETS">[WIDGETS]</dt><dd>Marcos Caceres. <a href="http://www.w3.org/TR/2009/CR-widgets-20091201/"><cite>Widget Packaging and Configuration.</cite></a> 01 December 2009. W3C Candidate Recommendation. (Work in progress.) URL: <a href="http://www.w3.org/TR/2009/CR-widgets-20091201/">http://www.w3.org/TR/2009/CR-widgets-20091201/</a>
+</dd></dl></div></div></body></html>
\ No newline at end of file
Binary file contacts/LC/contacts_element.png has changed
Binary file contacts/LC/contacts_notification.png has changed
Binary file contacts/LC/contacts_picker.png has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/Overview.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1596 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Contacts API</title>
+ <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
+ <script type="text/javascript" src='../ReSpec.js/js/respec.js' class='remove'></script>
+ <script type="text/javascript" src='../ReSpec.js/js/sh_main.min.js' class='remove'></script>
+ <script type="text/javascript" class='remove'>
+ var respecConfig = {
+ specStatus: "ED",
+ shortName: "contacts-api",
+ editors: [{
+ name: "Richard Tibbett",
+ url: "http://richt.me",
+ company: "Opera Software ASA",
+ companyURL: "http://www.opera.com"}],
+ previousPublishDate: "2011-06-16",
+ lcEnd: "2011-07-14",
+ previousMaturity: "LC",
+ edDraftURI: "http://dev.w3.org/2009/dap/contacts/",
+ noIDLIn: true,
+ };
+ </script>
+ <script type="text/javascript" src='../common/config.js' class='remove'></script>
+ <style type="text/css">
+ /* ReSpec.js CSS optimizations (Richard Tibbett) */
+ div.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ background: #fff;
+ padding: 1em;
+ font-size: 0.9em;
+ margin-top: 1em;
+ }
+ div.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ padding-left: 5px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+ }
+
+ /* Clean up pre.idl */
+ pre.idl::before {
+ font-size:0.9em;
+ }
+
+ /* Add better spacing to sections */
+ section, .section {
+ margin-bottom: 2em;
+ }
+
+ /* Reduce note & issue render size */
+ .note, .issue {
+ font-size:0.8em;
+ }
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li {
+ padding:0.2em;
+ }
+ /*
+ IDL wrapping fix
+ http://perishablepress.com/press/2010/06/01/wrapping-content/
+
+ [RB] This isn't a fix, it kills indentation!
+
+ pre.idl {
+ white-space: pre;
+ white-space: pre-wrap;
+ white-space: pre-line;
+ white-space: -pre-wrap;
+ white-space: -o-pre-wrap;
+ white-space: -moz-pre-wrap;
+ white-space: -hp-pre-wrap;
+ word-wrap: break-word;
+ }
+ */
+ </style>
+ </head>
+
+ <body>
+ <section id='abstract'>
+ <p>
+ The Contacts API defines the high-level interfaces required to obtain read access to a user's unified
+ address book.
+ </p>
+ <p>
+ This API includes the following key interfaces:
+ </p>
+ <ul>
+ <li>A <a>Contacts</a> interface, which provides the method
+ needed to access a user's unified address book.</li>
+ <li>A <a>Contact</a> interface, which captures the individual
+ contact information that can be returned following a successful read operation.</li>
+ </ul>
+ </section>
+
+ <section id='sotd'>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed
+ Contacts API. Issues and editors note in the document highlight some of the points on which the group is
+ still working and would particularly like to get feedback.
+ </p>
+ </section>
+
+ <section class="informative">
+ <h2>Introduction</h2>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of
+ representing address book information. Most users are required to maintain a plurality of contact lists
+ which leads to multiple copies of address book data. This in turn
+ often leads to disjoint and inconsistent information being stored across a user's
+ address book providers.
+ </p>
+ <p>
+ When sharing contact data with third parties users are, more often than not, required to hand over access to
+ their whole address book. Users are implicitly required to trust third parties with all of their data
+ when, in reality, the user may only wish, or need, to share a subset of their address book information so
+ that an application can fulfill its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may
+ be sourced from a plurality of sources - both online and locally. It then defines the
+ interfaces through which third party applications can access a user's unified address book, with explicit user
+ permission and filtering. The focus of this data sharing is on making the user aware of the data that
+ they will share and putting them at the centre of the data sharing process; free to select both the
+ extent to which they share their address book information and the ability to restrict which pieces of
+ information related to which contact gets shared.
+ </p>
+ <p>
+ A set of <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> are
+ presented for the discretion of both implementers of the Contacts API and recipients of contact
+ information (i.e. web pages). This specification provides a set of non-normative
+ <a href="#user-interaction-guidelines">User Interaction Guidelines</a> demonstrating an example user experience
+ that is compliant with the Security and Privacy Considerations described herein.
+ </p>
+ <p>
+ This specification also provides informative examples illustrating how to
+ <a href="#adding-and-updating-contacts">add and update contact information</a>, utilizing existing web platform
+ APIs.
+ </p>
+ <p>
+ The following code illustrates how to obtain contact information from a user's address book:
+ </p>
+ <pre class="example sh_javascript_dom">
+ function success (contacts) {
+ // do something with resulting contact objects
+ for (var i in contacts) alert(contacts[i].name);
+ // ...
+ }
+
+ function error (err) {
+ // do something with resulting error
+ alert(err.code);
+ // ...
+ }
+
+ // Perform an address book search. Obtain the 'name' and 'emails' properties
+ // and initially filter the list to Contact records containing 'Bob':
+ navigator.contacts.find( ['name', 'emails'], success, error, { filter: 'Bob', multiple: true } );
+ </pre>
+ </section>
+
+ <section id='conformance'>
+ <p>
+ This specification defines conformance criteria that apply to a single product: the
+ <dfn id="ua">user agent</dfn> that implements the interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement
+ them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification
+ [[!WEBIDL]], as this specification uses that specification and terminology.
+ </p>
+ <p>
+ A conforming implementation is required to implement all fields defined in this specification.
+ </p>
+
+ <section>
+ <h2>Terminology</h2>
+ <p>
+ The terms <dfn>document base URL</dfn>, <dfn>browsing context</dfn>, <dfn>event handler attribute</dfn>,
+ <dfn>event handler event type</dfn>, <dfn>task</dfn>, <dfn>task source</dfn> and <dfn>task queues</dfn>
+ are defined by the HTML5 specification [[!HTML5]].
+ </p>
+ <p>
+ The <a>task source</a> used by this specification is the <dfn>device task source</dfn>.
+ </p>
+ <p>
+ To <dfn>dispatch a <code>success</code> event</dfn> means that an event with the name
+ <code>success</code>, which does not bubble and is not cancellable, and which uses the
+ <code>Event</code> interface, is to be dispatched at the <a>ContactFindCB</a> object.
+ </p>
+ <p>
+ To <dfn>dispatch an <code>error</code> event</dfn> means that an event with the name
+ <code>error</code>, which does not bubble and is not cancellable, and which uses the <code>Event</code>
+ interface, is to be dispatched at the <a>ContactErrorCB</a> object.
+ </p>
+ </section>
+ </section>
+
+ <section>
+ <h2>Security and Privacy Considerations</h2>
+ <p>
+ The API defined in this specification can be used to find contact information from a user's address
+ books. This discloses information related to a user's contacts such as their phone numbers, email
+ addresses and other personally identifying information. The distribution of this information could
+ potentially compromise the user's privacy, or the user's contacts' privacy. A conforming implementation
+ of this specification should provide a mechanism that protects the user's privacy and this mechanism should
+ ensure that no contact information is retrievable without the user's express permission.
+ </p>
+ <section>
+ <h2>Privacy considerations for implementers of the Contacts API</h2>
+ <p>
+ A <a class="product-ua" href="#ua">user agent</a> should not provide contact information to Web sites without the express
+ permission of the user. A <a>user agent</a> should acquire permission from the user, unless
+ they have prearranged trust relationships with users, as described below. The user interface should
+ include the <a>document base URL</a>. Those permissions that are acquired through the user interface
+ and that are preserved beyond the current browsing session (i.e. beyond the time when the <a>browsing
+ context</a> is navigated to another URL) should be revocable and a <a>user agent</a> should respect permission revocation.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted
+ permission for the same Web site to access other methods provided by this API, or to access the same
+ method with a different set of arguments, as part of the same permission context. If a user has
+ expressed permission for an implementation to, e.g. find a set of existing contacts, the implementation
+ should seek the user's express permission if and when any additional <code>find</code> function is called
+ on this API.
+ </p>
+ <p>
+ A <a>user agent</a> may have prearranged trust relationships that do not require such user
+ interfaces. For example, while a Web browser will present a user interface when a Web site performs an
+ address book request, a Widget [[WIDGETS]] runtime may have a prearranged, delegated security
+ relationship with the user and, as such, a suitable alternative security and privacy mechanism with
+ which to authorize the retrieval of contact information.
+ </p>
+ </section>
+
+ <section class="informative">
+ <h2>Privacy considerations for recipients of contact information</h2>
+ <p>
+ Web sites operators that retrieve contacts information using this API are denoted as recipients
+ below.
+ </p>
+ <p>
+ Recipients should only request contact information when necessary, and only use the contact
+ information for the task for which it was provided to them.
+ </p>
+ <p>
+ Recipients should dispose of contact information once that task is completed, unless expressly
+ permitted to retain it by the user. Recipients should also take measures to protect this information
+ against unauthorized access. If contact information is stored, users should be allowed to update and
+ delete this information.
+ </p>
+ <p>
+ The recipient of contact information should not retransmit the contact information without the
+ user's express permission. Care should be taken when retransmitting and use of encryption is
+ encouraged.
+ </p>
+ <p>
+ Recipients should clearly and conspicuously disclose the fact that they are collecting contact data,
+ the purpose for the collection, how long the data is retained, how the data is secured, how the data is
+ shared if it is shared, how users can access, update and delete the data, and any other choices that
+ users have with respect to the data. This disclosure should include an explanation of any exceptions to
+ the guidelines listed above.
+ </p>
+ <p>
+ Note that even if a user gives permission to share their contact information this can have serious
+ privacy implications for those parties whose contacts are shared, as they may not wish such sharing to
+ occur. This should be considered by web services when requesting and using such information.
+ </p>
+ </section>
+ <section class='informative'>
+ <h2>Additional implementation considerations</h2>
+ <p>
+ Further to the requirements listed in the previous section, implementers of the Contacts API are
+ also advised to consider the following aspects that can negatively affect the privacy of their users:
+ in certain cases, users can inadvertently grant permission to the <a>user agent</a> to disclose their contacts
+ to Web sites. In other cases, the content hosted at a certain URL changes in such a way that the
+ previously granted contact permissions no longer apply as far as the user is concerned. Or the users
+ might simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive
+ measures are an implementation responsibility and not prescribed by this specification. However, in
+ designing these measures, implementers are advised to enable user awareness of contact sharing, and to
+ provide easy access to interfaces that enable revocation of permissions that web applications have to
+ access this API.
+ </p>
+ </section>
+ </section>
+
+ <section>
+ <h2>API Description</h2>
+
+ <section>
+ <h2><a>ServiceContacts</a> interface</h2>
+ <p id="ta-aa" class="product-ua">
+ The <a>ServiceContacts</a> interface is exposed on the <a class="externalDFN">Navigator</a>
+ object [[NAVIGATOR]]. Its goal is to provide an access point to the functionality in this
+ specification.
+ </p>
+ <dl title='[NoInterfaceObject] interface ServiceContacts' class='idl'>
+ <dt>readonly attribute Contacts contacts</dt>
+ <dd>The object through which the contacts functionality can be accessed.</dd>
+ </dl>
+ <div class='idl' title='Navigator implements ServiceContacts'></div>
+ </section>
+
+ <section>
+ <h2><a>Contacts</a> interface</h2>
+ <p>
+ The <a>Contacts</a> interface exposes a database of contact information that may be retrieved.
+ </p>
+ <p>
+ Multiple contact groups can be represented within this unified address book by specifying consistent
+ <a href='#widl-Contact-categories'><code>categories</code></a> values as part of individual
+ <a>Contact</a> objects. Multiple contact groups can be displayed by filtering on the required
+ <a href='#widl-Contact-categories'><code>categories</code></a> values via
+ the <a>Contacts</a> <a href='#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options'>find()</a> operation.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface Contacts' class='idl'>
+ <dt>void find ()</dt>
+ <dd>
+ <p>
+ Find contacts in the address book according to the <a>find contacts process</a> detailed
+ below.
+ </p>
+ <p>
+ This method takes two, three or four arguments. When called, it starts the following
+ <dfn>find contacts process</dfn>:
+ </p>
+ <ol class="rule">
+ <li>
+ Let <var>successCallback</var> be the callback indicated by the method's second argument.
+ </li>
+ <li>
+ Let <var>errorCallback</var> be the callback indicated by the method's third argument, if any, or null otherwise.
+ </li>
+ <li id="ta-ai" class="product-ua">If <var>successCallback</var> is null, then throw a TypeError (as defined in [[WEBIDL]]).</li>
+ <li class="product-ua" id="ta-ag">
+ If there is a <a>task</a> from the <a>device task source</a> in one of the <a>task
+ queues</a> (e.g. an existing <code>find()</code> operation is still pending a response), run these
+ substeps:
+ <ol>
+ <li>
+ If <var>errorCallback</var> is not null, let <var>error</var> be a <a>ContactError</a>
+ object whose code attribute has the value <code>PENDING_OPERATION_ERROR</code> and
+ queue a task to invoke <var>errorCallback</var> with <var>error</var> as its argument.
+ </li>
+ <li>Abort this operation.</li>
+ </ol>
+ </li>
+ <li>
+ Return, and run the remaining steps asynchronously.
+ </li>
+ <li>
+ Let <var>results</var> be the array of <a>Contact</a> objects obtained by searching contacts in the address book
+ according to the rules defined in <a href='#contact-search-processing'>Contact Search Processing</a>,
+ or null if the search has failed.
+ </li>
+ <li>
+ If <var>results</var> is null, run these substeps:
+ <ol>
+ <li>
+ If <var>errorCallback</var> is not null, let <var>error</var> be a <a>ContactError</a>
+ object whose code attribute has its value set according to the type of failure that occurred and
+ queue a task to invoke <var>errorCallback</var> with <var>error</var> as its argument.
+ </li>
+ <li>Abort this operation.</li>
+ </ol>
+ </li>
+ <li>Queue a task to invoke <var>successCallback</var> with <var>results</var> as its argument.</li>
+ </ol>
+
+ <dl class='parameters'>
+ <dt>DOMString[] fields</dt>
+ <dd>The <a>search qualifier</a>.</dd>
+ <dt>ContactFindCB successCB</dt>
+ <dd>Function to call when the asynchronous operation completes successfully.</dd>
+ <dt>optional ContactErrorCB errorCB</dt>
+ <dd>Function to call when the asynchronous operation fails.</dd>
+ <dt>optional ContactFindOptions options</dt>
+ <dd>The options to apply to the output of this method.</dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>Contact</a> interface</h2>
+ <p>
+ The <a>Contact</a> interface captures the properties of a contact object. All properties included in this
+ interface have a corresponding definition in [[POCO-SCHEMA]], [[RFC2426]] (aka vCard), and [[OMA-CAB]], thereby
+ allowing the API to be supported across implementations supporting these various contact formats.
+ </p>
+ <p id="ta-ac" class="product-ua">
+ All <a>Contact</a> objects MUST include all attributes supported by the implementation, regardless
+ of whether these attributes have been assigned a <code>null</code> value or not. If a supported attribute has not been
+ assigned a value by the user or the implementation, then this attribute MUST still be present in the
+ resulting <a>Contact</a> object and MUST have a value of <code>null</code>.
+ </p>
+ <p>
+ Additional attributes MAY be included according to the provisions detailed in
+ <a href="#extended-contact-properties-and-parameters">Extended Contact Properties and Parameters</a>. If an
+ extended attribute is supported by the current implementation and has not been assigned a value by the
+ user or the implementation, then this extended attribute MUST still be present in the resulting
+ <a>Contact</a> object and MUST have a value of <code>null</code>.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface Contact' class='idl'>
+ <dt>readonly attribute DOMString id</dt>
+ <dd>
+ <p>
+ A globally unique identifier for the given <a>Contact</a> object.
+ </p>
+ <p>
+ An implementation MUST maintain this globally unique identifier when a <a>Contact</a> is added
+ to an address book.
+ </p>
+ </dd>
+ <dt>attribute DOMString? displayName</dt>
+ <dd>
+ <p>
+ This attribute contains the name of this <a>Contact</a> in a form that is suitable for display
+ to the user.
+ </p>
+ </dd>
+ <dt>attribute ContactName? name</dt>
+ <dd>
+ <p>
+ This attribute represents the full name of this <a>Contact</a> indicated by the name components
+ associated with the <a>ContactName</a> object.
+ </p>
+ </dd>
+ <dt>attribute DOMString? nickname</dt>
+ <dd>
+ <p>
+ This attribute contains the nickname (or a casual name) for this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute ContactField[]? phoneNumbers</dt>
+ <dd>
+ <p>
+ This attribute captures one or more phone numbers associated with this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute ContactField[]? emails</dt>
+ <dd>
+ <p>
+ This attribute represents one or more email addresses associated with this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute ContactAddress[]? addresses</dt>
+ <dd>
+ <p>
+ This attribute represents one or more physical addresses associated with this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute ContactField[]? ims</dt>
+ <dd>
+ <p>
+ This attribute represents one or more instant messaging identifiers associated with this
+ <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute ContactOrganization[]? organizations</dt>
+ <dd>
+ <p>
+ This attribute represents one or more organizations associated with this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute Date? birthday</dt>
+ <dd>
+ <p>
+ This attribute contains birthday of this <a>Contact</a>.
+ </p>
+ <p>
+ The year value MAY be set to 0000 when the age of the <a>Contact</a> is private or the year is not
+ available.
+ </p>
+ </dd>
+ <dt>attribute DOMString? note</dt>
+ <dd>
+ <p>
+ This attribute contains the personal notes (free-text) for this <a>Contact</a> that is managed by the
+ user of the address book.
+ </p>
+ </dd>
+ <dt>attribute ContactField[]? photos</dt>
+ <dd>
+ <p>
+ This attribute represents one or more photos associated with this <a>Contact</a>.
+ </p>
+ <p>
+ The photos MUST be specified in the <code>value</code> attribute of the <a>ContactField</a> object
+ by using a URL pointing to an image resource. The <code>data:</code> URI scheme may be used in order
+ to provide inline data.
+ </p>
+ <p class="note">
+ This attribute SHOULD NOT be used to send down arbitrary photos taken by this user,
+ but specifically profile photos of the contact suitable for display when describing the
+ contact.
+ </p>
+ </dd>
+ <dt>attribute DOMString[]? categories</dt>
+ <dd>
+ <p>
+ This attribute contains one or more user-defined categories/tags/labels associated with this
+ <a>Contact</a>. e.g. "family", "favorite", "cryptozoologists".
+ </p>
+ </dd>
+ <dt>attribute ContactField[]? urls</dt>
+ <dd>
+ <p>
+ This attribute represents one or more URLs associated with this <a>Contact</a> e.g. personal web page,
+ blog.
+ </p>
+ <p>
+ The web resources MUST be specified using the <code>value</code> attribute of the
+ <code>ContactField</code> object, and its <code>type</code> field may be set to "blog" or
+ "profile".
+ </p>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactName</a> interface</h2>
+
+ <p>
+ The <a>ContactName</a> interface describes a contact's name.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface ContactName' class='idl'>
+ <dt>attribute DOMString? familyName</dt>
+ <dd>
+ <p>
+ This attribute contains the family name (also referred to as the last name) of this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? givenName</dt>
+ <dd>
+ <p>
+ This attribute contains the given name (also referred to as the first name) of this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? middleName</dt>
+ <dd>
+ <p>
+ This attribute contains the middle name of this <a>Contact</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? honorificPrefix</dt>
+ <dd>
+ <p>
+ This attribute contains the honorific prefix (or title) of this <a>Contact</a>. E.g. Mr., Dr., Ms.,
+ Mrs.
+ </p>
+ </dd>
+ <dt>attribute DOMString? honorificSuffix</dt>
+ <dd>
+ <p>
+ This attribute contains the honorific suffix of this <a>Contact</a>. E.g. Jr., III, Sr.
+ </p>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactField</a> interface</h2>
+
+ <p>
+ The <a>ContactField</a> interface is a reusable component that is used to capture contact fields of the
+ <a>Contact</a> interface that have some modicum of structure.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface ContactField' class='idl'>
+ <dt>attribute DOMString type</dt>
+ <dd>
+ <p>
+ This attribute contains the type information for this <a>ContactField</a> and its content varies subject
+ to the contact property this <a>ContactField</a> is representing. For example, if the <a>ContactField</a>
+ is representing a <code>phoneNumber</code> property, the <code>type</code> attribute can be set to
+ <code>home</code>, <code>mobile</code>; if the <a>ContactField</a> is representing the <code>ims</code>
+ property, the type attribute could be set to <code>xmpp</code>, <code>irc</code>, <code>bbm</code>, etc.
+ </p>
+ </dd>
+ <dt>attribute DOMString? value</dt>
+ <dd>
+ <p>
+ This attribute contains the value for this <a>ContactField</a> and its content varies subject to the
+ contact property this <a>ContactField</a> is representing. For example, if the <a>ContactField</a> is
+ representing an <code>email</code>, the value attribute could be set to <code>JoeSmith@example.com</code>,
+ and if the <a>ContactField</a> is representing a <code>url</code>, the value attribute can be set to
+ <code>http://www.example.org/joesmith</code>, etc.
+ </p>
+ </dd>
+ <dt>attribute boolean pref</dt>
+ <dd>
+ <p>
+ This attribute indicates whether this instance of the <a>ContactField</a> is the
+ preferred, or primary, value for the contact property this <a>ContactField</a> is
+ representing in the <a>Contact</a> interface. By default, the value is <code>false</code>.
+ </p>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactAddress</a> interface</h2>
+
+ <p>
+ The <a>ContactAddress</a> interface is a reusable component that is used to capture addresses
+ within the <a>Contact</a> interface.
+ </p>
+ <dl title='[NoInterfaceObject] interface ContactAddress' class='idl'>
+ <dt>attribute boolean pref</dt>
+ <dd>
+ <p>
+ This attribute indicates whether this instance of the <code>ContactAddress</code> is the preferred, or primary, value for the contact.
+ By default, the value is <code>false</code>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? type</dt>
+ <dd>
+ <p>
+ This attribute contains the type of address this object is representing (e.g. <code>work</code>, <code>home</code>, <code>premises</code>, etc).
+ </p>
+ </dd>
+ <dt>attribute DOMString? streetAddress</dt>
+ <dd>
+ <p>
+ This attribute contains the street address corresponding to this <a>ContactAddress</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? locality</dt>
+ <dd>
+ <p>
+ This attribute contains the locality (or city) name corresponding to this <a>ContactAddress</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? region</dt>
+ <dd>
+ <p>
+ This attribute contains the region (or state/province) name corresponding to this <a>ContactAddress</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? postalCode</dt>
+ <dd>
+ <p>
+ This attribute contains the postal code (or zip) corresponding to this <a>ContactAddress</a>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? country</dt>
+ <dd>
+ <p>
+ This attribute contains the country name corresponding to this <a>ContactAddress</a>.
+ </p>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactOrganization</a> interface</h2>
+
+ <p>
+ The <a>ContactOrganization</a> interface is a reusable component that is used to support contact
+ organisations within the <a>Contact</a> interface.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface ContactOrganization' class='idl'>
+ <dt>attribute boolean pref</dt>
+ <dd>
+ <p>
+ This attribute indicates whether this instance of the <code>ContactOrganization</code> is the preferred, or
+ primary, value for the contact. By default, the value is <code>false</code>.
+ </p>
+ </dd>
+ <dt>attribute DOMString? type</dt>
+ <dd>
+ <p>
+ This attribute contains the type of organization this object is representing.
+ </p>
+ </dd>
+ <dt>attribute DOMString? name</dt>
+ <dd>
+ <p>
+ The name of the organisation.
+ </p>
+ </dd>
+ <dt>attribute DOMString? department</dt>
+ <dd>
+ <p>
+ The department within which this <a>Contact</a> works.
+ </p>
+ </dd>
+ <dt>attribute DOMString? title</dt>
+ <dd>
+ <p>
+ The job title that the <a>Contact</a> holds inside this organisation.
+ </p>
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactFindOptions</a> interface</h2>
+ <p>
+ The <a>ContactFindOptions</a> interface describes the options that can be applied to contact searching.
+ When a <a>ContactFindOptions</a> parameter is provided to the <a>Contacts</a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation, it should be processed according to the provisions detailed in
+ <a href="#options-processing">Options Processing</a>.
+ </p>
+ <dl title='[NoInterfaceObject] interface ContactFindOptions' class='idl'>
+ <dt>attribute DOMString? filter</dt>
+ <dd>
+ A string-based <a>search filter</a> which provides a hint to the user agent to facilitate contacts selection by the user.
+ </dd>
+ <dt>attribute boolean? multiple</dt>
+ <dd>
+ A boolean value to indicate whether multiple Contact objects are wanted as part of the
+ <a>Contacts</a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ By default this option is set to <code>false</code>.
+ </dd>
+ </dl>
+ </section>
+
+ <section>
+ <h2><a>ContactFindCB</a> interface</h2>
+ <p>
+ This is the wrapper interface for callbacks indicating success of the <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation.
+ </p>
+
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactFindCB' class='idl'>
+ <dt>void onsuccess ()</dt>
+ <dd>
+ <dl class='parameters'>
+ <dt>Contact[] contactObjs</dt>
+ <dd>
+ An array of <a>Contact</a> objects resulting from the given <a>Contacts</a>
+ <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+
+ <section>
+ <h3>Event Handler Attributes</h3>
+ <p>
+ The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
+ type</a>) that MUST be supported as a DOM attribute by the <a>ContactFindCB</a> object.
+ </p>
+ <table class='simple'>
+ <thead>
+ <tr>
+ <th>event handler attribute</th>
+ <th>event handler event type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code>onsuccess</code></strong></td>
+ <td><code>success</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+
+ <section>
+ <h2><a>ContactErrorCB</a> interface</h2>
+ <p>
+ This is the wrapper interface for callbacks indicating failure of the <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ operation.
+ </p>
+
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactErrorCB' class='idl'>
+ <dt>void onerror ()</dt>
+ <dd>
+ <dl class='parameters'>
+ <dt>ContactError error</dt>
+ <dd>The <a>ContactError</a> object capturing the type of the error.</dd>
+ </dl>
+ </dd>
+ </dl>
+
+ <section>
+ <h3>Event Handler Attributes</h3>
+ <p>
+ The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
+ type</a>) that MUST be supported as a DOM attribute by the <a>ContactErrorCB</a> object.
+ </p>
+
+ <table class='simple'>
+ <thead>
+ <tr>
+ <th>event handler attribute</th>
+ <th>event handler event type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code><strong>onerror</strong></code></strong></td>
+ <td><code>error</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+
+ <section>
+ <h2><a>ContactError</a> interface</h2>
+ <p>
+ The <a>ContactError</a> interface encapsulates all errors in the manipulation of
+ <a>Contact</a> objects.
+ </p>
+
+ <dl title='[NoInterfaceObject] interface ContactError' class='idl'>
+ <dt>const unsigned short UNKNOWN_ERROR = 0</dt>
+ <dd>An unknown error occurred.</dd>
+
+ <dt>const unsigned short INVALID_ARGUMENT_ERROR = 1</dt>
+ <dd>An invalid parameter was provided when the requested method was invoked.</dd>
+
+ <dt>const unsigned short TIMEOUT_ERROR = 2</dt>
+ <dd>The requested method timed out before it could be completed.</dd>
+
+ <dt>const unsigned short PENDING_OPERATION_ERROR = 3</dt>
+ <dd>There is already a <a>task</a> in the <a>device task source</a>.</dd>
+
+ <dt>const unsigned short IO_ERROR = 4</dt>
+ <dd>An error occurred in communication with the underlying implementation that meant the requested
+ method could not complete.</dd>
+
+ <dt>const unsigned short NOT_SUPPORTED_ERROR = 5</dt>
+ <dd>The requested method is not supported by the current implementation.</dd>
+
+ <dt>const unsigned short PERMISSION_DENIED_ERROR = 20</dt>
+ <dd>Access to the requested information was denied by the implementation or by the user.</dd>
+
+ <dt>readonly attribute unsigned short code</dt>
+ <dd>An error code assigned by an implementation when an error has occurred in Contacts API
+ processing.</dd>
+ </dl>
+ </section>
+ </section>
+
+ <section>
+ <h2><a>Contact Search Processing</a></h2>
+
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a>
+ method provides an operation to search for one of more <a href=
+ "#contact-interface"><code>Contact</code></a> objects within the <a href=
+ "#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+
+ <section>
+ <h3>Search Qualifiers</h3>
+
+ <p>
+ The <dfn>search qualifier</dfn> provides an application with a way to request the specific subset of
+ <a href="#contact-interface"><code>Contact</code></a> properties it wishes to obtain in any resulting
+ successful callback. The <a>search qualifier</a> is deployed to minimize the data that needs to be
+ shared with an application in order to let that application fulfill its function on behalf of the user.
+ The <a>search qualifier</a> is included within a <a href=
+ "#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation as
+ the <code>fields</code> parameter.
+ </p>
+
+ <p id="ta-aj" class="product-ua">
+ A <a>search qualifier</a> MUST be specified from a requesting application as a part of any <a href=
+ "#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p id="ta-ab" class="product-ua">
+ If the <a>search qualifier</a> provided is of <em>zero-length</em> then the current <a href=
+ "#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation and
+ the current find() operation was invoked with a non-<code>null</code>
+ <code>errorCB</code> parameter, then the user agent MUST invoke the <code>errorCB</code> function
+ with an error code of <a href=
+ "#widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code></a>.
+ </p>
+
+ <p id="ta-ak" class="product-ua">
+ In the case that the <a>search qualifier</a> provided is of <em>non-zero-length</em> then the
+ current <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation MUST return only the matching <a href=
+ "#contact-interface"><code>Contact</code></a> properties within any resulting <a href=
+ "#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+
+ <p id="ta-al" class="product-ua">
+ If a provided <a>search qualifier</a> element (<code>fields[x]</code>) does not match a <a href=
+ "#contact-interface"><code>Contact</code></a> attribute, <code>fields[x]</code> SHOULD be ignored when
+ executing the current <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <section>
+ <h3>Advanced Search Qualifiers</h3>
+
+ <p>
+ We call <dfn>composed attributes</dfn> <a href="#contact-interface"><code>Contact</code></a>
+ attributes of types <code>object</code>, which contain information only available
+ only through child attributes of that object, or <code>array</code>.
+ </p>
+
+ <p class="product-ua" id="ta-ad">
+ A requesting application MUST be able to request both the full composed <a href=
+ "#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts
+ of a composed <a href="#contact-interface"><code>Contact</code></a> attribute in the <a>search
+ qualifier</a> provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p>
+ For example, the <code>name</code> attribute of a <a href=
+ "#contact-interface"><code>Contact</code></a> object is defined to be of composed type <a href=
+ "#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may
+ request either the full composed attribute (i.e. <code>name</code>) or specific individual attributes
+ of this composed attribute (i.e. <code>name.familyName</code>,
+ <code>name.givenName</code>, <code>name.middleName</code>, <code>name.honorificPrefix</code>,
+ <code>name.honorificSuffix</code>) as part of a <a href=
+ "#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation's
+ <a>search qualifier</a>.
+ </p>
+
+ <p id="ta-af" class="product-ua">
+ In the case that a composed <a href="#contact-interface"><code>Contact</code></a> attribute is
+ defined as an array of composed objects, specific individual attributes can be referenced
+ by using the composed attribute name, a dot (<code>.</code>) character and the individual attribute
+ to be retrieved.
+ </p>
+
+ <p>
+ For example, the <code>addresses</code> attribute of <a href=
+ "#contact-interface"><code>Contact</code></a> allows multiple <a href=
+ "#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request
+ individual attributes of this composed attribute an application would request e.g.
+ <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ </p>
+ </section>
+
+ <div class="example">
+ <p>
+ The following Contact search is initiated:
+ </p>
+ <pre class="sh_javascript">
+
+ navigator.contacts( ['emails.value', 'name', 'friends'],
+ function(contacts) {
+ for(i in contacts) {
+ for(j in contacts[i].emails)
+ alert(contacts[i].emails[j]);
+ }
+ } );
+ </pre>
+
+ <p>
+ The above example logically implies:
+ </p>
+
+ <ol class="rule">
+ <li>Return only the valid <a href="#contact-interface"><code>Contact</code></a> attributes
+ requested in the provided <a>search qualifier</a> (<code>name</code>, <code>emails.value</code> -
+ <code>friends</code> is not a valid <a href="#contact-interface"><code>Contact</code></a> attribute
+ so ignore this element).</li>
+ </ol>
+ </div>
+ </section>
+
+ <section>
+ <h2>Options Processing</h2>
+
+ <section>
+ <h3>Search Cardinality</h3>
+
+ <p id="ta-am" class="product-ua">
+ By default, the <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation MUST return either an empty sequence or a single <a href=
+ "#contact-interface"><code>Contact</code></a> object, accessible as part of the sequence returned in
+ the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+
+ <p id="ta-ae" class="product-ua">
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is
+ provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation and its <code>multiple</code> attribute is set to
+ <code>true</code>, the <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation MUST return either an empty sequence, a single <a href=
+ "#contact-interface"><code>Contact</code></a> object or <var>[X]</var> number of <a href=
+ "#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in
+ the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+ </section>
+
+ <section>
+ <h3>Search Filters</h3>
+
+ <p>
+ A <dfn>search filter</dfn> may be specified from a requesting web application to provide a hint to the user agents as to which contacts the user can select to share with the application.</p>
+
+ <p>The <a>search filter</a> is defined through the <code>filter</code>
+ attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object
+ provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href=
+ "#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options">find()</a> operation.
+ </p>
+
+ <p>The actual usage of this <a>search filter</a> is user-agent dependant, but is expected to represent
+ the logical union of provided values that are matched therein.
+ </p>
+ </section>
+ </section>
+ </section>
+
+ <section>
+ <h2>Extended Contact Properties and Parameters</h2>
+
+ <p>
+ The properties and parameters defined on the <a href="#contact-interface"><code>Contact</code></a>
+ interface MAY be extended by implementers of this specification.
+ </p>
+
+ <p>
+ Non-standard, private properties and parameters MUST have a prefixed name starting with
+ <code>X</code> (U+0058 LATIN CAPITAL LETTER X) or use a vendor-specific prefix. Extended properties and
+ parameters can be defined bilaterally between <a title="user agent">user agents</a> without outside
+ registration or standardization.
+ </p>
+
+ <p>
+ It is RECOMMENDED that authors define both a formal vCard grammar and a WebIDL grammar for their
+ proposed extension to ensure interoperability between vCard databases and other non-standard Contact
+ databases and formats. It is also RECOMMENDED that authors provide documentation of their extension
+ properties and parameters within the public domain.
+ </p>
+
+ <div class="example">
+ <p>
+ A new parameter is required by Company X to provide information related to a user's accounts
+ registered across different networks and services.
+ </p>
+
+ <p>
+ The [[WEBIDL]] syntax for this parameter is defined as follows:
+ </p>
+
+ <div class='idl' title='Contact implements ContactExtended'>
+
+ </div>
+
+ <dl title='[NoInterfaceObject] interface ContactExtended' class='idl'>
+ <dt>attribute ContactAccount[] Xaccounts</dt>
+
+ <dd>One or more user accounts. See [[[POCO-SCHEMA]] Section 7.2.2. <code>accounts</code>].</dd>
+ </dl>
+
+ <dl title='[NoInterfaceObject] interface ContactAccount' class='idl'>
+ <dt>attribute DOMString domain</dt>
+
+ <dd>
+ <p>
+ See [[[POCO-SCHEMA]] Section 7.6. <code>domain</code>].
+ </p>
+ </dd>
+
+ <dt>attribute DOMString username</dt>
+
+ <dd>
+ <p>
+ See [[[POCO-SCHEMA]] Section 7.6. <code>username</code>].
+ </p>
+ </dd>
+
+ <dt>attribute DOMString userid</dt>
+
+ <dd>
+ <p>
+ See [[[POCO-SCHEMA]] Section 7.6. <code>userid</code>].
+ </p>
+ </dd>
+ </dl>
+
+ <p>
+ The corresponding vCard [[RFC2426]] notation for this parameter is defined as follows:
+ </p>
+ <pre>
+ The following ABNF grammar extends the grammar found in [[RFC2426]] (Section 4).
+
+ <strong>X-ACCOUNT</strong>
+
+ Purpose: To specify the components of the accounts for the vCard
+ object.
+
+ Value type: A single structured text value, separated by the SEMI-
+ COLON character (ASCII decimal 59).
+
+ Cardinality: (0,n)
+
+ Special notes: The structured type value consists of a sequence of
+ account components. The component values must be specified in
+ their corresponding position. The structured type value
+ corresponds, in sequence, to the domain; the username; the userid.
+ When a component value is missing, the associated component
+ separator must still be specified.
+
+ The text components are separated by the SEMI-COLON character
+ (ASCII decimal 59).
+
+ ABNF:
+
+ X-ACCOUNT-param = ; no parameter allowed
+ X-ACCOUNT-value = list-component 3(";" list-component)
+ </pre>
+
+ <p>
+ This parameter will be used within the Contacts API as follows:
+ </p>
+ <pre class="sh_javascript">
+ var contact = ...; // ...obtain individual contact object
+ for(var i in contact.Xaccounts) {
+ alert(contact.Xaccounts[i].domain); // thesocialnetwork.com
+ alert(contact.Xaccounts[i].username); // null
+ alert(contact.Xaccounts[i].userid); // 344aesq2
+ }
+ </pre>
+
+ <p>
+ This parameter will be used within the vCard format [[RFC2426]]] as follows:
+ </p>
+ <pre>
+ X-ACCOUNT;thesocialnetwork.com;;344aesq2
+ </pre>
+ </div>
+ </section>
+
+ <section>
+ <h3>API Invocation via DOM Events</h3>
+
+ <p>
+ The API contained in this document can be invoked either programmatically (for example, inline within
+ a general script) or resulting from the <a>interaction of a user</a>.
+ </p>
+
+ <p>
+ The <dfn>interaction of a user</dfn> is when a user invokes the API from an <a href=
+ "http://dev.w3.org/html5/markup/elements.html"><code>HTMLElement</code></a> [[HTML5]] within the current
+ <a>browsing context</a> via a <a>valid auto-invocation event</a>.
+ </p>
+
+ <p>
+ A <dfn>valid auto-invocation event</dfn> includes any of the following event types, as defined in
+ [[!DOM-LEVEL-3-EVENTS]]:
+ </p>
+
+ <ul>
+ <li><code>click</code></li>
+
+ <li><code>dblclick</code></li>
+
+ <li><code>mouseup</code></li>
+ </ul>
+
+ <p>
+ The <code>find()</code> method on <a href="#contacts-interface"><code>Contacts</code></a> should, if
+ the method was invoked by an <a>interaction of a user</a> (as opposed to having been created and executed
+ in general script), display the <a>Contact Picker</a> directly.
+ </p>
+ </section>
+
+ <section class="informative appendix">
+ <h2>User Interaction Guidelines</h2>
+
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the
+ contact information that may be shared from their unified address book. This annex provides some examples
+ of a conformant user experience that this specification enables.
+ </p>
+
+ <section>
+ <h3>Accessing Contact Information - Example #1</h3>
+
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+
+ <div class='example'>
+ <pre class="sh_javascript">
+ <script type="text/javascript">
+
+ function successContactFindCallback(contacts) {
+ // do something with resulting contact objects
+ for (var i in contacts) alert(contacts[i].name);
+ // ...
+ }
+
+ function generalErrorCB(error) {
+ // do something with resulting errors
+ alert(error.code);
+ // ...
+ }
+
+ // Perform an address book search. Obtain the 'name' and 'emails' properties
+ // and initially filter the list to Contact records containing 'Bob':
+ navigator.contacts.find(['name', 'emails'],
+ successContactFindCallback,
+ generalErrorCB,
+ { filter: 'Bob', multiple: true }
+ );
+
+ </script>
+ </pre>
+ </div>
+
+ <p>
+ As a result of executing this code, the <a>user agent</a> may provide a non-blocking <dfn>contact
+ search notification</dfn> as follows:
+ </p>
+
+ <p align="center"><img src="contacts_notification.png" alt="Contact Search Notification"><br>
+ (<a href="contacts_notification.png">View as PNG</a>)
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href=
+ "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a>user agent</a> may provide a <dfn>contact picker</dfn>,
+ utilizing all of the parameters provided in the find() operation as follows:
+ </p>
+
+ <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is
+ requesting and the option to select one or more contacts (as appropriate) from the user interface.
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href=
+ "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
+ associated to the current find() operation will be invoked with the contact information selected by the
+ user provided as the only parameter.
+ </p>
+
+ <p>
+ Further to this initial sharing of Contact information, the <a href=
+ "#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
+ user should easily be able to review and revoke access that web applications have to this API
+ at a later time.
+ </p>
+ </section>
+
+ <section>
+ <h3>Accessing Contact Information - Example #2</h3>
+
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+
+ <div class='example'>
+ <pre class="sh_javascript">
+ <input type="button" value="Share Contacts" onclick="getContacts()" />
+
+ <script type="text/javascript">
+ function successContactFindCallback(contacts) {
+ // do something with resulting contact objects
+ for (var i in contacts) alert(contacts[i].name);
+ // ...
+ }
+
+ function generalErrorCB(error) {
+ // do something with resulting errors
+ alert(error.code);
+ // ...
+ }
+
+ function getContacts() {
+ // Perform an address book search. Obtain the 'name' and 'emails' properties
+ // and initially filter the list to Contact records containing 'Bob':
+ navigator.contacts.find( ['name', 'emails'],
+ successContactFindCallback,
+ generalErrorCB,
+ { filter: 'Bob', multiple: true } );
+ }
+ </script>
+ </pre>
+ </div>
+
+ <p>
+ This code may render as follows within the <a>user agent</a>:
+ </p>
+
+ <p align="center"><img src="contacts_element.png" alt="Contact Search via DOM Events"><br>
+ (<a href="contacts_element.png">View as PNG</a>)
+ </p>
+
+ <p>
+ If the user clicks on the rendered button element then the <a>user agent</a> may directly provide a
+ <dfn>contact picker</dfn>, as defined in <a href="#api-invocation-via-dom-events">API Invocation via
+ DOM Events</a>, utilizing all of the parameters provided in the <code>find()</code> operation as
+ follows:
+ </p>
+
+ <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is
+ requesting and the option to select one or more contacts (as appropriate) from the user interface.
+ </p>
+
+ <p>
+ If an additional find() operation is called by the current web application before the user has
+ clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
+ <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
+ operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
+ find() operation, will be invoked with an error code of <a href=
+ "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
+ associated to the current find() operation will be invoked with the contact information selected by the
+ user provided as the only parameter.
+ </p>
+
+ <p>
+ Further to this initial sharing of Contact information, the <a href=
+ "#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
+ user should easily be able to review and revoke access that web applications have to this API
+ at a later time.
+ </p>
+ </section>
+ </section>
+
+ <section class="informative appendix">
+ <h2>Adding and Updating Contacts</h2>
+
+ <p>
+ The ability to add and update contact information is not a function of the API provided in this
+ specification. Instead, the intention is to reuse existing web platform APIs and paradigms in order to
+ achieve add and update functionality.
+ </p>
+
+ <p>
+ In this section we show how the existing web platform would be used to provide add and update
+ writeback functionality to allow users to add new contacts or update existing contacts from a web page to
+ their unified address book.
+ </p>
+
+ <p>
+ A <dfn>valid Contact resource</dfn> is a web resource with a <code>.vcard</code> or <code>.vcf</code>
+ filename extension or a web resource with a MIME-type matching a <a>valid media type</a>. A <dfn>vCard
+ object</dfn> is a text-based representation of contact information provided according to any version of
+ the vCard family of specifications.
+ </p>
+
+ <p class="note">Need to add informative references to all specs within the 'vCard family of
+ specifications'.
+ </p>
+
+ <p>
+ To handle the saving of a new Contact, a <a>user agent</a> should register as the default handler for
+ any <a>valid Contact resource</a>.
+ </p>
+
+ <p>
+ A <dfn>valid media type</dfn> will be one of the following web resource MIME types:
+ </p>
+
+ <ul>
+ <li><code>text/vcard</code></li>
+ <li><code>text/x-vcard</code></li>
+ <li><code>text/directory</code></li>
+ <li><code>text/directory;profile=vCard</code></li>
+ </ul>
+
+ <p>
+ On invocation of a <a>valid Contact resource</a>, the <a>user agent</a> should, on successful download
+ of the <a>valid Contact resource</a>, store the given resource in the user's unified address book
+ according to the <a>rule for storing a Contact resource</a>. As part of this standard download process,
+ the <a>user agent</a> may present a dialog to the user allowing them to select a different application
+ with which to handle the given resource, thereby overriding the use of the unified address book for the
+ storage of the data contained therein and bypassing the <a>rule for storing a Contact resource</a>.
+ </p>
+
+ <p>
+ The <dfn>rule for storing a Contact resource</dfn> is defined as follows:
+ </p>
+
+ <p>
+ Let <var>Contact</var> be the parsed key/value pairs contained in the <a>valid Contact
+ resource</a>.
+ </p>
+
+ <ol>
+ <li>If <var>Contact</var> contains a <code>UID</code> key then process the <a>valid Contact
+ resource</a> as follows.
+
+ <ol>
+ <li>Let <var>MatchedContact</var> be the result of obtaining a Contact object from the user's
+ unified address book that matches exactly the value of the <code>UID</code> provided.</li>
+
+ <li>If a <var>MatchedContact</var> has been found (i.e. <var>MatchedContact</var> is
+ not-<code>null</code>) then update the contents of <var>MatchedContact</var> with the contents of
+ <var>Contact</var> and exit this rule.</li>
+ </ol>
+ </li>
+
+ <li>Save the contents of <var>Contact</var> in the user's unified address book as a new Contact
+ object.</li>
+ </ol>
+
+ <p>
+ As part of the <a>rule for storing a Contact resource</a>, the <a>user agent</a> may provide
+ additional dialogs to the user after successful completion of the download and before the Contact
+ information is saved to the unified address book, such as to show a preview of the Contact information
+ contained therein as it will be stored in the user's unified address book. The user may be able to
+ override the information provided before accepting the additions and permanently storing the given data
+ in their unified address book.
+ </p>
+
+ <section class="informative">
+ <h4>Adding a new Contact</h4>
+
+ <p>
+ A web page can dynamically generate a <a>vCard object</a> on the client side for download to the
+ user's unified address book via either data: URIs [[RFC2397]] or using the [[FILE-WRITER]] and
+ [[FILE-API]] interfaces. The following examples show two methods for creating a <a>vCard object</a>
+ dynamically and then presenting this to the user. The user may then save this information by clicking
+ on the presented information, download the dynamically generated <a>vCard object</a> and invoke a
+ suitable application with which to handle the dynamic resource.
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript">
+ <a id="vcard">Save our Contact Details</a>
+
+ <script type="text/javascript">
+ var vcard = 'BEGIN:VCARD\r\n' +
+ 'VERSION:2.1\r\n' +
+ 'N:Doe;John\r\n' +
+ 'FN:John Doe\r\n' +
+ 'TEL;WORK;VOICE:123456\r\n' +
+ 'END:VCARD';
+
+ // assign vCard as a Data URI to an anchor element for presentation and download by the user
+ document.getElementById('vcard').href = "data:text/x-vcard;charset=utf-8," + encodeURIComponent( vcard );
+ </script>
+ </pre>
+ </div>
+
+ <div class="example">
+ <pre class="sh_javascript">
+ <a id="vcard">Save our Contact Details</a>
+
+ <script type="text/javascript">
+ // obtain an ArrayBuffer consisting of valid vCard syntax (out of scope)
+ var vCardObj = getVCard( /* ... */ );
+
+ // create a new vCard Blob [[FILE-WRITER]]
+ var contactBlobBuilder = new BlobBuilder();
+ contactBlobBuilder.append( vCardObj );
+ var contactBlob = contactBlobBuilder.getBlob( "text/x-vcard" );
+
+ // obtain a vCard Blob URL [[FILE-API]]
+ var contactBlobURL = window.URL.createObjectUrl( contactBlob );
+
+ // assign vCard Blob URL to an anchor element for presentation and download by the user
+ document.getElementById('vcard').href = contactBlobURL;
+ </script>
+ </pre>
+ </div>
+ </section>
+
+ <section class="informative">
+ <h4>Updating an existing Contact</h4>
+
+ <p>
+ To update an existing Contact, the user must have already shared the contact information to edit
+ with the current web page via the <a href='#widl-Contacts-find-void-DOMStringArray-fields-ContactFindCB-successCB-ContactErrorCB-errorCB-ContactFindOptions-options'>find()</a> operation of the <a href=
+ "#contacts-interface"><code>Contacts</code></a> interface. This section assumes that the user is
+ already sharing some contact information with the current web page via this process.
+ </p>
+
+ <p>
+ If this existing Contact information is to be updated in the user's unified address book then the
+ developer will assign the <code>id</code> attribute, as returned in the <code>Contact</code> object, as
+ the <code>UID</code> property of any resulting <a>vCard object</a> to be processed by the <a>user
+ agent</a> according to the <a>rule for storing a Contact resource</a>.
+ </p>
+
+ <p>
+ The examples below show two methods for updating an existing Contact in the user's unified address
+ book by maintaining a valid UID property while changing other parameters of the Contact card. The user
+ is then required to click on the resulting anchor element to download the modified Contact
+ resource.
+ </p>
+
+ <div class="example">
+ <pre class="sh_javascript">
+ <a id="vcard">Save our Contact Details</a>
+
+ <script type="text/javascript">
+ // Obtain a single existing Contact object resulting from navigator.contacts.find()
+ var existingContactObj = ...;
+
+ var vcard = 'BEGIN:VCARD\r\n' +
+ 'VERSION:3.0\r\n' +
+ 'UID:' + existingContactObj.id + '\r\n' + // assign the Contact.id to a UID property
+ 'N:Doe;John\r\n' +
+ 'FN:John Doe\r\n' +
+ 'TEL;HOME;VOICE:654321\r\n' +
+ 'END:VCARD';
+
+ // assign vCard as a Data URI to an anchor element for presentation and download by the user
+ document.getElementById('vcard').href = "data:text/x-vcard;charset=utf-8," + encodeURIComponent( vcard );
+ </script>
+ </pre>
+ </div>
+
+ <div class="example">
+ <pre class="sh_javascript">
+ <a id="vcard">Update our Contact Details</a>
+
+ <script type="text/javascript">
+ // Obtain a single existing Contact object resulting from navigator.contacts.find()
+ var existingContactObj = ...;
+
+ // Modify some parameters as required. e.g. add a new phone number
+ existingContactObj.phoneNumbers.push({
+ type: 'home',
+ value: '654321'
+ });
+
+ // With the existing Contact object, create an ArrayBuffer consisting of valid vCard
+ // syntax (out of scope) making sure to set the resulting vCard UID property to
+ // the id parameter returned in the existing Contact object
+ var vCardObj = getVCard( existingContactObj );
+
+ // create a new vCard Blob [[FILE-WRITER]]
+ var contactBlobBuilder = new BlobBuilder();
+ contactBlobBuilder.append( vCardObj );
+ var contactBlob = contactBlobBuilder.getBlob( "text/x-vcard" );
+
+ // obtain a vCard Blob URL [[FILE-API]]
+ var contactBlobURL = window.URL.createObjectUrl( contactBlob );
+
+ // assign vCard Blob URL to an anchor element for presentation and download by the user
+ document.getElementById('vcard').href = contactBlobURL;
+ </script>
+ </pre>
+ </div>
+ </section>
+ </section>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD1/CVS/Entries Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,4 @@
+/contacts_notification.png/1.1/Wed Jun 30 13:40:06 2010//
+/contacts_picker.png/1.1/Wed Jun 30 13:40:06 2010//
+/Overview.html/1.4/Wed Jun 30 14:55:55 2010//
+D
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD1/CVS/Repository Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+2009/dap/contacts/WD1
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD1/CVS/Root Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+rberjon2@dev.w3.org:/sources/public
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD1/Overview.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,2356 @@
+<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
+<html lang="en" dir="ltr">
+<head>
+
+
+ <title>Contacts API</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+
+
+
+
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec CSS
+ * Robin Berjon <robin at berjon dot com>
+ * v0.05 - 2009-07-31
+ *****************************************************************/
+
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: medium solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: medium dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- WEB IDL --- */
+pre.idl {
+ border-top: 1px solid #90b8de;
+ border-bottom: 1px solid #90b8de;
+ padding: 1em;
+ line-height: 120%;
+}
+
+pre.idl::before {
+ content: "WebIDL";
+ display: block;
+ width: 150px;
+ background: #90b8de;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+.idlType {
+ color: #ff4500;
+ font-weight: bold;
+ text-decoration: none;
+}
+
+/*.idlModule*/
+/*.idlModuleID*/
+/*.idlInterface*/
+.idlInterfaceID {
+ font-weight: bold;
+ color: #005a9c;
+}
+
+.idlSuperclass {
+ font-style: italic;
+ color: #005a9c;
+}
+
+/*.idlAttribute*/
+.idlAttrType, .idlFieldType {
+ color: #005a9c;
+}
+.idlAttrName, .idlFieldName {
+ color: #ff4500;
+}
+.idlAttrName a, .idlFieldName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlMethod*/
+.idlMethType {
+ color: #005a9c;
+}
+.idlMethName {
+ color: #ff4500;
+}
+.idlMethName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlParam*/
+.idlParamType {
+ color: #005a9c;
+}
+.idlParamName {
+ font-style: italic;
+}
+
+.extAttr {
+ color: #666;
+}
+
+/*.idlConst*/
+.idlConstType {
+ color: #005a9c;
+}
+.idlConstName {
+ color: #ff4500;
+}
+.idlConstName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlException*/
+.idlExceptionID {
+ font-weight: bold;
+ color: #c00;
+}
+
+.idlTypedefID, .idlTypedefType {
+ color: #005a9c;
+}
+
+.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
+ color: #c00;
+ font-weight: normal;
+}
+
+.excName a {
+ font-family: monospace;
+}
+
+.idlRaises a.idlType, .excName a.idlType {
+ border-bottom: 1px dotted #c00;
+}
+
+.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
+ width: 45px;
+ text-align: center;
+}
+.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
+.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
+
+.idlImplements a {
+ font-weight: bold;
+}
+
+dl.attributes, dl.methods, dl.constants, dl.fields {
+ margin-left: 2em;
+}
+
+.attributes dt, .methods dt, .constants dt, .fields dt {
+ font-weight: normal;
+}
+
+.attributes dt code, .methods dt code, .constants dt code, .fields dt code {
+ font-weight: bold;
+ color: #000;
+ font-family: monospace;
+}
+
+.attributes dt code, .fields dt code {
+ background: #ffffd2;
+}
+
+.attributes dt .idlAttrType code, .fields dt .idlFieldType code {
+ color: #005a9c;
+ background: transparent;
+ font-family: inherit;
+ font-weight: normal;
+ font-style: italic;
+}
+
+.methods dt code {
+ background: #d9e6f8;
+}
+
+.constants dt code {
+ background: #ddffd2;
+}
+
+.attributes dd, .methods dd, .constants dd, .fields dd {
+ margin-bottom: 1em;
+}
+
+table.parameters, table.exceptions {
+ border-spacing: 0;
+ border-collapse: collapse;
+ margin: 0.5em 0;
+ width: 100%;
+}
+table.parameters { border-bottom: 1px solid #90b8de; }
+table.exceptions { border-bottom: 1px solid #deb890; }
+
+.parameters th, .exceptions th {
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+ font-family: initial;
+ font-weight: normal;
+ text-shadow: #666 1px 1px 0;
+}
+.parameters th { background: #90b8de; }
+.exceptions th { background: #deb890; }
+
+.parameters td, .exceptions td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+ vertical-align: top;
+}
+
+.parameters tr:first-child td, .exceptions tr:first-child td {
+ border-top: none;
+}
+
+.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
+ width: 100px;
+}
+
+.parameters td.prmType {
+ width: 120px;
+}
+
+table.exceptions table {
+ border-spacing: 0;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+/* --- TOC --- */
+.toc a {
+ text-decoration: none;
+}
+
+a .secno {
+ color: #000;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+
+/* --- EXAMPLES --- */
+pre.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ padding: 1em;
+ margin-top: 1em;
+}
+
+pre.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* --- EDITORIAL NOTES --- */
+.issue {
+ padding: 1em;
+ border: 1px solid #f00;
+ background: #ffc;
+}
+
+.issue::before {
+ content: "Issue";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #f00;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+.note {
+ padding: 1em;
+ border: 2px solid #cff6d9;
+ background: #e2fff0;
+}
+
+.note::before {
+ content: "Note";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #cff6d9;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+/* --- SYNTAX HIGHLIGHTING --- */
+pre.sh_sourceCode {
+ background-color: white;
+ color: black;
+ font-style: normal;
+ font-weight: normal;
+}
+
+pre.sh_sourceCode .sh_keyword { color: #005a9c; font-weight: bold; } /* language keywords */
+pre.sh_sourceCode .sh_type { color: #666; } /* basic types */
+pre.sh_sourceCode .sh_usertype { color: teal; } /* user defined types */
+pre.sh_sourceCode .sh_string { color: red; font-family: monospace; } /* strings and chars */
+pre.sh_sourceCode .sh_regexp { color: orange; font-family: monospace; } /* regular expressions */
+pre.sh_sourceCode .sh_specialchar { color: #ffc0cb; font-family: monospace; } /* e.g., \n, \t, \\ */
+pre.sh_sourceCode .sh_comment { color: #A52A2A; font-style: italic; } /* comments */
+pre.sh_sourceCode .sh_number { color: purple; } /* literal numbers */
+pre.sh_sourceCode .sh_preproc { color: #00008B; font-weight: bold; } /* e.g., #include, import */
+pre.sh_sourceCode .sh_symbol { color: blue; } /* e.g., <, >, + */
+pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */
+pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */
+pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: #00FFFF; } /* TODO and FIXME */
+
+/* Predefined variables and functions (for instance glsl) */
+pre.sh_sourceCode .sh_predef_var { color: #00008B; }
+pre.sh_sourceCode .sh_predef_func { color: #00008B; font-weight: bold; }
+
+/* for OOP */
+pre.sh_sourceCode .sh_classname { color: teal; }
+
+/* line numbers (not yet implemented) */
+pre.sh_sourceCode .sh_linenum { display: none; }
+
+/* Internet related */
+pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; }
+
+/* for ChangeLog and Log files */
+pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; }
+pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: #00008B; font-weight: bold; }
+pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: #006400; }
+
+/* for Prolog, Perl... */
+pre.sh_sourceCode .sh_variable { color: #006400; }
+
+/* for LaTeX */
+pre.sh_sourceCode .sh_italics { color: #006400; font-style: italic; }
+pre.sh_sourceCode .sh_bold { color: #006400; font-weight: bold; }
+pre.sh_sourceCode .sh_underline { color: #006400; text-decoration: underline; }
+pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; }
+pre.sh_sourceCode .sh_argument { color: #006400; }
+pre.sh_sourceCode .sh_optionalargument { color: purple; }
+pre.sh_sourceCode .sh_math { color: orange; }
+pre.sh_sourceCode .sh_bibtex { color: blue; }
+
+/* for diffs */
+pre.sh_sourceCode .sh_oldfile { color: orange; }
+pre.sh_sourceCode .sh_newfile { color: #006400; }
+pre.sh_sourceCode .sh_difflines { color: blue; }
+
+/* for css */
+pre.sh_sourceCode .sh_selector { color: purple; }
+pre.sh_sourceCode .sh_property { color: blue; }
+pre.sh_sourceCode .sh_value { color: #006400; font-style: italic; }
+
+/* other */
+pre.sh_sourceCode .sh_section { color: black; font-weight: bold; }
+pre.sh_sourceCode .sh_paren { color: red; }
+pre.sh_sourceCode .sh_attribute { color: #006400; }
+
+</style><link charset="utf-8" type="text/css" rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"></head><body style="display: inherit;"><div class="head"><p><a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a></p><h1 class="title" id="title">Contacts API</h1><h2 id="w3c-working-draft-01-july-2010">W3C Working Draft 01 July 2010</h2><dl><dt>This version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100701/">http://www.w3.org/TR/2010/WD-contacts-api-20100701/</a></dd><dt>Latest published version:</dt><dd><a href="http://www.w3.org/TR/contacts-api/">http://www.w3.org/TR/contacts-api/</a></dd><dt>Latest editor's draft:</dt><dd><a href="http://dev.w3.org/2009/dap/contacts/">http://dev.w3.org/2009/dap/contacts/</a></dd><dt>Previous version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100121/">http://www.w3.org/TR/2010/WD-contacts-api-20100121/</a></dd><dt>Editor:</dt><dd>Richard Tibbett, Invited Expert</dd></dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2010 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p><hr></div>
+ <div class="introductory section" id="abstract"><h2>Abstract</h2>
+ <p>
+ The Contacts API defines the high-level interfaces required to provide access to a user's unified address book.
+ </p>
+ </div><div id="sotd" class="introductory section"><h2>Status of This Document</h2><p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed Contacts API. Issues and
+ editors note in the document highlight some of the points on which the group is still working and would particularly like to get
+ feedback.
+ </p>
+ <p>This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). All feedback is welcome.</p><p>Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p><p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 W3C Patent Policy</a>. W3C maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>.</p></div><div class="section" id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a class="tocxref" href="#conformance"><span class="secno">1. </span>Conformance</a></li><li class="tocline"><a class="tocxref" href="#introduction"><span class="secno">2. </span>
+ Introduction
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#usage-examples"><span class="secno">2.1 </span>
+ Usage Examples
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#security-and-privacy-considerations"><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-implementors-of-the-contacts-api"><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </a></li><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-recipients-of-contact-information"><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </a></li><li class="tocline"><a class="tocxref" href="#additional-implementation-considerations"><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#api-description"><span class="secno">4. </span>
+ API Description
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#servicecontacts-interface"><span class="secno">4.1 </span>
+ <span class="idlType formerLink idlType"><code>ServiceContacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes"><span class="secno">4.1.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacts-interface"><span class="secno">4.2 </span>
+ <span class="idlType formerLink idlType"><code>Contacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods"><span class="secno">4.2.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-interface"><span class="secno">4.3 </span>
+ <span class="idlType formerLink idlType"><code>Contact</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-1"><span class="secno">4.3.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#methods-1"><span class="secno">4.3.2 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactproperties-interface"><span class="secno">4.4 </span>
+ <span class="idlType formerLink idlType"><code>ContactProperties</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-2"><span class="secno">4.4.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactname-interface"><span class="secno">4.5 </span>
+ <span class="idlType formerLink idlType"><code>ContactName</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-3"><span class="secno">4.5.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfield-interface"><span class="secno">4.6 </span>
+ <span class="idlType formerLink idlType"><code>ContactField</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-4"><span class="secno">4.6.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaddress-interface"><span class="secno">4.7 </span>
+ <span class="idlType formerLink idlType"><code>ContactAddress</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-5"><span class="secno">4.7.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactorganization-interface"><span class="secno">4.8 </span>
+ <span class="idlType formerLink idlType"><code>ContactOrganization</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-6"><span class="secno">4.8.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaccount-interface"><span class="secno">4.9 </span>
+ <span class="idlType formerLink idlType"><code>ContactAccount</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-7"><span class="secno">4.9.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindoptions-interface"><span class="secno">4.10 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindOptions</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-8"><span class="secno">4.10.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindsuccesscb-interface"><span class="secno">4.11 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindSuccessCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-2"><span class="secno">4.11.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactsuccesscb-interface"><span class="secno">4.12 </span>
+ <span class="idlType formerLink idlType"><code>ContactSuccessCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-3"><span class="secno">4.12.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterrorcb-interface"><span class="secno">4.13 </span>
+ <span class="idlType formerLink idlType"><code>ContactErrorCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-4"><span class="secno">4.13.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterror-interface"><span class="secno">4.14 </span>
+ <span class="idlType formerLink idlType"><code>ContactError</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-9"><span class="secno">4.14.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#constants"><span class="secno">4.14.2 </span>Constants</a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-search-processing"><span class="secno">5. </span>
+ <span class="formerLink">Contact Search Processing</span>
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-qualifiers"><span class="secno">5.1 </span>
+ Search Qualifiers
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#complex-search-qualifiers"><span class="secno">5.1.1 </span>
+ Complex Search Qualifiers
+ </a></li><li class="tocline"><a class="tocxref" href="#search-qualifier-example"><span class="secno">5.1.2 </span>
+ Search Qualifier Example
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#options-processing"><span class="secno">5.2 </span>
+ Options Processing
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-cardinality"><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </a></li><li class="tocline"><a class="tocxref" href="#search-sorting"><span class="secno">5.2.2 </span>
+ Search Sorting
+ </a></li><li class="tocline"><a class="tocxref" href="#search-filters"><span class="secno">5.2.3 </span>
+ Search Filters
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-filter-example"><span class="secno">5.2.3.1 </span>
+ Search Filter Example
+ </a></li></ul></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#user-interaction-guidelines"><span class="secno">A. </span>
+ User Interaction Guidelines
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#sharing-contact-information"><span class="secno">A.1 </span>
+ Sharing Contact Information
+ </a></li><li class="tocline"><a class="tocxref" href="#contact-writebacks"><span class="secno">A.2 </span>
+ Contact Writebacks
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#saving-a-contact-to-the-address-book"><span class="secno">A.2.1 </span>
+ Saving a Contact to the Address Book
+ </a></li><li class="tocline"><a class="tocxref" href="#removing-a-contact-from-the-address-book"><span class="secno">A.2.2 </span>
+ Removing a Contact from the Address Book
+ </a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#search-weights"><span class="secno">B. </span>
+ Search Weights
+ </a></li><li class="tocline"><a class="tocxref" href="#references"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li class="tocline"><a class="tocxref" href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></div>
+
+ <div class="section" id="conformance"><!--OddPage--><h2><span class="secno">1. </span>Conformance</h2><p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
+<p>The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>, and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<a href="#bib-RFC2119" rel="biblioentry" class="bibref">RFC2119</a>].</p>
+
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn id="dfn-user-agent">user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [<a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a>], as this specification uses that specification and
+ terminology.
+ </p>
+ </div>
+ <div id="introduction" class="informative section">
+ <!--OddPage--><h2><span class="secno">2. </span>
+ Introduction
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of representing address book
+ information. Most users are required to maintain a plurality of contact lists which leads to multiple copies of address book data.
+ The multiplicity of address books that a user is required to maintain often leads to disjointed and inconsistent information being
+ stored across a user's address book providers.
+ </p>
+ <p>
+ Providing address book information to these service providers means handing over all of your data and trusting these providers with
+ the security and privacy of storing and sharing of your information. When sharing this data with 3rd parties users are, more often
+ than not, required to hand over access to their whole address book. Users are implicitly required to trust 3rd parties with all of
+ their data when, in reality, the user may only wish, or need, to share a subset of their address book information so that an
+ application can fulfill its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may be sourced from a
+ plurality of sources - both online and locally. This specification then defines the interfaces on which 3rd party applications can
+ access a user's unified address book; with explicit user permission and filtering. The focus of this data sharing is on making
+ the user aware of the data that they will share and putting them at the centre of the data sharing process; free to select both the
+ extent to which they share their address book information and the ability to restrict which pieces of information related to which
+ contact gets shared.
+ </p>
+ <p>
+ The API itself is agnostic of any underlying address book sources and storage. A conforming implementation is required to implement
+ all fields defined in this specification.
+ </p>
+ <div class="section" id="usage-examples">
+ <h3><span class="secno">2.1 </span>
+ Usage Examples
+ </h3>
+ <p>
+ The following code extracts illustrate how to search, add, remove and update contact information in a given address book:
+ </p>
+ <div>
+ <p>
+ Searching for matching contacts.
+ </p>
+ </div>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>displayName<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span></pre>
+ <div>
+ <p>
+ Creating a new contact.
+ </p>
+ </div>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// Create new contact </span>
+<span class="sh_keyword">var</span> myContact <span class="sh_symbol">=</span> <span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">create</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span>displayName<span class="sh_symbol">:</span> <span class="sh_string">'Robert'</span><span class="sh_cbracket">}}</span><span class="sh_symbol">);</span>
+
+<span class="sh_comment">// Add additional contact attributes as required...</span>
+<span class="sh_comment">// myContact.nicknames.push('bobby');</span></pre>
+ <div>
+ <p>
+ Saving a new contact in the underlying addressbook.
+ </p>
+ </div>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">successContactCallback</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact object</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>displayName<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Save new contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">save</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ <div>
+ <p>
+ Editing an existing contact.
+ </p>
+ </div>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_comment">// e.g. add a new phone number</span>
+myContact<span class="sh_symbol">.</span>phoneNumbers<span class="sh_symbol">.</span><span class="sh_function">push</span><span class="sh_symbol">(</span><span class="sh_cbracket">{</span>type<span class="sh_symbol">:</span> <span class="sh_string">'home'</span><span class="sh_symbol">,</span> value<span class="sh_symbol">:</span> <span class="sh_string">'+440000000002'</span><span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+
+<span class="sh_comment">// Update existing contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">save</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ <div>
+ <p>
+ Removing an existing contact.
+ </p>
+ </div>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_comment">// previous example follow-on...</span>
+
+<span class="sh_comment">// Remove existing contact</span>
+myContact<span class="sh_symbol">.</span><span class="sh_function">remove</span><span class="sh_symbol">(</span>successContactCallback<span class="sh_symbol">,</span> generalErrorCB<span class="sh_symbol">);</span></pre>
+ </div>
+ </div>
+ <div class="section" id="security-and-privacy-considerations">
+ <!--OddPage--><h2><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </h2>
+ <p class="note">
+ The overall architecture for addressing privacy in DAP is still under construction. As it is finalized, there may be changes made
+ to this API to reflect requirements or support for privacy-related functionality.
+ </p>
+ <p>
+ The API defined in this specification can be used to create, find, save and remove contact information from a user's address
+ book(s). All API methods disclose information related to a user's contacts such as their phone number(s), email address(es) and
+ other personally identifying information. The distribution of this information could potentially compromise the user's privacy.
+ A conforming implementation of this specification <em title="must" class="rfc2119">must</em> provide a mechanism that protects the user's privacy and this mechanism
+ should ensure that no contact information is creatable, retrivable, updateable or removable without the user's express
+ permission.
+ </p>
+ <div class="section" id="privacy-considerations-for-implementors-of-the-contacts-api">
+ <h3><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </h3>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must not create, find, save or delete contact information to Web sites without the express permission of the
+ user. A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must acquire permission through a user interface, unless they have prearranged trust relationships with
+ users, as described below. The user interface must include the URI of the document origin, as defined in [<a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a>]. Those
+ permissions that are acquired through the user interface and that are preserved beyond the current browsing session (i.e. beyond
+ the time when the browsing context, as defined in [<a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a>], is navigated to another URL) <em title="must" class="rfc2119">must</em> be revocable and a <a class="internalDFN" href="#dfn-user-agent">user
+ agent</a> must respect revoked permissions.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted permission for the same
+ Web site to access other methods provided by this API, or to access the same method with a different set of arguments, as part of
+ the same permission context. If a user has expressed permission for an implementation to, e.g. find a set of existing contacts,
+ the implementation must seek the user's express permission if and when any additional create, find, save or remove function
+ is called on this API.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> may have prearranged trust relationships that do not require such user interfaces. For example, while a Web
+ browser will present a user interface when a Web site performs an address book request, a Widget Runtime <em title="may" class="rfc2119">may</em> have a prearranged,
+ delegated security relationship with the user and, as such, a suitable alternative security and privacy mechanism with which to
+ authorize the creation, retrieval, update and/or removal of contact information.
+ </p>
+ </div>
+ <div class="section" id="privacy-considerations-for-recipients-of-contact-information">
+ <h3><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </h3>
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> only request contact information when necessary. Recipients <em title="must" class="rfc2119">must</em> only use the contact information for the task
+ for which it was provided to them. Recipients <em title="must" class="rfc2119">must</em> dispose of contact information once that task is completed, unless expressly
+ permitted to retain it by the user. Recipients <em title="must" class="rfc2119">must</em> also take measures to protect this information against unauthorized access.
+ If contact information is stored, users should be allowed to update and delete this information.
+ </p>
+ <p>
+ The recipient of contact information <em title="must" class="rfc2119">must</em> not retransmit the contact information without the user's express permission. Care
+ should be taken when retransmitting and use of encryption is encouraged.
+ </p>
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> clearly and conspicuously disclose the fact that they are collecting contact data, the purpose for the
+ collection, how long the data is retained, how the data is secured, how the data is shared if it is shared, how users can access,
+ update and delete the data, and any other choices that users have with respect to the data. This disclosure <em title="must" class="rfc2119">must</em> include an
+ explanation of any exceptions to the guidelines listed above.
+ </p>
+ </div>
+ <div id="additional-implementation-considerations" class="informative section">
+ <h3><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are also advised to consider the
+ following aspects that can negatively affect the privacy of their users: in certain cases, users can inadvertently grant
+ permission to the User Agent to disclose their contacts to Web sites. In other cases, the content hosted at a certain URL changes
+ in such a way that the previously granted contact permissions no longer apply as far as the user is concerned. Or the users might
+ simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive measures are an
+ implementation responsibility and not prescribed by this specification. However, in designing these measures, implementers are
+ advised to enable user awareness of contact sharing, and to provide easy access to interfaces that enable revocation of
+ permissions.
+ </p>
+ </div>
+ </div>
+ <div class="section" id="api-description">
+ <!--OddPage--><h2><span class="secno">4. </span>
+ API Description
+ </h2>
+ <div class="section" id="servicecontacts-interface">
+ <h3><span class="secno">4.1 </span>
+ <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface
+ </h3>
+ <p>
+ The <a href="#servicecontacts-interface"><code>ServiceContacts</code></a> interface is exposed on the <code>navigator.service</code>
+ object, as defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>].
+ </p>
+ <pre class="idl"><span class="idlImplements"><a>Service</a> implements <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a>;</span></pre><div class="idlImplementsDesc">
+
+ </div>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ServiceContacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ServiceContacts</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span> <span class="idlAttrName"><a href="#widl-ServiceContacts-contacts">contacts</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes"><h4><span class="secno">4.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ServiceContacts-contacts"><code>contacts</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span>, readonly</dt><dd>
+ The root node from which the contacts functionality can be accessed.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacts-interface">
+ <h3><span class="secno">4.2 </span>
+ <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface
+ </h3>
+ <p>
+ The <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface exposes a database collecting contacts information, such that they may be created, found, read,
+ updated, and deleted.
+ </p>
+ <p>
+ Multiple address books, taken from different sources, can be represented within this unified address book interface. Contacts
+ from different sources can be distinguished using the <a href="#widl-Contact-serviceId"><code>serviceId</code></a> field.. In addition, multiple address books can be displayed
+ by filtering on the required <a href="#widl-Contact-serviceId"><code>serviceId</code></a> value via the <code>Contacts</code> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+ <p>
+ Equally, multiple contact groups can be represented within this unified address book by specifying consistent <a href="#widl-ContactProperties-tags"><code>tags</code></a> value(s) as part of individual <a href="#contact-interface"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering on the
+ required <a href="#widl-ContactProperties-tags"><code>tags</code></a> value(s) via the <code>Contacts</code> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contacts</span> {
+<span class="idlMethod"> <span class="idlMethType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlMethName"><a href="#widl-Contacts-create">create</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></span> <span class="idlParamName">attributes</span></span>);</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contacts-find">find</a></span> (<span class="idlParam">in <span class="idlParamType"><a>DOMString</a>[]</span> <span class="idlParamName">fields</span></span>, <span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a>?</span> <span class="idlParamName">options</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods"><h4><span class="secno">4.2.1 </span>Methods</h4><dl class="methods"><dt id="widl-Contacts-create"><code>create</code></dt><dd>
+ Create a new <code>Contact</code> object.
+ <p>
+ This method takes one argument. When called, it returns a <a href="#contact-interface"><code>Contact</code></a> object.
+ </p>
+ <p>
+ The newly created <a href="#contact-interface"><code>Contact</code></a> object <em title="must not" class="rfc2119">must not</em> be stored in the user's address book as a result of
+ calling this method. The <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-save">save()</a> method <em title="must" class="rfc2119">must</em> be called on the response of this method to store the new <a href="#contact-interface"><code>Contact</code></a> object in the user's address book.
+ </p>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">attributes</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The attributes to assign to the resulting object.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></div></dd><dt id="widl-Contacts-find"><code>find</code></dt><dd>
+ <p>
+ Find contacts in the address book according to the <a class="internalDFN" href="#dfn-find-contacts-process">find contacts process</a> detailed below.
+ </p>
+ <p>
+ This method takes two, three or four arguments. When called, it immediately returns a <code>PendingOp</code> object , as
+ defined in [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-find-contacts-process">find contacts process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, invoke the <code>errorCB</code> with a <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ Search for contacts in the address book according to the rules defined in <a href="#contact-search-processing">Contact Search Processing</a>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">fields</td><td class="prmType"><code><a>DOMString</a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </td></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr><tr><td class="prmName">options</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ The options to apply to the output of this method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contact-interface">
+ <h3><span class="secno">4.3 </span>
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contact-interface"><code>Contact</code></a> interface captures a single contact item. This interface extends <a href="#contactproperties-interface"><code>ContactProperties</code></a> attributes.
+ </p>
+ <p>
+ All <a href="#contact-interface"><code>Contact</code></a> objects <em title="must" class="rfc2119">must</em> include all attributes supported by the implementation,
+ regardless of whether these attributes have been assigned a non-<code>null</code> value or a <code>null</code> value.
+ </p>
+ <p>
+ If a supported attribute has not been assigned a value by the user and/or implementation, then this attribute <em title="must" class="rfc2119">must</em> still be
+ present in the resulting <a href="#contact-interface"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contact">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contact</span> : <span class="idlSuperclass"><a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a></span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-id">id</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-Contact-serviceId">serviceId</a></span>;</span>
+<span class="idlMethod"> <span class="idlMethType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlMethName"><a href="#widl-Contact-clone">clone</a></span> ();</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contact-save">save</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>);</span>
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contact-remove">remove</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>);</span>
+};</span>
+</pre><div class="section" id="attributes-1"><h4><span class="secno">4.3.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-Contact-id"><code>id</code> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly</dt><dd>
+ <p>
+ A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> referenced from
+ <code>Contacts</code> <em title="must" class="rfc2119">must</em> include a non-empty <code>id</code> value.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> maintain this globally unique resource identifier when a Contact is added to, or present within, an
+ Address Book.
+ </p>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>id</code>] for additional definition of this attribute.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-serviceId"><code>serviceId</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ <p class="note">
+ Can we remove this attribute? Does a web application need to know the storage location of a Contact record?<br>
+ <br>
+ This directly relates to <a href="http://www.w3.org/2009/dap/track/issues/43">ISSUE-43</a> and discussion thread <a href="http://lists.w3.org/Archives/Public/public-device-apis/2010Jun/0248.html">http://lists.w3.org/Archives/Public/public-device-apis/2010Jun/0248.html</a>.
+ </p>
+ <p>
+ An identifier that <em title="may" class="rfc2119">may</em> be provided that represents the address book owner of the current contact object.
+ </p>
+ <p>
+ This attribute enables multiple address book sources to be tagged and filtered on Contact objects.
+ </p>
+ <p>
+ The following constants are defined for use in the <code>serviceId</code> attribute for addressing non-networked storage
+ databases:
+ </p>
+<pre>
+'uicc', 'device'.
+</pre>
+ <p>
+ A conforming implementation <em title="must" class="rfc2119">must</em> define a <dfn id="dfn-default-service-identifier">default service identifier</dfn> on which to store <a href="#contact-interface"><code>Contact</code></a> objects that have not yet been assigned to any storage database. The
+ <a class="internalDFN" href="#dfn-default-service-identifier">default service identifier</a> will then be used in the <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-save">save()</a> operation when a serviceId is not recognized or when the serviceId attribute is
+ <code>null</code>.
+ </p>
+ <p>
+ For all other Contacts sources, it is recommended that the serviceId attribute is assigned as a URI.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="methods-1"><h4><span class="secno">4.3.2 </span>Methods</h4><dl class="methods"><dt id="widl-Contact-clone"><code>clone</code></dt><dd>
+ <p>
+ Create a deep clone copy of the current object minus the current object's <a href="#widl-Contact-id"><code>id</code></a> attribute.
+ </p>
+ <p>
+ The resulting object <em title="must" class="rfc2119">must</em> be provided with a newly generated <a href="#widl-Contact-id"><code>id</code></a> attribute to distiguish the cloned object from the original object.
+ </p>
+ <div><em>No parameters.</em></div><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></div></dd><dt id="widl-Contact-remove"><code>remove</code></dt><dd>
+ <p>
+ Remove the current contact from the address book.
+ </p>
+ <p>
+ In the case that the current <a href="#widl-Contact-id"><code>id</code></a> attribute is <code>null</code> and this method is invoked, a <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> <em title="must" class="rfc2119">must</em> be triggered as part of the <a class="internalDFN" href="#dfn-remove-contact-process">remove contact
+ process</a>. This error <em title="must" class="rfc2119">must</em> consist of a <a href="#contacterror-interface"><code>ContactError</code></a> object with a <code>code</code> of <a href="#widl-ContactError-NOT_FOUND_ERROR"><code>NOT_FOUND_ERROR</code></a>.
+ </p>
+ <p>
+ This method takes one or two arguments. When called, it immediately returns a <code>PendingOp</code> object, as defined in
+ [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-remove-contact-process">remove contact process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, invoke the <code>errorCB</code> with a <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ Remove the current object from <a href="#contacts-interface"><code>Contacts</code></a>.
+ </li>
+ <li>
+ If the removal of the current object from <a href="#contacts-interface"><code>Contacts</code></a> was successful, set the current object's <a href="#widl-Contact-id"><code>Contact.id</code></a> value to <code>null</code> and the current object's <a href="#widl-Contact-serviceId"><code>Contact.serviceId</code></a> value to <code>null</code>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd><dt id="widl-Contact-save"><code>save</code></dt><dd>
+ <p>
+ Add or update (as appropriate) the current <a href="#contact-interface"><code>Contact</code></a> object to the <a href="#contacts-interface"><code>Contacts</code></a>.
+ </p>
+ <p>
+ This method takes one or two arguments. When called, it immediately returns a <code>PendingOp</code> object , as defined in
+ [<a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a>], and then asynchronously starts a <dfn id="dfn-save-contact-process">save contact process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, invoke the <code>errorCB</code> with a <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ If the current <a href="#widl-Contact-serviceId"><code>Contact.serviceId</code></a> value is not recognized in <a href="#contacts-interface"><code>Contacts</code></a> or a <a href="#widl-Contact-serviceId"><code>Contact.serviceId</code></a> value has not been set, create and set a new <a href="#widl-Contact-serviceId"><code>Contact.serviceId</code></a> value to the <a class="internalDFN" href="#dfn-default-service-identifier">default service identifier</a>.
+ </li>
+ <li>
+ If the current <a href="#widl-Contact-id"><code>Contact.id</code></a> value is not recognized in <a href="#contacts-interface"><code>Contacts</code></a> or a <a href="#widl-Contact-id"><code>Contact.id</code></a> value has not been set, create and set a new <a href="#widl-Contact-id"><code>Contact.id</code></a> value and add the current object as a new object to <a href="#contacts-interface"><code>Contacts</code></a>.
+ </li>
+ <li>
+ If the <a href="#widl-Contact-id"><code>Contact.id</code></a> already exists in <a href="#contacts-interface"><code>Contacts</code></a> then update the existing object in <a href="#contacts-interface"><code>Contacts</code></a>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactproperties-interface">
+ <h3><span class="secno">4.4 </span>
+ <a class="idlType" href="#idl-def-ContactProperties"><code>ContactProperties</code></a> interface
+ </h3>
+ <p class="note">
+ The use of Portable Contacts schema as the format for contacts is subject to further discussions in the group.
+ </p>
+ <p>
+ The <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface captures the settable properties of a contact.
+ All properties included in this interface have a corresponding definition in [<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>].
+ </p>
+ <p>
+ In addition to the properties defined in this interface, a conforming implementation <em title="must" class="rfc2119">must</em> support both the Singular and Plural
+ OpenSocial fields defined in [<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>].
+ </p>
+ <p class="note">
+ The inclusion of OpenSocial fields in the paragraph above needs further explanation, particularly in relation to contact database
+ searching and sorting.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactProperties">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactProperties</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-displayName">displayName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-nickname">nickname</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-phoneNumbers">phoneNumbers</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-emails">emails</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-addresses">addresses</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-ims">ims</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-organizations">organizations</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-published">published</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-updated">updated</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-birthday">birthday</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-anniversary">anniversary</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-gender">gender</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-note">note</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-preferredUsername">preferredUsername</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-photos">photos</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-tags">tags</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-relationships">relationships</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-urls">urls</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactProperties-accounts">accounts</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-utcOffset">utcOffset</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactProperties-connected">connected</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-2"><h4><span class="secno">4.4.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactProperties-accounts"><code>accounts</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>accounts</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-addresses"><code>addresses</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>addresses</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-anniversary"><code>anniversary</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>anniversary</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-birthday"><code>birthday</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>birthday</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-connected"><code>connected</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p class="note">
+ Ignore this [<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] attribute?
+ </p>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>connected</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-displayName"><code>displayName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>displayName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-emails"><code>emails</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>emails</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-gender"><code>gender</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>gender</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-ims"><code>ims</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>ims</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-name"><code>name</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>name</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-nickname"><code>nickname</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>nickname</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-note"><code>note</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>note</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-organizations"><code>organizations</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>organizations</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-phoneNumbers"><code>phoneNumbers</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>phoneNumbers</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-photos"><code>photos</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>photos</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-preferredUsername"><code>preferredUsername</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>preferredUsername</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-published"><code>published</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>published</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-relationships"><code>relationships</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>relationships</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-tags"><code>tags</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>tags</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-updated"><code>updated</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>updated</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-urls"><code>urls</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.2. <code>urls</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactProperties-utcOffset"><code>utcOffset</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>] Section 7.2.1. <code>utcOffset</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactname-interface">
+ <h3><span class="secno">4.5 </span>
+ <a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactname-interface"><code>ContactName</code></a> interface describes a contact's name.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactName">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactName</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-familyName">familyName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-givenName">givenName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-middleName">middleName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificPrefix">honorificPrefix</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificSuffix">honorificSuffix</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-3"><h4><span class="secno">4.5.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactName-familyName"><code>familyName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>familyName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>formatted</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-givenName"><code>givenName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>givenName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificPrefix"><code>honorificPrefix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>honorificPrefix</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificSuffix"><code>honorificSuffix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>honorificSuffix</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-middleName"><code>middleName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.3. <code>middleName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfield-interface">
+ <h3><span class="secno">4.6 </span>
+ <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface
+ </h3>
+ <p>
+ The ContactField interface is a reusable component that is used to support contact fields within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactField">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactField</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-value">value</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactField-primary">primary</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-4"><h4><span class="secno">4.6.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactField-primary"><code>primary</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.2.2. <code>primary</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.2.2. <code>type</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-value"><code>value</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.2.2. <code>value</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactaddress-interface">
+ <h3><span class="secno">4.7 </span>
+ <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface
+ </h3>
+ <p>
+ The ContactAddress interface is a reusable component that is used to support contact addresses within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAddress">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAddress</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-streetAddress">streetAddress</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-locality">locality</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-region">region</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-postalCode">postalCode</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-country">country</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-5"><h4><span class="secno">4.7.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAddress-country"><code>country</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>country</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>formatted</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-locality"><code>locality</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>locality</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-postalCode"><code>postalCode</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>postalCode</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-region"><code>region</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>region</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-streetAddress"><code>streetAddress</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.4. <code>streetAddress</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactorganization-interface">
+ <h3><span class="secno">4.8 </span>
+ <a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a> interface
+ </h3>
+ <p>
+ The ContactOrganization interface is a reusable component that is used to support contact organizations within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactOrganization">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactOrganization</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-department">department</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-title">title</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-startDate">startDate</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-endDate">endDate</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-location">location</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-description">description</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-6"><h4><span class="secno">4.8.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactOrganization-department"><code>department</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>department</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-description"><code>description</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>description</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-endDate"><code>endDate</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>endDate</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-location"><code>location</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>location</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-name"><code>name</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>name</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-startDate"><code>startDate</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>startDate</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-title"><code>title</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.5. <code>title</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactaccount-interface">
+ <h3><span class="secno">4.9 </span>
+ <a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a> interface
+ </h3>
+ <p>
+ The ContactAccount interface is a reusable component that is used to support contact accounts within the <a href="#contactproperties-interface"><code>ContactProperties</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAccount">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAccount</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-domain">domain</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-username">username</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-userid">userid</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-7"><h4><span class="secno">4.9.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAccount-domain"><code>domain</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.6. <code>domain</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-userid"><code>userid</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.6. <code>userid</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-username"><code>username</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a>]] Section 7.6. <code>username</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindoptions-interface">
+ <h3><span class="secno">4.10 </span>
+ <a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> interface describes the options that can be applied to
+ contact searching. When a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation, it should be processed according to the provisions detailed in <a href="#options-processing">Options Processing</a>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindOptions">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindOptions</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>String</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-filter">filter</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-multiple">multiple</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>unsigned short</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-limit">limit</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-updatedSince">updatedSince</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-8"><h4><span class="secno">4.10.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactFindOptions-filter"><code>filter</code> of type <span class="idlAttrType"><a>String</a></span>, nullable</dt><dd>
+ A DOMString-based <a class="internalDFN" href="#dfn-search-filter">search filter</a> with which to search and intially filter the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-limit"><code>limit</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, nullable</dt><dd>
+ <p>
+ The maximum number of results to return from the contacts search.
+ </p>
+ <p>
+ This parameter only applies in the case that the associated <code>multiple</code> attribute is equal to <code>true</code>.
+ </p>
+ <p>
+ If no value is provided, the search will return all <a href="#contact-interface"><code>Contact</code></a> object results.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-multiple"><code>multiple</code> of type <span class="idlAttrType"><a>boolean</a></span>, nullable</dt><dd>
+ A boolean value to indicate whether multiple Contact objects are returnable as part of the associated <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-updatedSince"><code>updatedSince</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ Return only contact records that have been updated on or after the given time, specified as an xs:dateTime.
+ </p>
+ <p>
+ This filter is based on the <a href="#widl-ContactProperties-updated"><code>updated</code></a> field as defined in <a href="#contactproperties-interface"><code>ContactProperties</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindsuccesscb-interface">
+ <h3><span class="secno">4.11 </span>
+ <a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindSuccessCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindSuccessCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactFindSuccessCB-onSuccess">onSuccess</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</span> <span class="idlParamName">contactObjs</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-2"><h4><span class="secno">4.11.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactFindSuccessCB-onSuccess"><code>onSuccess</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObjs</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact objects resulting from the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method. <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a>
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactsuccesscb-interface">
+ <h3><span class="secno">4.12 </span>
+ <a class="idlType" href="#idl-def-ContactSuccessCB"><code>ContactSuccessCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactSuccessCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactSuccessCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactSuccessCB-onSuccess">onSuccess</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></span> <span class="idlParamName">contactObj</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-3"><h4><span class="secno">4.12.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactSuccessCB-onSuccess"><code>onSuccess</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObj</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact object resulting from the given <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-save">save()</a> or <a href="#contact-interface"><code>Contact</code></a> <a href="#widl-Contact-remove">remove()</a> method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacterrorcb-interface">
+ <h3><span class="secno">4.13 </span>
+ <a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactErrorCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactErrorCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactErrorCB-onError">onError</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></span> <span class="idlParamName">error</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-4"><h4><span class="secno">4.13.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactErrorCB-onError"><code>onError</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">error</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact API related error object.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacterror-interface">
+ <h3><span class="secno">4.14 </span>
+ <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contacterror-interface"><code>ContactError</code></a> interface encapsulates all errors in the manipulation of <a href="#contact-interface"><code>Contact</code></a> objects in the Contacts API.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactError</span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-UNKNOWN_ERROR">UNKNOWN_ERROR</a></span> = <span class="idlConstValue">0</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-INVALID_ARGUMENT_ERROR">INVALID_ARGUMENT_ERROR</a></span> = <span class="idlConstValue">1</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_FOUND_ERROR">NOT_FOUND_ERROR</a></span> = <span class="idlConstValue">2</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-TIMEOUT_ERROR">TIMEOUT_ERROR</a></span> = <span class="idlConstValue">3</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PENDING_OPERATION_ERROR">PENDING_OPERATION_ERROR</a></span> = <span class="idlConstValue">4</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-IO_ERROR">IO_ERROR</a></span> = <span class="idlConstValue">5</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_SUPPORTED_ERROR">NOT_SUPPORTED_ERROR</a></span> = <span class="idlConstValue">6</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PERMISSION_DENIED_ERROR">PERMISSION_DENIED_ERROR</a></span> = <span class="idlConstValue">20</span>;</span>
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactError-code">code</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-9"><h4><span class="secno">4.14.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactError-code"><code>code</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, readonly</dt><dd>
+ An error code assigned by an implementation when an error has occurred in Contacts API processing.
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="constants"><h4><span class="secno">4.14.2 </span>Constants</h4><dl class="constants"><dt id="widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An invalid parameter was provided when the requested method was invoked.
+ </dd><dt id="widl-ContactError-IO_ERROR"><code>IO_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An error occurred in communication with the underlying implementation that meant the requested method could not complete.
+ </dd><dt id="widl-ContactError-NOT_FOUND_ERROR"><code>NOT_FOUND_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If no response information can be provided from the requested method.
+ </dd><dt id="widl-ContactError-NOT_SUPPORTED_ERROR"><code>NOT_SUPPORTED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method is not supported by the current implementation.
+ </dd><dt id="widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If the <a class="internalDFN" href="#dfn-user-agent">user agent</a> is currently waiting for a callback on a current find(), save() or remove() operation, as defined in
+ this specification.
+ </dd><dt id="widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ Access to the requested method was denied at the implementation or by the user.
+ </dd><dt id="widl-ContactError-TIMEOUT_ERROR"><code>TIMEOUT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method timed out before it could be completed.
+ </dd><dt id="widl-ContactError-UNKNOWN_ERROR"><code>UNKNOWN_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An unknown error occurred.
+ </dd></dl></div>
+ </div>
+ </div>
+ <!-- end api description section -->
+ <div class="section" id="contact-search-processing">
+ <!--OddPage--><h2><span class="secno">5. </span>
+ <a>Contact Search Processing</a>
+ </h2>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method provides an operation to search for one of more <a href="#contact-interface"><code>Contact</code></a> objects within the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <div class="section" id="search-qualifiers">
+ <h3><span class="secno">5.1 </span>
+ Search Qualifiers
+ </h3>
+ <p>
+ The <dfn id="dfn-search-qualifier">search qualifier</dfn> provides an application with a way to request the specific subset of <a href="#contactproperties-interface"><code>ContactProperties</code></a> it wishes to obtain in any resulting successful callback.
+ The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is deployed to minimize the data that needs to be shared with an application in order to let that
+ application fulfill its function on behalf of the user. The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is included within a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation as the <code>filter</code> parameter.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> <em title="must" class="rfc2119">must</em> be specified from a requesting application as a part of any <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ If the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must not" class="rfc2119">must not</em> return any <a href="#contactproperties-interface"><code>ContactProperties</code></a> within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ In the case that the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>non-zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return only the matching <a href="#contactproperties-interface"><code>ContactProperties</code></a> within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ If a specific <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> element provided, or <code>filter[x]</code>, does not match any well-known <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute, <code>filter[x]</code> <em title="should" class="rfc2119">should</em> be ignored when
+ executing the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <div class="section" id="complex-search-qualifiers">
+ <h4><span class="secno">5.1.1 </span>
+ Complex Search Qualifiers
+ </h4>
+ <p>
+ Certain <a href="#contactproperties-interface"><code>ContactProperties</code></a> attributes can be considered complex by the fact that
+ the information they contain is available only through child DOMString-based attributes of a complex Object object.
+ </p>
+ <p>
+ In such cases, a requesting application <em title="must" class="rfc2119">must</em> be able to request both the full complex <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute and also be able to request individual parts
+ of a complex <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute in the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided to a
+ <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ For example, the <code>name</code> attribute of <a href="#contactproperties-interface"><code>ContactProperties</code></a> is defined to be of complex type <a href="#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may request either the full
+ complex attribute (i.e. <code>name</code>) or specific individual attributes of this complex attribute (i.e.
+ <code>name.formatted</code>, <code>name.familyName</code>, <code>name.givenName</code>, <code>name.middleName</code>,
+ <code>name.honorificPrefix</code>, <code>name.honorificSuffix</code>) as part of a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation's <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </p>
+ <p>
+ In the case that a complex <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute is defined as a sequence or array of complex
+ objects, specific individual attributes can be referenced by using the complex attribute name, a dot (<code>.</code>) character
+ and the individual attribute to be retrieved.
+ </p>
+ <p>
+ For example, the <code>addresses</code> attribute of <a href="#contactproperties-interface"><code>ContactProperties</code></a> allows multiple <a href="#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request individual attributes of
+ this complex attribute an application would request e.g. <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ </p>
+ </div>
+ <div class="section" id="search-qualifier-example">
+ <h4><span class="secno">5.1.2 </span>
+ Search Qualifier Example
+ </h4>
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="example sh_javascript sh_sourceCode">navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'emails.value'</span><span class="sh_symbol">,</span> <span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'friends'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>j <span class="sh_keyword">in</span> contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">)</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">[</span>j<span class="sh_symbol">]);</span>
+ <span class="sh_cbracket">}</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span></pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol>
+ <li>
+ Return only the valid <a href="#contactproperties-interface"><code>ContactProperties</code></a> requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>emails.value</code> - <code>friends</code> is not a valid <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute so ignore this element).
+ </li>
+ </ol>
+ </div>
+ </div>
+ <div class="section" id="options-processing">
+ <h3><span class="secno">5.2 </span>
+ Options Processing
+ </h3>
+ <div class="section" id="search-cardinality">
+ <h4><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </h4>
+ <p>
+ By default, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence or a single <a href="#contact-interface"><code>Contact</code></a> object, accessible as part of the sequence returned in the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> callback function.
+ </p>
+ <p>
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>multiple</code> attribute is set to <code>true</code>, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence, a single <a href="#contact-interface"><code>Contact</code></a> object or <var>[X]</var> number of <a href="#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> callback function.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> specify a suitable integer-based <dfn id="dfn-upper-cardinality-limit">upper cardinality limit</dfn> to limit the maximum number of
+ Contact objects that may be returned in the case that the <code>multiple</code> flag is <code>true</code> and the
+ <code>limit</code> flag is <a class="internalDFN" href="#dfn-out-of-bounds">out of bounds</a>.
+ </p>
+ <p>
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is greater than zero and less than or
+ equal to the implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>, then <var>[X]</var> <em title="must" class="rfc2119">must</em> be set to the provided
+ <code>limit</code> value.
+ </p>
+ <p>
+ The <code>limit</code> attribute is <dfn id="dfn-out-of-bounds">out of bounds</dfn> if a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is less than or equal to zero or greater
+ than the implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>. In this case <var>[X]</var> <em title="must" class="rfc2119">must</em> be set to the
+ implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>.
+ </p>
+ </div>
+ <div class="section" id="search-sorting">
+ <h4><span class="secno">5.2.2 </span>
+ Search Sorting
+ </h4>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation must return successful callback results according to the sorting guidelines
+ defined in this section.
+ </p>
+ <p>
+ A <dfn id="dfn-search-weight">search weight</dfn> is a numeric value defined for each attribute in a <a href="#contact-interface"><code>Contact</code></a> object. A lower value denotes a higher placing in the ultimate sorting of
+ <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> results. Search weights for each <a href="#contactproperties-interface"><code>ContactProperties</code></a> field are defined in <a href="#search-weights">Appendix B</a>.
+ </p>
+ <p>
+ For example, if a <a class="internalDFN" href="#dfn-search-filter">search filter</a> of 'Bob' matches to <code>name.givenName</code> in Object A and to
+ <code>displayName</code> in Object B, Object B will be the first result object returned from the successCB of the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation, followed by Object A.
+ </p>
+ <p class="note">
+ Include UNICODE guidelines for intra-attribute sorting of results (where multiple Contact objects match on the same
+ attribute)... [<a href="#bib-UNICODE" rel="biblioentry" class="bibref">UNICODE</a>] DUCET
+ </p>
+ </div>
+ <div class="section" id="search-filters">
+ <h4><span class="secno">5.2.3 </span>
+ Search Filters
+ </h4>
+ <p>
+ A <dfn id="dfn-search-filter">search filter</dfn> <em title="may" class="rfc2119">may</em> be specified from a requesting web application to initially filter the Contacts database to a
+ more specific set of <a href="#contact-interface"><code>Contact</code></a> objects in which it is interested. The <a class="internalDFN" href="#dfn-search-filter">search filter</a> is included as
+ the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-filter">search filter</a> is used to search all the fields of a <a href="#contacts-interface"><code>Contacts</code></a> database and represents the logical union, or <code>∪</code>, of
+ provided values that are matched therein.
+ </p>
+ <p>
+ All contact searching <em title="must" class="rfc2119">must</em> apply a loose-matching policy to the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided. If a <a href="#contactproperties-interface"><code>ContactProperties</code></a> attribute being searched in a <a href="#contact-interface"><code>Contact</code></a> object, stored within the <a href="#contacts-interface"><code>Contacts</code></a> database, is a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> of the input filter value, that
+ <a href="#contact-interface"><code>Contact</code></a> object <em title="must" class="rfc2119">must</em> be returned as part of the resulting <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a>.
+ </p>
+ <p>
+ A <dfn id="dfn-partial-value-match">partial value match</dfn> refers to both syntactic and semantic partial matching of an input filter value with a
+ corresponding value in the address book and denotes that a corresponding match was found in the address book that begins with,
+ contains or ends with the value of the input filter value, or any variation thereof.
+ </p>
+ <p>
+ Comparing two strings in a <dfn id="dfn-compatibility-caseless">compatibility caseless</dfn> manner means using the Unicode <em>compatibility caseless
+ match</em> operation to compare the two strings. [<a href="#bib-UNICODE" rel="biblioentry" class="bibref">UNICODE</a>]
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> <em title="must" class="rfc2119">must</em> use the <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner in which to match against corresponding values
+ in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-rules-for-processing-search-filters">rules for processing search filters</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter provided within the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="contactsets">contactsets</var> be initially the set of all known contacts in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <p>
+ Let <var title="contactsresult">contactsresult</var> be initially an empty Object object.
+ </p>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is a DOMString object
+ </dt>
+ <dd>
+ <ol>
+ <li>
+ Let <var title="contactset">contactset</var> be the next enumerable Object in <var title="contactsets">contactsets</var>. If there is no next enumerable Object, go to step 5.
+ </li>
+ <li>
+ Let <var title="partialMatchFound">partialMatchFound</var> be the result of applying the <a class="internalDFN" href="#dfn-partial-matching-algorithm">partial matching algorithm</a>,
+ providing <var title="filter">filter</var> and <var title="contactset">contactset</var> as inputs.
+ </li>
+ <li>
+ If <var title="partialMatchFound">partialMatchFound</var> is <code>true</code>, add <var title="contactset">contactset</var> to <var title="contactsresult">contactsresult</var>.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Sort <var title="contactsresult">contactsresult</var> according to the guidelines in <a href="#search-sorting">Search Sorting</a>.
+ </li>
+ <li>
+ Return <var title="contactsresult">contactsresult</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <var title="contactsets">contactsets</var>.
+ </p>
+ </dd>
+ </dl>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-partial-matching-algorithm">partial matching algorithm</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the input string to compare; and a <var title="contactset">contactset</var> parameter, representing an individual <a href="#contact-interface"><code>Contact</code></a> object:
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be initially set to <code>false</code>.
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is an Object object
+ </dt>
+ <dd>
+ <ol>
+ <li>
+ Let <var title="elementvalue">elementvalue</var> be the String value of the next enumerable property in <var title="contactset">contactset</var>. If there are no more enumerable properties, go to step 5.
+ </li>
+ <li>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be the boolean result for the comparison of <var title="filter">filter</var> with <var title="elementvalue">elementvalue</var> in a <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner and with a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a>
+ policy applied to both sides of the comparison operation.
+ </li>
+ <li>
+ If <var title="hasPartialMatch">hasPartialMatch</var> is <code>true</code>, go to step 5.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Return <var title="hasPartialMatch">hasPartialMatch</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <code>false</code>.
+ </p>
+ </dd>
+ </dl>
+ <p>
+
+ </p>
+ <div class="section" id="search-filter-example">
+ <h5><span class="secno">5.2.3.1 </span>
+ Search Filter Example
+ </h5>
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="example sh_javascript sh_sourceCode">navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.locality'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.country'</span><span class="sh_symbol">,</span> <span class="sh_string">'phoneNumbers'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>x <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>x<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>
+ filter<span class="sh_symbol">:</span> <span class="sh_string">'Robert'</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span></pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol>
+ <li>
+ Using ECMA-262 3rd Edition regular expression syntax and psuedo-code, the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided can be represented
+ as:
+<pre> ( displayName = /∧.*Robert.*$/i ) ∪ ( name.formatted = /∧.*Robert.*$/i ) ∪ ( nickname = /∧.*Robert.*$/i )
+ ∪ ( tags.value = /∧.*Robert.*$/i ) ∪ ( phoneNumbers.value = /∧.*Robert.*$/i ) ∪ ( addresses.formatted = /∧.*Robert.*$/i )
+ ∪ ... etc for all contact attributes and properties ...
+</pre>
+ </li>
+ <li>
+ Return only the valid <a href="#contactproperties-interface"><code>ContactProperties</code></a> requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>addresses.locality</code>, <code>addresses.country</code>, <code>phoneNumbers</code>,
+ <code>emails</code>) and only for the <a href="#contact-interface"><code>Contact</code></a> objects returned from the <a class="internalDFN" href="#dfn-rules-for-processing-search-filters">rules for processing search filters</a>
+ with the <a class="internalDFN" href="#dfn-search-filter">search filter</a> derived in step 1 provided as the <var>filter</var> input parameter.
+ </li>
+ </ol>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div id="user-interaction-guidelines" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">A. </span>
+ User Interaction Guidelines
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the contact information that may
+ be shared, saved or removed from their unified address book. This annex provides some examples of a conformant user experience that
+ this specification enables.
+ </p>
+ <div class="section" id="sharing-contact-information">
+ <h3><span class="secno">A.1 </span>
+ Sharing Contact Information
+ </h3>
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span><span class="sh_predef_var">name</span><span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span></pre>
+ <p>
+ As a result of executing this code, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a non-blocking <dfn id="dfn-contact-search-notification">contact search notification</dfn> as
+ follows:
+ </p>
+ <p align="center">
+ <img src="contacts_notification.png" alt="Contact Search Notification"><br>
+ (<a href="contacts_notification.png">View as PNG</a>)
+ </p>
+ <p>
+ If an additional find(), save() or remove() operation is called by the current web application before the user has clicked
+ 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> defined for the find() operation will be invoked with an error
+ code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a <dfn id="dfn-contact-picker">contact picker</dfn>, utilising all of the
+ parameters provided in the find() operation as follows:
+ </p>
+ <p align="center">
+ <img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is requesting and the option to select
+ one or more contacts (as appropriate) from the user interface.
+ </p>
+ <p>
+ If an additional find(), save() or remove() operation is called by the current web application before the user has clicked
+ 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> associated to the current find() operation will be invoked with
+ an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> associated to the current find() operation will be
+ invoked with the contact information selected by the user provided as the only parameter.
+ </p>
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the user should easily
+ be able to review and revoke permissions to web applications at a later date.
+ </p>
+ <p class="note">
+ Include permission review/revocation mockup?
+ </p>
+ </div>
+ <div class="section" id="contact-writebacks">
+ <h3><span class="secno">A.2 </span>
+ Contact Writebacks
+ </h3>
+ <div class="section" id="saving-a-contact-to-the-address-book">
+ <h4><span class="secno">A.2.1 </span>
+ Saving a Contact to the Address Book
+ </h4>
+ <p class="note">
+ Include Contact creation/modification writeback mockup.
+ </p>
+ </div>
+ <div class="section" id="removing-a-contact-from-the-address-book">
+ <h4><span class="secno">A.2.2 </span>
+ Removing a Contact from the Address Book
+ </h4>
+ <p class="note">
+ Include Contact deletion writeback mockup.
+ </p>
+ </div>
+ </div>
+ </div>
+ <div id="search-weights" class="appendix section">
+ <!--OddPage--><h2><span class="secno">B. </span>
+ Search Weights
+ </h2>
+ <p>
+ The following table defines the <a class="internalDFN" href="#dfn-search-weight">search weight</a> values for each <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided in this specification.
+ </p>
+ <table class="simple" summary="Search Weights by Search Qualifier">
+ <thead>
+ <tr>
+ <th>
+ <a class="internalDFN" href="#dfn-search-qualifier">Search Qualifier</a>
+ </th>
+ <th>
+ <a class="internalDFN" href="#dfn-search-weight">Search Weight</a>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>displayName</code>
+ </td>
+ <td>
+ 1
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.formatted</code>
+ </td>
+ <td>
+ 2
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>nickname</code>
+ </td>
+ <td>
+ 3
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.value</code>
+ </td>
+ <td>
+ 4
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.value</code>
+ </td>
+ <td>
+ 5
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.formatted</code>
+ </td>
+ <td>
+ 6
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.name</code>
+ </td>
+ <td>
+ 7
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.value</code>
+ </td>
+ <td>
+ 8
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.value</code>
+ </td>
+ <td>
+ 9
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>preferredUsername</code>
+ </td>
+ <td>
+ 10
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.familyName</code>
+ </td>
+ <td>
+ 11
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.givenName</code>
+ </td>
+ <td>
+ 12
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.middleName</code>
+ </td>
+ <td>
+ 13
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.country</code>
+ </td>
+ <td>
+ 14
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.region</code>
+ </td>
+ <td>
+ 15
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.streetAddress</code>
+ </td>
+ <td>
+ 16
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.locality</code>
+ </td>
+ <td>
+ 17
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.postalCode</code>
+ </td>
+ <td>
+ 18
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.department</code>
+ </td>
+ <td>
+ 19
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.title</code>
+ </td>
+ <td>
+ 20
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.startDate</code>
+ </td>
+ <td>
+ 21
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.endDate</code>
+ </td>
+ <td>
+ 22
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.location</code>
+ </td>
+ <td>
+ 23
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.description</code>
+ </td>
+ <td>
+ 24
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.domain</code>
+ </td>
+ <td>
+ 25
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.userid</code>
+ </td>
+ <td>
+ 26
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.username</code>
+ </td>
+ <td>
+ 27
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.value</code>
+ </td>
+ <td>
+ 28
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.value</code>
+ </td>
+ <td>
+ 29
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.value</code>
+ </td>
+ <td>
+ 30
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>gender</code>
+ </td>
+ <td>
+ 31
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>birthday</code>
+ </td>
+ <td>
+ 32
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>anniversary</code>
+ </td>
+ <td>
+ 33
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>published</code>
+ </td>
+ <td>
+ 34
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>updated</code>
+ </td>
+ <td>
+ 35
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>utcOffset</code>
+ </td>
+ <td>
+ 36
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>notes</code>
+ </td>
+ <td>
+ 37
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.honorificPrefix</code>
+ </td>
+ <td>
+ 38
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.honorificSuffix</code>
+ </td>
+ <td>
+ 39
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.type</code>
+ </td>
+ <td>
+ 40
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.type</code>
+ </td>
+ <td>
+ 41
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.type</code>
+ </td>
+ <td>
+ 42
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.type</code>
+ </td>
+ <td>
+ 43
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.type</code>
+ </td>
+ <td>
+ 44
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.type</code>
+ </td>
+ <td>
+ 45
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.type</code>
+ </td>
+ <td>
+ 46
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.type</code>
+ </td>
+ <td>
+ 47
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>connected</code>
+ </td>
+ <td>
+ 48
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>id</code>
+ </td>
+ <td>
+ 49
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ <br>
+ </div>
+ <div class="appendix section" id="references"><!--OddPage--><h2><span class="secno">C. </span>References</h2><div class="section" id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-CORE-DEVICE">[CORE-DEVICE]</dt><dd>Robin Berjon. <a href="http://dev.w3.org/2009/dap/device/"><cite>Core Device Interfaces.</cite></a> 02 December 2009. W3C Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/device/">http://dev.w3.org/2009/dap/device/</a>
+</dd><dt id="bib-POCO-SCHEMA">[POCO-SCHEMA]</dt><dd>Joseph Smarr. <a href="http://portablecontacts.net/draft-spec.html#schema"><cite>Portable Contacts 1.0 Draft C: Contact Schema</cite></a> 5 August 2008. URL: <a href="http://portablecontacts.net/draft-spec.html#schema">http://portablecontacts.net/draft-spec.html#schema</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-UNICODE">[UNICODE]</dt><dd>The Unicode Consortium. <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html"><cite>The Unicode Standard.</cite></a> 2003. Defined by: The Unicode Standard, Version 4.0 (Boston, MA, Addison-Wesley, ISBN 0-321-18578-1), as updated from time to time by the publication of new versions URL: <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html">http://www.unicode.org/unicode/standard/versions/enumeratedversions.html</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219"><cite>Web IDL.</cite></a> 19 December 2008. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219">http://www.w3.org/TR/2008/WD-WebIDL-20081219</a>
+</dd></dl></div><div class="section" id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><dl class="bibliography"><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2010/WD-html5-20100304/"><cite>HTML 5.</cite></a> 4 March 2010. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2010/WD-html5-20100304/">http://www.w3.org/TR/2010/WD-html5-20100304/</a>
+</dd></dl></div></div></body></html>
\ No newline at end of file
Binary file contacts/WD1/contacts_notification.png has changed
Binary file contacts/WD1/contacts_picker.png has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD2/CVS/Entries Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,4 @@
+/Overview.html/1.1/Mon Aug 16 08:09:27 2010//
+/contacts_notification.png/1.1/Mon Aug 16 08:07:31 2010//
+/contacts_picker.png/1.1/Mon Aug 16 08:07:31 2010//
+D
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD2/CVS/Repository Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+2009/dap/contacts/WD2
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD2/CVS/Root Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+rberjon2@dev.w3.org:/sources/public
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD2/Overview.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,2152 @@
+<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
+<html lang="en" dir="ltr">
+<head>
+
+
+ <title>
+ Contacts API
+ </title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+
+
+
+
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec CSS
+ * Robin Berjon (robin at berjon dot com)
+ * v0.05 - 2009-07-31
+ *****************************************************************/
+
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: medium solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: medium dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- WEB IDL --- */
+pre.idl {
+ border-top: 1px solid #90b8de;
+ border-bottom: 1px solid #90b8de;
+ padding: 1em;
+ line-height: 120%;
+}
+
+pre.idl::before {
+ content: "WebIDL";
+ display: block;
+ width: 150px;
+ background: #90b8de;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+.idlType {
+ color: #ff4500;
+ font-weight: bold;
+ text-decoration: none;
+}
+
+/*.idlModule*/
+/*.idlModuleID*/
+/*.idlInterface*/
+.idlInterfaceID {
+ font-weight: bold;
+ color: #005a9c;
+}
+
+.idlSuperclass {
+ font-style: italic;
+ color: #005a9c;
+}
+
+/*.idlAttribute*/
+.idlAttrType, .idlFieldType {
+ color: #005a9c;
+}
+.idlAttrName, .idlFieldName {
+ color: #ff4500;
+}
+.idlAttrName a, .idlFieldName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlMethod*/
+.idlMethType {
+ color: #005a9c;
+}
+.idlMethName {
+ color: #ff4500;
+}
+.idlMethName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlParam*/
+.idlParamType {
+ color: #005a9c;
+}
+.idlParamName {
+ font-style: italic;
+}
+
+.extAttr {
+ color: #666;
+}
+
+/*.idlConst*/
+.idlConstType {
+ color: #005a9c;
+}
+.idlConstName {
+ color: #ff4500;
+}
+.idlConstName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlException*/
+.idlExceptionID {
+ font-weight: bold;
+ color: #c00;
+}
+
+.idlTypedefID, .idlTypedefType {
+ color: #005a9c;
+}
+
+.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
+ color: #c00;
+ font-weight: normal;
+}
+
+.excName a {
+ font-family: monospace;
+}
+
+.idlRaises a.idlType, .excName a.idlType {
+ border-bottom: 1px dotted #c00;
+}
+
+.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
+ width: 45px;
+ text-align: center;
+}
+.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
+.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
+
+.idlImplements a {
+ font-weight: bold;
+}
+
+dl.attributes, dl.methods, dl.constants, dl.fields {
+ margin-left: 2em;
+}
+
+.attributes dt, .methods dt, .constants dt, .fields dt {
+ font-weight: normal;
+}
+
+.attributes dt code, .methods dt code, .constants dt code, .fields dt code {
+ font-weight: bold;
+ color: #000;
+ font-family: monospace;
+}
+
+.attributes dt code, .fields dt code {
+ background: #ffffd2;
+}
+
+.attributes dt .idlAttrType code, .fields dt .idlFieldType code {
+ color: #005a9c;
+ background: transparent;
+ font-family: inherit;
+ font-weight: normal;
+ font-style: italic;
+}
+
+.methods dt code {
+ background: #d9e6f8;
+}
+
+.constants dt code {
+ background: #ddffd2;
+}
+
+.attributes dd, .methods dd, .constants dd, .fields dd {
+ margin-bottom: 1em;
+}
+
+table.parameters, table.exceptions {
+ border-spacing: 0;
+ border-collapse: collapse;
+ margin: 0.5em 0;
+ width: 100%;
+}
+table.parameters { border-bottom: 1px solid #90b8de; }
+table.exceptions { border-bottom: 1px solid #deb890; }
+
+.parameters th, .exceptions th {
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+ font-family: initial;
+ font-weight: normal;
+ text-shadow: #666 1px 1px 0;
+}
+.parameters th { background: #90b8de; }
+.exceptions th { background: #deb890; }
+
+.parameters td, .exceptions td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+ vertical-align: top;
+}
+
+.parameters tr:first-child td, .exceptions tr:first-child td {
+ border-top: none;
+}
+
+.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
+ width: 100px;
+}
+
+.parameters td.prmType {
+ width: 120px;
+}
+
+table.exceptions table {
+ border-spacing: 0;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+/* --- TOC --- */
+.toc a {
+ text-decoration: none;
+}
+
+a .secno {
+ color: #000;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+
+/* --- EXAMPLES --- */
+pre.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ padding: 1em;
+ margin-top: 1em;
+}
+
+pre.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* --- EDITORIAL NOTES --- */
+.issue {
+ padding: 1em;
+ border: 1px solid #f00;
+ background: #ffc;
+}
+
+.issue::before {
+ content: "Issue";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #f00;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+.note {
+ padding: 1em;
+ border: 2px solid #cff6d9;
+ background: #e2fff0;
+}
+
+.note::before {
+ content: "Note";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #cff6d9;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+/* --- SYNTAX HIGHLIGHTING --- */
+pre.sh_sourceCode {
+ background-color: white;
+ color: black;
+ font-style: normal;
+ font-weight: normal;
+}
+
+pre.sh_sourceCode .sh_keyword { color: #005a9c; font-weight: bold; } /* language keywords */
+pre.sh_sourceCode .sh_type { color: #666; } /* basic types */
+pre.sh_sourceCode .sh_usertype { color: teal; } /* user defined types */
+pre.sh_sourceCode .sh_string { color: red; font-family: monospace; } /* strings and chars */
+pre.sh_sourceCode .sh_regexp { color: orange; font-family: monospace; } /* regular expressions */
+pre.sh_sourceCode .sh_specialchar { color: #ffc0cb; font-family: monospace; } /* e.g., \n, \t, \\ */
+pre.sh_sourceCode .sh_comment { color: #A52A2A; font-style: italic; } /* comments */
+pre.sh_sourceCode .sh_number { color: purple; } /* literal numbers */
+pre.sh_sourceCode .sh_preproc { color: #00008B; font-weight: bold; } /* e.g., #include, import */
+pre.sh_sourceCode .sh_symbol { color: blue; } /* e.g., *, + */
+pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */
+pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */
+pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: #00FFFF; } /* TODO and FIXME */
+
+/* Predefined variables and functions (for instance glsl) */
+pre.sh_sourceCode .sh_predef_var { color: #00008B; }
+pre.sh_sourceCode .sh_predef_func { color: #00008B; font-weight: bold; }
+
+/* for OOP */
+pre.sh_sourceCode .sh_classname { color: teal; }
+
+/* line numbers (not yet implemented) */
+pre.sh_sourceCode .sh_linenum { display: none; }
+
+/* Internet related */
+pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; }
+
+/* for ChangeLog and Log files */
+pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; }
+pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: #00008B; font-weight: bold; }
+pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: #006400; }
+
+/* for Prolog, Perl... */
+pre.sh_sourceCode .sh_variable { color: #006400; }
+
+/* for LaTeX */
+pre.sh_sourceCode .sh_italics { color: #006400; font-style: italic; }
+pre.sh_sourceCode .sh_bold { color: #006400; font-weight: bold; }
+pre.sh_sourceCode .sh_underline { color: #006400; text-decoration: underline; }
+pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; }
+pre.sh_sourceCode .sh_argument { color: #006400; }
+pre.sh_sourceCode .sh_optionalargument { color: purple; }
+pre.sh_sourceCode .sh_math { color: orange; }
+pre.sh_sourceCode .sh_bibtex { color: blue; }
+
+/* for diffs */
+pre.sh_sourceCode .sh_oldfile { color: orange; }
+pre.sh_sourceCode .sh_newfile { color: #006400; }
+pre.sh_sourceCode .sh_difflines { color: blue; }
+
+/* for css */
+pre.sh_sourceCode .sh_selector { color: purple; }
+pre.sh_sourceCode .sh_property { color: blue; }
+pre.sh_sourceCode .sh_value { color: #006400; font-style: italic; }
+
+/* other */
+pre.sh_sourceCode .sh_section { color: black; font-weight: bold; }
+pre.sh_sourceCode .sh_paren { color: red; }
+pre.sh_sourceCode .sh_attribute { color: #006400; }
+
+</style><link charset="utf-8" type="text/css" rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"></head><body style="display: inherit;"><div class="head"><p><a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a></p><h1 class="title" id="title">Contacts API</h1><h2 id="w3c-working-draft-17-august-2010">W3C Working Draft 17 August 2010</h2><dl><dt>This version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100817/">http://www.w3.org/TR/2010/WD-contacts-api-20100817/</a></dd><dt>Latest published version:</dt><dd><a href="http://www.w3.org/TR/contacts-api/">http://www.w3.org/TR/contacts-api/</a></dd><dt>Latest editor's draft:</dt><dd><a href="http://dev.w3.org/2009/dap/contacts/">http://dev.w3.org/2009/dap/contacts/</a></dd><dt>Previous version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100701/">http://www.w3.org/TR/2010/WD-contacts-api-20100701/</a></dd><dt>Editor:</dt><dd><span>Richard Tibbett</span>, Opera Software ASA</dd>
+</dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2010 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p><hr></div>
+ <div class="introductory section" id="abstract"><h2>Abstract</h2>
+ <p>
+ The Contacts API defines the high-level interfaces required to provide read access to a user's unified address book.
+ </p>
+ <p>
+ Methods to manipulate a user's unified address book, to add and remove contact information, are being developed in an
+ accompanying specification [<cite><a href="#bib-CONTACTS-WRITER-API" rel="biblioentry" class="bibref">CONTACTS-WRITER-API</a></cite>].
+ </p>
+ </div><div id="sotd" class="introductory section"><h2>Status of This Document</h2><p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed Contacts API. Issues and
+ editors note in the document highlight some of the points on which the group is still working and would particularly like to get
+ feedback.
+ </p>
+ <p>This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). All feedback is welcome.</p><p>Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p><p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 W3C Patent Policy</a>. W3C maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>.</p></div><div class="section" id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a class="tocxref" href="#conformance"><span class="secno">1. </span>Conformance</a></li><li class="tocline"><a class="tocxref" href="#introduction"><span class="secno">2. </span>
+ Introduction
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#usage-examples"><span class="secno">2.1 </span>
+ Usage Examples
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#security-and-privacy-considerations"><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-implementors-of-the-contacts-api"><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </a></li><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-recipients-of-contact-information"><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </a></li><li class="tocline"><a class="tocxref" href="#additional-implementation-considerations"><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#api-description"><span class="secno">4. </span>
+ API Description
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#servicecontacts-interface"><span class="secno">4.1 </span>
+ <span class="idlType formerLink idlType"><code>ServiceContacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes"><span class="secno">4.1.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacts-interface"><span class="secno">4.2 </span>
+ <span class="idlType formerLink idlType"><code>Contacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods"><span class="secno">4.2.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-interface"><span class="secno">4.3 </span>
+ <span class="idlType formerLink idlType"><code>Contact</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-1"><span class="secno">4.3.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactname-interface"><span class="secno">4.4 </span>
+ <span class="idlType formerLink idlType"><code>ContactName</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-2"><span class="secno">4.4.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfield-interface"><span class="secno">4.5 </span>
+ <span class="idlType formerLink idlType"><code>ContactField</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-3"><span class="secno">4.5.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaddress-interface"><span class="secno">4.6 </span>
+ <span class="idlType formerLink idlType"><code>ContactAddress</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-4"><span class="secno">4.6.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactorganization-interface"><span class="secno">4.7 </span>
+ <span class="idlType formerLink idlType"><code>ContactOrganization</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-5"><span class="secno">4.7.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaccount-interface"><span class="secno">4.8 </span>
+ <span class="idlType formerLink idlType"><code>ContactAccount</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-6"><span class="secno">4.8.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindoptions-interface"><span class="secno">4.9 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindOptions</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-7"><span class="secno">4.9.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindsuccesscb-interface"><span class="secno">4.10 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindSuccessCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-1"><span class="secno">4.10.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterrorcb-interface"><span class="secno">4.11 </span>
+ <span class="idlType formerLink idlType"><code>ContactErrorCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-2"><span class="secno">4.11.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterror-interface"><span class="secno">4.12 </span>
+ <span class="idlType formerLink idlType"><code>ContactError</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-8"><span class="secno">4.12.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#constants"><span class="secno">4.12.2 </span>Constants</a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-search-processing"><span class="secno">5. </span>
+ <span class="formerLink">Contact Search Processing</span>
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-qualifiers"><span class="secno">5.1 </span>
+ Search Qualifiers
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#complex-search-qualifiers"><span class="secno">5.1.1 </span>
+ Complex Search Qualifiers
+ </a></li><li class="tocline"><a class="tocxref" href="#search-qualifier-example"><span class="secno">5.1.2 </span>
+ Search Qualifier Example
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#options-processing"><span class="secno">5.2 </span>
+ Options Processing
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-cardinality"><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </a></li><li class="tocline"><a class="tocxref" href="#search-sorting"><span class="secno">5.2.2 </span>
+ Search Sorting
+ </a></li><li class="tocline"><a class="tocxref" href="#search-filters"><span class="secno">5.2.3 </span>
+ Search Filters
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-filter-example"><span class="secno">5.2.3.1 </span>
+ Search Filter Example
+ </a></li></ul></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#user-interaction-guidelines"><span class="secno">A. </span>
+ User Interaction Guidelines
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#sharing-contact-information"><span class="secno">A.1 </span>
+ Sharing Contact Information
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#search-weights"><span class="secno">B. </span>
+ Search Weights
+ </a></li><li class="tocline"><a class="tocxref" href="#references"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li class="tocline"><a class="tocxref" href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></div>
+
+ <div class="section" id="conformance"><!--OddPage--><h2><span class="secno">1. </span>Conformance</h2><p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
+<p>The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>, and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<cite><a href="#bib-RFC2119" rel="biblioentry" class="bibref">RFC2119</a></cite>].</p>
+
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn id="dfn-user-agent">user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>], as this specification uses that specification and
+ terminology.
+ </p>
+ </div>
+ <div id="introduction" class="informative section">
+ <!--OddPage--><h2><span class="secno">2. </span>
+ Introduction
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of representing address book
+ information. Most users are required to maintain a plurality of contact lists which leads to multiple copies of address book data.
+ The multiplicity of address books that a user is required to maintain often leads to disjointed and inconsistent information being
+ stored across a user's address book providers.
+ </p>
+ <p>
+ Providing address book information to these service providers means handing over all of your data and trusting these providers with
+ the security and privacy of storing and sharing of your information. When sharing this data with 3rd parties users are, more often
+ than not, required to hand over access to their whole address book. Users are implicitly required to trust 3rd parties with all of
+ their data when, in reality, the user may only wish, or need, to share a subset of their address book information so that an
+ application can fulfill its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may be sourced from a
+ plurality of sources - both online and locally. This specification then defines the interfaces on which 3rd party applications can
+ access a user's unified address book; with explicit user permission and filtering. The focus of this data sharing is on making
+ the user aware of the data that they will share and putting them at the centre of the data sharing process; free to select both the
+ extent to which they share their address book information and the ability to restrict which pieces of information related to which
+ contact gets shared.
+ </p>
+ <p>
+ The API itself is agnostic of any underlying address book sources and storage. A conforming implementation is required to implement
+ all fields defined in this specification.
+ </p>
+ <div class="section" id="usage-examples">
+ <h3><span class="secno">2.1 </span>
+ Usage Examples
+ </h3>
+ <p>
+ The following code illustrates how to obtain contact information from a user's address book:
+ </p>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>displayName<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span></pre>
+ </div>
+ </div>
+ <div class="section" id="security-and-privacy-considerations">
+ <!--OddPage--><h2><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </h2>
+ <p class="note">
+ The overall architecture for addressing privacy in DAP is still under construction. As it is finalized, there may be changes made
+ to this API to reflect requirements or support for privacy-related functionality.
+ </p>
+ <p>
+ The API defined in this specification can be used to create, find, save and remove contact information from a user's address
+ book(s). All API methods disclose information related to a user's contacts such as their phone number(s), email address(es) and
+ other personally identifying information. The distribution of this information could potentially compromise the user's privacy.
+ A conforming implementation of this specification <em title="must" class="rfc2119">must</em> provide a mechanism that protects the user's privacy and this mechanism
+ should ensure that no contact information is creatable, retrivable, updateable or removable without the user's express
+ permission.
+ </p>
+ <div class="section" id="privacy-considerations-for-implementors-of-the-contacts-api">
+ <h3><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </h3>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must not create, find, save or delete contact information to Web sites without the express permission of the
+ user. A <a class="internalDFN" href="#dfn-user-agent">user agent</a> must acquire permission through a user interface, unless they have prearranged trust relationships with
+ users, as described below. The user interface must include the URI of the document origin, as defined in [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>]. Those
+ permissions that are acquired through the user interface and that are preserved beyond the current browsing session (i.e. beyond
+ the time when the browsing context, as defined in [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>], is navigated to another URL) <em title="must" class="rfc2119">must</em> be revocable and a <a class="internalDFN" href="#dfn-user-agent">user
+ agent</a> must respect revoked permissions.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted permission for the same
+ Web site to access other methods provided by this API, or to access the same method with a different set of arguments, as part of
+ the same permission context. If a user has expressed permission for an implementation to, e.g. find a set of existing contacts,
+ the implementation must seek the user's express permission if and when any additional create, find, save or remove function
+ is called on this API.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> may have prearranged trust relationships that do not require such user interfaces. For example, while a Web
+ browser will present a user interface when a Web site performs an address book request, a Widget Runtime <em title="may" class="rfc2119">may</em> have a prearranged,
+ delegated security relationship with the user and, as such, a suitable alternative security and privacy mechanism with which to
+ authorize the creation, retrieval, update and/or removal of contact information.
+ </p>
+ </div>
+ <div class="section" id="privacy-considerations-for-recipients-of-contact-information">
+ <h3><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </h3>
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> only request contact information when necessary. Recipients <em title="must" class="rfc2119">must</em> only use the contact information for the task
+ for which it was provided to them. Recipients <em title="must" class="rfc2119">must</em> dispose of contact information once that task is completed, unless expressly
+ permitted to retain it by the user. Recipients <em title="must" class="rfc2119">must</em> also take measures to protect this information against unauthorized access.
+ If contact information is stored, users should be allowed to update and delete this information.
+ </p>
+ <p>
+ The recipient of contact information <em title="must" class="rfc2119">must</em> not retransmit the contact information without the user's express permission. Care
+ should be taken when retransmitting and use of encryption is encouraged.
+ </p>
+ <p>
+ Recipients <em title="must" class="rfc2119">must</em> clearly and conspicuously disclose the fact that they are collecting contact data, the purpose for the
+ collection, how long the data is retained, how the data is secured, how the data is shared if it is shared, how users can access,
+ update and delete the data, and any other choices that users have with respect to the data. This disclosure <em title="must" class="rfc2119">must</em> include an
+ explanation of any exceptions to the guidelines listed above.
+ </p>
+ </div>
+ <div id="additional-implementation-considerations" class="informative section">
+ <h3><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are also advised to consider the
+ following aspects that can negatively affect the privacy of their users: in certain cases, users can inadvertently grant
+ permission to the User Agent to disclose their contacts to Web sites. In other cases, the content hosted at a certain URL changes
+ in such a way that the previously granted contact permissions no longer apply as far as the user is concerned. Or the users might
+ simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive measures are an
+ implementation responsibility and not prescribed by this specification. However, in designing these measures, implementers are
+ advised to enable user awareness of contact sharing, and to provide easy access to interfaces that enable revocation of
+ permissions.
+ </p>
+ </div>
+ </div>
+ <div class="section" id="api-description">
+ <!--OddPage--><h2><span class="secno">4. </span>
+ API Description
+ </h2>
+ <div class="section" id="servicecontacts-interface">
+ <h3><span class="secno">4.1 </span>
+ <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface
+ </h3>
+ <p>
+ The <a href="#servicecontacts-interface"><code>ServiceContacts</code></a> interface is exposed on the <code>navigator.service</code>
+ object, as defined in [<cite><a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a></cite>].
+ </p>
+ <pre class="idl"><span class="idlImplements"><a>Service</a> implements <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a>;</span></pre><div class="idlImplementsDesc">
+
+ </div>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ServiceContacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ServiceContacts</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span> <span class="idlAttrName"><a href="#widl-ServiceContacts-contacts">contacts</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes"><h4><span class="secno">4.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ServiceContacts-contacts"><code>contacts</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span>, readonly</dt><dd>
+ The root node from which the contacts functionality can be accessed.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacts-interface">
+ <h3><span class="secno">4.2 </span>
+ <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface
+ </h3>
+ <p>
+ The <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface exposes a database collecting contacts information, such that they may be created, found, read,
+ updated, and deleted.
+ </p>
+ <p>
+ Multiple contact groups can be represented within this unified address book by specifying consistent <a href="#widl-Contact-tags"><code>tags</code></a> value(s) as part of individual <a href="#contact-interface"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering on the
+ required <a href="#widl-Contact-tags"><code>tags</code></a> value(s) via the <code>Contacts</code> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contacts</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contacts-find">find</a></span> (<span class="idlParam">in <span class="idlParamType"><a>DOMString</a>[]</span> <span class="idlParamName">fields</span></span>, <span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a>?</span> <span class="idlParamName">options</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods"><h4><span class="secno">4.2.1 </span>Methods</h4><dl class="methods"><dt id="widl-Contacts-find"><code>find</code></dt><dd>
+ <p>
+ Find contacts in the address book according to the <a class="internalDFN" href="#dfn-find-contacts-process">find contacts process</a> detailed below.
+ </p>
+ <p>
+ This method takes two, three or four arguments. When called, it immediately returns a <code>PendingOp</code> object , as
+ defined in [<cite><a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a></cite>], and then asynchronously starts a <dfn id="dfn-find-contacts-process">find contacts process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, invoke the <code>errorCB</code> with a <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ Search for contacts in the address book according to the rules defined in <a href="#contact-search-processing">Contact Search Processing</a>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a href="#contacterror-interface"><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">fields</td><td class="prmType"><code><a>DOMString</a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </td></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr><tr><td class="prmName">options</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ The options to apply to the output of this method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>PendingOp</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contact-interface">
+ <h3><span class="secno">4.3 </span>
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface
+ </h3>
+ <p class="note">
+ The use of Portable Contacts schema as the format for contacts is subject to further discussions in the group.
+ </p>
+ <p>
+ The <a href="#contact-interface"><code>Contact</code></a> interface captures the properties of a contact object. All properties
+ included in this interface have a corresponding definition in [<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>].
+ </p>
+ <p>
+ In addition to the properties defined in this interface, a conforming implementation <em title="must" class="rfc2119">must</em> support both the Singular and Plural
+ OpenSocial fields defined in [<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>].
+ </p>
+ <p class="note">
+ The inclusion of OpenSocial fields in the paragraph above needs further explanation, particularly in relation to contact database
+ searching and sorting.
+ </p>
+ <p>
+ All <a href="#contact-interface"><code>Contact</code></a> objects <em title="must" class="rfc2119">must</em> include all attributes supported by the implementation,
+ regardless of whether these attributes have been assigned a non-<code>null</code> value or a <code>null</code> value.
+ </p>
+ <p>
+ If a supported attribute has not been assigned a value by the user and/or implementation, then this attribute <em title="must" class="rfc2119">must</em> still be
+ present in the resulting <a href="#contact-interface"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contact">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contact</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-id">id</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-displayName">displayName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span> <span class="idlAttrName"><a href="#widl-Contact-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-nickname">nickname</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-phoneNumbers">phoneNumbers</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-emails">emails</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-addresses">addresses</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-ims">ims</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-organizations">organizations</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-published">published</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-updated">updated</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-birthday">birthday</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-anniversary">anniversary</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-gender">gender</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-note">note</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-preferredUsername">preferredUsername</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-photos">photos</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-tags">tags</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-relationships">relationships</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-urls">urls</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-accounts">accounts</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-utcOffset">utcOffset</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-connected">connected</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-1"><h4><span class="secno">4.3.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-Contact-accounts"><code>accounts</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>accounts</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-addresses"><code>addresses</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>addresses</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-anniversary"><code>anniversary</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>anniversary</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-birthday"><code>birthday</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>birthday</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-connected"><code>connected</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p class="note">
+ Ignore this [<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] attribute?
+ </p>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>connected</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-displayName"><code>displayName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>displayName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-emails"><code>emails</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>emails</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-gender"><code>gender</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>gender</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-id"><code>id</code> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly</dt><dd>
+ <p>
+ A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> referenced from
+ <code>Contacts</code> <em title="must" class="rfc2119">must</em> include a non-empty <code>id</code> value.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> maintain this globally unique resource identifier when a Contact is added to, or present within, an
+ Address Book.
+ </p>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>id</code>] for additional definition of this attribute.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-ims"><code>ims</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>ims</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-name"><code>name</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>name</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-nickname"><code>nickname</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>nickname</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-note"><code>note</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>note</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-organizations"><code>organizations</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>organizations</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-phoneNumbers"><code>phoneNumbers</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>phoneNumbers</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-photos"><code>photos</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>photos</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-preferredUsername"><code>preferredUsername</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>preferredUsername</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-published"><code>published</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>published</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-relationships"><code>relationships</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>relationships</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-tags"><code>tags</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>tags</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-updated"><code>updated</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>updated</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-urls"><code>urls</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>urls</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-utcOffset"><code>utcOffset</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.1. <code>utcOffset</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactname-interface">
+ <h3><span class="secno">4.4 </span>
+ <a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactname-interface"><code>ContactName</code></a> interface describes a contact's name.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactName">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactName</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-familyName">familyName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-givenName">givenName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-middleName">middleName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificPrefix">honorificPrefix</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificSuffix">honorificSuffix</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-2"><h4><span class="secno">4.4.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactName-familyName"><code>familyName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>familyName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>formatted</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-givenName"><code>givenName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>givenName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificPrefix"><code>honorificPrefix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>honorificPrefix</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificSuffix"><code>honorificSuffix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>honorificSuffix</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-middleName"><code>middleName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.3. <code>middleName</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfield-interface">
+ <h3><span class="secno">4.5 </span>
+ <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface
+ </h3>
+ <p>
+ The ContactField interface is a reusable component that is used to support contact fields within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactField">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactField</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-value">value</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactField-primary">primary</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-3"><h4><span class="secno">4.5.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactField-primary"><code>primary</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.2.2. <code>primary</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.2.2. <code>type</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-value"><code>value</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.2.2. <code>value</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactaddress-interface">
+ <h3><span class="secno">4.6 </span>
+ <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface
+ </h3>
+ <p>
+ The ContactAddress interface is a reusable component that is used to support contact addresses within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAddress">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAddress</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-streetAddress">streetAddress</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-locality">locality</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-region">region</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-postalCode">postalCode</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-country">country</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-4"><h4><span class="secno">4.6.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAddress-country"><code>country</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>country</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>formatted</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-locality"><code>locality</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>locality</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-postalCode"><code>postalCode</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>postalCode</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-region"><code>region</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>region</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-streetAddress"><code>streetAddress</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.4. <code>streetAddress</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactorganization-interface">
+ <h3><span class="secno">4.7 </span>
+ <a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a> interface
+ </h3>
+ <p>
+ The ContactOrganization interface is a reusable component that is used to support contact organizations within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactOrganization">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactOrganization</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-department">department</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-title">title</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-startDate">startDate</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-endDate">endDate</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-location">location</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-description">description</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-5"><h4><span class="secno">4.7.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactOrganization-department"><code>department</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>department</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-description"><code>description</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>description</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-endDate"><code>endDate</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>endDate</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-location"><code>location</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>location</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-name"><code>name</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>name</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-startDate"><code>startDate</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>startDate</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-title"><code>title</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.5. <code>title</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactaccount-interface">
+ <h3><span class="secno">4.8 </span>
+ <a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a> interface
+ </h3>
+ <p>
+ The ContactAccount interface is a reusable component that is used to support contact accounts within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAccount">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAccount</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-domain">domain</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-username">username</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-userid">userid</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-6"><h4><span class="secno">4.8.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAccount-domain"><code>domain</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.6. <code>domain</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-userid"><code>userid</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.6. <code>userid</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-username"><code>username</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>]] Section 7.6. <code>username</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindoptions-interface">
+ <h3><span class="secno">4.9 </span>
+ <a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> interface describes the options that can be applied to
+ contact searching. When a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation, it should be processed according to the provisions detailed in <a href="#options-processing">Options Processing</a>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindOptions">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindOptions</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>String</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-filter">filter</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-multiple">multiple</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>unsigned short</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-limit">limit</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-updatedSince">updatedSince</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-7"><h4><span class="secno">4.9.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactFindOptions-filter"><code>filter</code> of type <span class="idlAttrType"><a>String</a></span>, nullable</dt><dd>
+ A DOMString-based <a class="internalDFN" href="#dfn-search-filter">search filter</a> with which to search and intially filter the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-limit"><code>limit</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, nullable</dt><dd>
+ <p>
+ The maximum number of results to return from the contacts search.
+ </p>
+ <p>
+ This parameter only applies in the case that the associated <code>multiple</code> attribute is equal to <code>true</code>.
+ </p>
+ <p>
+ If no value is provided, the search will return all <a href="#contact-interface"><code>Contact</code></a> object results.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-multiple"><code>multiple</code> of type <span class="idlAttrType"><a>boolean</a></span>, nullable</dt><dd>
+ A boolean value to indicate whether multiple Contact objects are returnable as part of the associated <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-updatedSince"><code>updatedSince</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ Return only contact records that have been updated on or after the given time, specified as an xs:dateTime.
+ </p>
+ <p>
+ This filter is based on the <a href="#widl-Contact-updated"><code>updated</code></a> field as defined in <a href="#contact-interface"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindsuccesscb-interface">
+ <h3><span class="secno">4.10 </span>
+ <a class="idlType" href="#idl-def-ContactFindSuccessCB"><code>ContactFindSuccessCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindSuccessCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindSuccessCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactFindSuccessCB-onSuccess">onSuccess</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</span> <span class="idlParamName">contactObjs</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-1"><h4><span class="secno">4.10.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactFindSuccessCB-onSuccess"><code>onSuccess</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObjs</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact objects resulting from the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method. <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a>
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacterrorcb-interface">
+ <h3><span class="secno">4.11 </span>
+ <a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactErrorCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactErrorCB</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactErrorCB-onError">onError</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></span> <span class="idlParamName">error</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-2"><h4><span class="secno">4.11.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactErrorCB-onError"><code>onError</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">error</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact API related error object.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacterror-interface">
+ <h3><span class="secno">4.12 </span>
+ <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contacterror-interface"><code>ContactError</code></a> interface encapsulates all errors in the manipulation of <a href="#contact-interface"><code>Contact</code></a> objects in the Contacts API.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactError</span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-UNKNOWN_ERROR">UNKNOWN_ERROR</a></span> = <span class="idlConstValue">0</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-INVALID_ARGUMENT_ERROR">INVALID_ARGUMENT_ERROR</a></span> = <span class="idlConstValue">1</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_FOUND_ERROR">NOT_FOUND_ERROR</a></span> = <span class="idlConstValue">2</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-TIMEOUT_ERROR">TIMEOUT_ERROR</a></span> = <span class="idlConstValue">3</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PENDING_OPERATION_ERROR">PENDING_OPERATION_ERROR</a></span> = <span class="idlConstValue">4</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-IO_ERROR">IO_ERROR</a></span> = <span class="idlConstValue">5</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_SUPPORTED_ERROR">NOT_SUPPORTED_ERROR</a></span> = <span class="idlConstValue">6</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PERMISSION_DENIED_ERROR">PERMISSION_DENIED_ERROR</a></span> = <span class="idlConstValue">20</span>;</span>
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactError-code">code</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-8"><h4><span class="secno">4.12.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactError-code"><code>code</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, readonly</dt><dd>
+ An error code assigned by an implementation when an error has occurred in Contacts API processing.
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="constants"><h4><span class="secno">4.12.2 </span>Constants</h4><dl class="constants"><dt id="widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An invalid parameter was provided when the requested method was invoked.
+ </dd><dt id="widl-ContactError-IO_ERROR"><code>IO_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An error occurred in communication with the underlying implementation that meant the requested method could not complete.
+ </dd><dt id="widl-ContactError-NOT_FOUND_ERROR"><code>NOT_FOUND_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If no response information can be provided from the requested method.
+ </dd><dt id="widl-ContactError-NOT_SUPPORTED_ERROR"><code>NOT_SUPPORTED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method is not supported by the current implementation.
+ </dd><dt id="widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If the <a class="internalDFN" href="#dfn-user-agent">user agent</a> is currently waiting for a callback on a current find(), save() or remove() operation, as defined in
+ this specification.
+ </dd><dt id="widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ Access to the requested method was denied at the implementation or by the user.
+ </dd><dt id="widl-ContactError-TIMEOUT_ERROR"><code>TIMEOUT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method timed out before it could be completed.
+ </dd><dt id="widl-ContactError-UNKNOWN_ERROR"><code>UNKNOWN_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An unknown error occurred.
+ </dd></dl></div>
+ </div>
+ </div>
+ <!-- end api description section -->
+ <div class="section" id="contact-search-processing">
+ <!--OddPage--><h2><span class="secno">5. </span>
+ <a>Contact Search Processing</a>
+ </h2>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method provides an operation to search for one of more <a href="#contact-interface"><code>Contact</code></a> objects within the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <div class="section" id="search-qualifiers">
+ <h3><span class="secno">5.1 </span>
+ Search Qualifiers
+ </h3>
+ <p>
+ The <dfn id="dfn-search-qualifier">search qualifier</dfn> provides an application with a way to request the specific subset of <a href="#contact-interface"><code>Contact</code></a> properties it wishes to obtain in any resulting successful callback. The
+ <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is deployed to minimize the data that needs to be shared with an application in order to let that
+ application fulfill its function on behalf of the user. The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is included within a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation as the <code>filter</code> parameter.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> <em title="must" class="rfc2119">must</em> be specified from a requesting application as a part of any <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ If the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must not" class="rfc2119">must not</em> return any <a href="#contact-interface"><code>Contact</code></a> properties within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ In the case that the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>non-zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return only the matching <a href="#contact-interface"><code>Contact</code></a> properties within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ If a provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> element (<code>filter[x]</code>) does not match a <a href="#contact-interface"><code>Contact</code></a> attribute, <code>filter[x]</code> <em title="should" class="rfc2119">should</em> be ignored when executing the
+ current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <div class="section" id="complex-search-qualifiers">
+ <h4><span class="secno">5.1.1 </span>
+ Complex Search Qualifiers
+ </h4>
+ <p>
+ Certain <a href="#contact-interface"><code>Contact</code></a> attributes can be considered complex by the fact that the information they
+ contain is available only through child DOMString-based attributes of a complex Object object.
+ </p>
+ <p>
+ In such cases, a requesting application <em title="must" class="rfc2119">must</em> be able to request both the full complex <a href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts of a complex <a href="#contact-interface"><code>Contact</code></a> attribute in the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ For example, the <code>name</code> attribute of a <a href="#contact-interface"><code>Contact</code></a> object is defined to be of complex type <a href="#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may request either the full
+ complex attribute (i.e. <code>name</code>) or specific individual attributes of this complex attribute (i.e.
+ <code>name.formatted</code>, <code>name.familyName</code>, <code>name.givenName</code>, <code>name.middleName</code>,
+ <code>name.honorificPrefix</code>, <code>name.honorificSuffix</code>) as part of a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation's <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </p>
+ <p>
+ In the case that a complex <a href="#contact-interface"><code>Contact</code></a> attribute is defined as a sequence or array of complex objects, specific
+ individual attributes can be referenced by using the complex attribute name, a dot (<code>.</code>) character and the
+ individual attribute to be retrieved.
+ </p>
+ <p>
+ For example, the <code>addresses</code> attribute of <a href="#contact-interface"><code>Contact</code></a> allows multiple <a href="#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request individual attributes of
+ this complex attribute an application would request e.g. <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ </p>
+ </div>
+ <div class="section" id="search-qualifier-example">
+ <h4><span class="secno">5.1.2 </span>
+ Search Qualifier Example
+ </h4>
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="example sh_javascript sh_sourceCode">navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'emails.value'</span><span class="sh_symbol">,</span> <span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'friends'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>j <span class="sh_keyword">in</span> contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">)</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">[</span>j<span class="sh_symbol">]);</span>
+ <span class="sh_cbracket">}</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span></pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol>
+ <li>
+ Return only the valid <a href="#contact-interface"><code>Contact</code></a> attributes requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>emails.value</code> - <code>friends</code> is not a valid <a href="#contact-interface"><code>Contact</code></a> attribute so ignore this element).
+ </li>
+ </ol>
+ </div>
+ </div>
+ <div class="section" id="options-processing">
+ <h3><span class="secno">5.2 </span>
+ Options Processing
+ </h3>
+ <div class="section" id="search-cardinality">
+ <h4><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </h4>
+ <p>
+ By default, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence or a single <a href="#contact-interface"><code>Contact</code></a> object, accessible as part of the sequence returned in the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> callback function.
+ </p>
+ <p>
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>multiple</code> attribute is set to <code>true</code>, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence, a single <a href="#contact-interface"><code>Contact</code></a> object or <var>[X]</var> number of <a href="#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> callback function.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> specify a suitable integer-based <dfn id="dfn-upper-cardinality-limit">upper cardinality limit</dfn> to limit the maximum number of
+ Contact objects that may be returned in the case that the <code>multiple</code> flag is <code>true</code> and the
+ <code>limit</code> flag is <a class="internalDFN" href="#dfn-out-of-bounds">out of bounds</a>.
+ </p>
+ <p>
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is greater than zero and less than or
+ equal to the implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>, then <var>[X]</var> <em title="must" class="rfc2119">must</em> be set to the provided
+ <code>limit</code> value.
+ </p>
+ <p>
+ The <code>limit</code> attribute is <dfn id="dfn-out-of-bounds">out of bounds</dfn> if a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is less than or equal to zero or greater
+ than the implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>. In this case <var>[X]</var> <em title="must" class="rfc2119">must</em> be set to the
+ implementation's <a class="internalDFN" href="#dfn-upper-cardinality-limit">upper cardinality limit</a>.
+ </p>
+ </div>
+ <div class="section" id="search-sorting">
+ <h4><span class="secno">5.2.2 </span>
+ Search Sorting
+ </h4>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation must return successful callback results according to the sorting guidelines
+ defined in this section.
+ </p>
+ <p>
+ A <dfn id="dfn-search-weight">search weight</dfn> is a numeric value defined for each attribute in a <a href="#contact-interface"><code>Contact</code></a> object. A lower value denotes a higher placing in the ultimate sorting of
+ <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> results. The <dfn id="dfn-search-weights">search weights</dfn> for each <a href="#contact-interface"><code>Contact</code></a> attribute are defined in <a href="#search-weights">Appendix B</a>.
+ </p>
+ <p>
+ For example, if a <a class="internalDFN" href="#dfn-search-filter">search filter</a> of 'Bob' matches to <code>name.givenName</code> in Object A and to
+ <code>displayName</code> in Object B, Object B will be the first result object returned from the successCB of the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation, followed by Object A.
+ </p>
+ <p class="note">
+ Include UNICODE guidelines for intra-attribute sorting of results (where multiple Contact objects match on the same
+ attribute)... [<cite><a href="#bib-UNICODE" rel="biblioentry" class="bibref">UNICODE</a></cite>] DUCET
+ </p>
+ </div>
+ <div class="section" id="search-filters">
+ <h4><span class="secno">5.2.3 </span>
+ Search Filters
+ </h4>
+ <p>
+ A <dfn id="dfn-search-filter">search filter</dfn> <em title="may" class="rfc2119">may</em> be specified from a requesting web application to initially filter the Contacts database to a
+ more specific set of <a href="#contact-interface"><code>Contact</code></a> objects in which it is interested. The <a class="internalDFN" href="#dfn-search-filter">search filter</a> is included as
+ the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-filter">search filter</a> is used to search <a href="#contact-interface"><code>Contact</code></a> attributes within the <a href="#contacts-interface"><code>Contacts</code></a> database and represents the logical union, or <code>∪</code>, of
+ provided values that are matched therein.
+ </p>
+ <p>
+ All contact searching <em title="must" class="rfc2119">must</em> apply a <dfn id="dfn-loose-matching-policy">loose-matching policy</dfn> to the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided. If an attribute being
+ searched in a <a href="#contact-interface"><code>Contact</code></a> object, stored within the <a href="#contacts-interface"><code>Contacts</code></a> database, is a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> of the input
+ <code>filter</code> value, that <a href="#contact-interface"><code>Contact</code></a> object <em title="must" class="rfc2119">must</em> be returned as part of the resulting <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a>.
+ </p>
+ <p>
+ A conforming implementation <em title="must" class="rfc2119">must</em> only allow the provided <a class="internalDFN" href="#dfn-search-filter">search filter</a> to be applied to fields requested in the provided
+ <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>. The <code>id</code> attribute <em title="must" class="rfc2119">must</em> always be implicitly searchable from any requesting web application
+ regardless of whether it has been included as part of any provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>. For example, if the given <a class="internalDFN" href="#dfn-search-qualifier">search
+ qualifier</a> contains 'name' and 'displayName', then the <a class="internalDFN" href="#dfn-rules-for-processing-search-filters">rules for processing search filters</a> should
+ only be applied to all sub-fields of the <code>name</code> attribute (i.e. <code>name.formatted</code>,
+ <code>name.firstName</code>, <code>name.givenName</code>, <code>name.middleName</code>, <code>name.honorificPrefix</code>,
+ <code>name.honorificSuffix</code>) and the <code>displayName</code> attribute.
+ </p>
+ <p>
+ A <dfn id="dfn-partial-value-match">partial value match</dfn> refers to both syntactic and semantic partial matching of an input filter value with a
+ corresponding value in the address book and denotes that a corresponding match was found in the address book that begins with,
+ contains or ends with the value of the input filter value, or any variation thereof.
+ </p>
+ <p>
+ Comparing two strings in a <dfn id="dfn-compatibility-caseless">compatibility caseless</dfn> manner means using the Unicode <em>compatibility caseless
+ match</em> operation to compare the two strings. [<cite><a href="#bib-UNICODE" rel="biblioentry" class="bibref">UNICODE</a></cite>]
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> <em title="must" class="rfc2119">must</em> use the <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner in which to match against corresponding values
+ in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-rules-for-processing-search-filters">rules for processing search filters</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter provided within the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="contactsets">contactsets</var> be initially the set of all known contacts in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <p>
+ Let <var title="contactsresult">contactsresult</var> be initially an empty Object object.
+ </p>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is a DOMString object
+ </dt>
+ <dd>
+ <ol>
+ <li>
+ Let <var title="contactset">contactset</var> be the next enumerable Object in <var title="contactsets">contactsets</var>. If there is no next enumerable Object, go to step 5.
+ </li>
+ <li>
+ Let <var title="partialMatchFound">partialMatchFound</var> be the result of applying the <a class="internalDFN" href="#dfn-partial-matching-algorithm">partial matching algorithm</a>,
+ providing <var title="filter">filter</var> and <var title="contactset">contactset</var> as inputs.
+ </li>
+ <li>
+ If <var title="partialMatchFound">partialMatchFound</var> is <code>true</code>, add <var title="contactset">contactset</var> to <var title="contactsresult">contactsresult</var>.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Sort <var title="contactsresult">contactsresult</var> according to the guidelines in <a href="#search-sorting">Search Sorting</a>.
+ </li>
+ <li>
+ Return <var title="contactsresult">contactsresult</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <var title="contactsets">contactsets</var>.
+ </p>
+ </dd>
+ </dl>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-partial-matching-algorithm">partial matching algorithm</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the input string to compare; and a <var title="contactset">contactset</var> parameter, representing an individual <a href="#contact-interface"><code>Contact</code></a> object:
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be initially set to <code>false</code>.
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is an Object object
+ </dt>
+ <dd>
+ <ol>
+ <li>
+ Let <var title="elementvalue">elementvalue</var> be the String value of the next enumerable property in <var title="contactset">contactset</var>. If there are no more enumerable properties, go to step 5.
+ </li>
+ <li>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be the boolean result for the comparison of <var title="filter">filter</var> with <var title="elementvalue">elementvalue</var> in a <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner and with a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a>
+ policy applied to both sides of the comparison operation.
+ </li>
+ <li>
+ If <var title="hasPartialMatch">hasPartialMatch</var> is <code>true</code>, go to step 5.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Return <var title="hasPartialMatch">hasPartialMatch</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <code>false</code>.
+ </p>
+ </dd>
+ </dl>
+ <p>
+
+ </p>
+ <div class="section" id="search-filter-example">
+ <h5><span class="secno">5.2.3.1 </span>
+ Search Filter Example
+ </h5>
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="example sh_javascript sh_sourceCode">navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.locality'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.country'</span><span class="sh_symbol">,</span> <span class="sh_string">'phoneNumbers'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>x <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>x<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>
+ filter<span class="sh_symbol">:</span> <span class="sh_string">'Robert'</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span></pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol>
+ <li>
+ Using ECMA-262 3rd Edition regular expression syntax and psuedo-code, the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided can be represented
+ as:
+<pre>( name.formatted = /∧.*Robert.*$/i ) ∪ ( phoneNumbers.value = /∧.*Robert.*$/i )
+∪ ( emails.value = /∧.*Robert.*$/i ) ∪ ( name.familyName = /∧.*Robert.*$/i )
+∪ ( name.givenName = /∧.*Robert.*$/i ) ∪ ( name.middleName = /∧.*Robert.*$/i )
+∪ ( addresses.country = /∧.*Robert.*$/i ) ∪ ( addresses.locality = /∧.*Robert.*$/i )
+∪ ( phoneNumbers.type = /∧.*Robert.*$/i ) ∪ ( emails.type = /∧.*Robert.*$/i )
+∪ ( id = /∧.*Robert.*$/i )
+</pre>
+ <br>
+ All searches are case-insensitive and apply a <a class="internalDFN" href="#dfn-loose-matching-policy">loose-matching policy</a> as defined in <a href="#search-filters">Search Filters</a>. Search ordering is sorted according to <a class="internalDFN" href="#dfn-search-weights">search weights</a> defined in <a href="#search-filters">Search Filters</a> and described in <a href="#search-weights">Appendix B</a>.<br>
+ <br>
+ The <code>id</code> attribute is implicitly appended along with any <a class="internalDFN" href="#dfn-search-filter">search filter</a> attributes provided, regardless
+ of whether it was provided as a <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> from the requesting application, as defined in <a href="#search-filters">Search Filters</a>.<br>
+ <br>
+ </li>
+ <li>
+ Return only the valid <a href="#contact-interface"><code>Contact</code></a> properties requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>addresses.locality</code>, <code>addresses.country</code>, <code>phoneNumbers</code>,
+ <code>emails</code>) and only for the <a href="#contact-interface"><code>Contact</code></a> objects returned from the <a class="internalDFN" href="#dfn-rules-for-processing-search-filters">rules for processing search filters</a>
+ with the <a class="internalDFN" href="#dfn-search-filter">search filter</a> derived in step 1 provided as the <var>filter</var> input parameter.
+ </li>
+ </ol>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div id="user-interaction-guidelines" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">A. </span>
+ User Interaction Guidelines
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the contact information that may
+ be shared, saved or removed from their unified address book. This annex provides some examples of a conformant user experience that
+ this specification enables.
+ </p>
+ <div class="section" id="sharing-contact-information">
+ <h3><span class="secno">A.1 </span>
+ Sharing Contact Information
+ </h3>
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+<pre class="example sh_javascript_dom sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span><span class="sh_predef_var">name</span><span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_predef_func">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+<span class="sh_predef_var">navigator</span><span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_predef_func">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span></pre>
+ <p>
+ As a result of executing this code, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a non-blocking <dfn id="dfn-contact-search-notification">contact search notification</dfn> as
+ follows:
+ </p>
+ <p align="center">
+ <img src="contacts_notification.png" alt="Contact Search Notification"><br>
+ (<a href="contacts_notification.png">View as PNG</a>)
+ </p>
+ <p>
+ If an additional find(), save() or remove() operation is called by the current web application before the user has clicked
+ 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that operation was defined with a
+ non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current find() operation, will be
+ invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a <dfn id="dfn-contact-picker">contact picker</dfn>, utilising all of the
+ parameters provided in the find() operation as follows:
+ </p>
+ <p align="center">
+ <img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is requesting and the option to select
+ one or more contacts (as appropriate) from the user interface.
+ </p>
+ <p>
+ If an additional find(), save() or remove() operation is called by the current web application before the user has clicked
+ 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that operation was defined with a
+ non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current find() operation, will be
+ invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> associated to the current find() operation will be
+ invoked with the contact information selected by the user provided as the only parameter.
+ </p>
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the user should easily
+ be able to review and revoke permissions to web applications at a later date.
+ </p>
+ </div>
+ </div>
+ <div id="search-weights" class="appendix section">
+ <!--OddPage--><h2><span class="secno">B. </span>
+ Search Weights
+ </h2>
+ <p>
+ The following table defines the <a class="internalDFN" href="#dfn-search-weight">search weight</a> values for each <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided in this specification.
+ </p>
+ <table class="simple" summary="Search Weights by Search Qualifier">
+ <thead>
+ <tr>
+ <th>
+ <a class="internalDFN" href="#dfn-search-qualifier">Search Qualifier</a>
+ </th>
+ <th>
+ <a class="internalDFN" href="#dfn-search-weight">Search Weight</a>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>displayName</code>
+ </td>
+ <td>
+ 1
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.formatted</code>
+ </td>
+ <td>
+ 2
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>nickname</code>
+ </td>
+ <td>
+ 3
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.value</code>
+ </td>
+ <td>
+ 4
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.value</code>
+ </td>
+ <td>
+ 5
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.formatted</code>
+ </td>
+ <td>
+ 6
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.name</code>
+ </td>
+ <td>
+ 7
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.value</code>
+ </td>
+ <td>
+ 8
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.value</code>
+ </td>
+ <td>
+ 9
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>preferredUsername</code>
+ </td>
+ <td>
+ 10
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.familyName</code>
+ </td>
+ <td>
+ 11
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.givenName</code>
+ </td>
+ <td>
+ 12
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.middleName</code>
+ </td>
+ <td>
+ 13
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.country</code>
+ </td>
+ <td>
+ 14
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.region</code>
+ </td>
+ <td>
+ 15
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.streetAddress</code>
+ </td>
+ <td>
+ 16
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.locality</code>
+ </td>
+ <td>
+ 17
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.postalCode</code>
+ </td>
+ <td>
+ 18
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.department</code>
+ </td>
+ <td>
+ 19
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.title</code>
+ </td>
+ <td>
+ 20
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.startDate</code>
+ </td>
+ <td>
+ 21
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.endDate</code>
+ </td>
+ <td>
+ 22
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.location</code>
+ </td>
+ <td>
+ 23
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>organizations.description</code>
+ </td>
+ <td>
+ 24
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.domain</code>
+ </td>
+ <td>
+ 25
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.userid</code>
+ </td>
+ <td>
+ 26
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>accounts.username</code>
+ </td>
+ <td>
+ 27
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.value</code>
+ </td>
+ <td>
+ 28
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.value</code>
+ </td>
+ <td>
+ 29
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.value</code>
+ </td>
+ <td>
+ 30
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>gender</code>
+ </td>
+ <td>
+ 31
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>birthday</code>
+ </td>
+ <td>
+ 32
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>anniversary</code>
+ </td>
+ <td>
+ 33
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>published</code>
+ </td>
+ <td>
+ 34
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>updated</code>
+ </td>
+ <td>
+ 35
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>utcOffset</code>
+ </td>
+ <td>
+ 36
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>notes</code>
+ </td>
+ <td>
+ 37
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.honorificPrefix</code>
+ </td>
+ <td>
+ 38
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>name.honorificSuffix</code>
+ </td>
+ <td>
+ 39
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.type</code>
+ </td>
+ <td>
+ 40
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.type</code>
+ </td>
+ <td>
+ 41
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.type</code>
+ </td>
+ <td>
+ 42
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.type</code>
+ </td>
+ <td>
+ 43
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.type</code>
+ </td>
+ <td>
+ 44
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.type</code>
+ </td>
+ <td>
+ 45
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.type</code>
+ </td>
+ <td>
+ 46
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.type</code>
+ </td>
+ <td>
+ 47
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>connected</code>
+ </td>
+ <td>
+ 48
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>id</code>
+ </td>
+ <td>
+ 49
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls.primary</code>
+ </td>
+ <td>
+ n/a (boolean attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>phoneNumbers</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>addresses</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>emails</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>ims</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>photos</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tags</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>relationships</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>urls</code>
+ </td>
+ <td>
+ n/a (complex attribute)
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ <br>
+ </div>
+ <div class="appendix section" id="references"><!--OddPage--><h2><span class="secno">C. </span>References</h2><div class="section" id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-CORE-DEVICE">[CORE-DEVICE]</dt><dd>Robin Berjon. <a href="http://dev.w3.org/2009/dap/device/"><cite>Core Device Interfaces.</cite></a> 02 December 2009. W3C Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/device/">http://dev.w3.org/2009/dap/device/</a>
+</dd><dt id="bib-POCO-SCHEMA">[POCO-SCHEMA]</dt><dd>Joseph Smarr. <a href="http://portablecontacts.net/draft-spec.html#schema"><cite>Portable Contacts 1.0 Draft C: Contact Schema</cite></a> 5 August 2008. URL: <a href="http://portablecontacts.net/draft-spec.html#schema">http://portablecontacts.net/draft-spec.html#schema</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-UNICODE">[UNICODE]</dt><dd>The Unicode Consortium. <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html"><cite>The Unicode Standard.</cite></a> 2003. Defined by: The Unicode Standard, Version 4.0 (Boston, MA, Addison-Wesley, ISBN 0-321-18578-1), as updated from time to time by the publication of new versions URL: <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html">http://www.unicode.org/unicode/standard/versions/enumeratedversions.html</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219"><cite>Web IDL.</cite></a> 19 December 2008. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219">http://www.w3.org/TR/2008/WD-WebIDL-20081219</a>
+</dd></dl></div><div class="section" id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><dl class="bibliography"><dt id="bib-CONTACTS-WRITER-API">[CONTACTS-WRITER-API]</dt><dd>R. Tibbett. <a href="http://dev.w3.org/2009/dap/contacts/Writer.html"><cite>Contacts Writer API</cite></a>. 3rd August 2010. W3C Latest Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/contacts/Writer.html">http://dev.w3.org/2009/dap/contacts/Writer.html</a>
+</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2010/WD-html5-20100304/"><cite>HTML 5.</cite></a> 4 March 2010. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2010/WD-html5-20100304/">http://www.w3.org/TR/2010/WD-html5-20100304/</a>
+</dd></dl></div></div></body></html>
\ No newline at end of file
Binary file contacts/WD2/contacts_notification.png has changed
Binary file contacts/WD2/contacts_picker.png has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD3/CVS/Entries Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,5 @@
+/contacts_element.png/1.1/Wed Dec 8 11:45:41 2010/-kb/
+/contacts_notification.png/1.1/Wed Dec 8 11:45:41 2010/-kb/
+/contacts_picker.png/1.1/Wed Dec 8 11:45:41 2010/-kb/
+/Overview.html/1.3/Wed Dec 8 15:48:19 2010//
+D
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD3/CVS/Repository Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+2009/dap/contacts/WD3
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD3/CVS/Root Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1 @@
+rberjon2@dev.w3.org:/sources/public
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/WD3/Overview.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,1894 @@
+<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
+<html lang="en" dir="ltr">
+<head>
+
+
+ <title>
+ Contacts API
+ </title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+
+
+
+
+<style type="text/css">
+/* ReSpec.js CSS optimizations (Richard Tibbett) */
+
+div.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ background: #fff;
+ padding: 1em;
+ font-size: 0.9em;
+ margin-top: 1em;
+}
+div.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ padding-left: 5px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* Clean up pre.idl */
+pre.idl::before {
+ font-size:0.9em;
+}
+
+/* Add better spacing to sections */
+section, .section {
+ margin-bottom: 2em;
+}
+
+/* Reduce note & issue render size */
+.note, .issue {
+ font-size:0.8em;
+}
+
+/* Add addition spacing to <ol> and <ul> for rule definition */
+ol.rule li, ul.rule li {
+ padding:0.2em;
+}
+</style>
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec CSS
+ * Robin Berjon (robin at berjon dot com)
+ * v0.05 - 2009-07-31
+ *****************************************************************/
+
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: medium solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: medium dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- WEB IDL --- */
+pre.idl {
+ border-top: 1px solid #90b8de;
+ border-bottom: 1px solid #90b8de;
+ padding: 1em;
+ line-height: 120%;
+}
+
+pre.idl::before {
+ content: "WebIDL";
+ display: block;
+ width: 150px;
+ background: #90b8de;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+.idlType {
+ color: #ff4500;
+ font-weight: bold;
+ text-decoration: none;
+}
+
+/*.idlModule*/
+/*.idlModuleID*/
+/*.idlInterface*/
+.idlInterfaceID {
+ font-weight: bold;
+ color: #005a9c;
+}
+
+.idlSuperclass {
+ font-style: italic;
+ color: #005a9c;
+}
+
+/*.idlAttribute*/
+.idlAttrType, .idlFieldType {
+ color: #005a9c;
+}
+.idlAttrName, .idlFieldName {
+ color: #ff4500;
+}
+.idlAttrName a, .idlFieldName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlMethod*/
+.idlMethType {
+ color: #005a9c;
+}
+.idlMethName {
+ color: #ff4500;
+}
+.idlMethName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlParam*/
+.idlParamType {
+ color: #005a9c;
+}
+.idlParamName {
+ font-style: italic;
+}
+
+.extAttr {
+ color: #666;
+}
+
+/*.idlConst*/
+.idlConstType {
+ color: #005a9c;
+}
+.idlConstName {
+ color: #ff4500;
+}
+.idlConstName a {
+ color: #ff4500;
+ border-bottom: 1px dotted #ff4500;
+ text-decoration: none;
+}
+
+/*.idlException*/
+.idlExceptionID {
+ font-weight: bold;
+ color: #c00;
+}
+
+.idlTypedefID, .idlTypedefType {
+ color: #005a9c;
+}
+
+.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
+ color: #c00;
+ font-weight: normal;
+}
+
+.excName a {
+ font-family: monospace;
+}
+
+.idlRaises a.idlType, .excName a.idlType {
+ border-bottom: 1px dotted #c00;
+}
+
+.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
+ width: 45px;
+ text-align: center;
+}
+.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
+.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
+
+.idlImplements a {
+ font-weight: bold;
+}
+
+dl.attributes, dl.methods, dl.constants, dl.fields {
+ margin-left: 2em;
+}
+
+.attributes dt, .methods dt, .constants dt, .fields dt {
+ font-weight: normal;
+}
+
+.attributes dt code, .methods dt code, .constants dt code, .fields dt code {
+ font-weight: bold;
+ color: #000;
+ font-family: monospace;
+}
+
+.attributes dt code, .fields dt code {
+ background: #ffffd2;
+}
+
+.attributes dt .idlAttrType code, .fields dt .idlFieldType code {
+ color: #005a9c;
+ background: transparent;
+ font-family: inherit;
+ font-weight: normal;
+ font-style: italic;
+}
+
+.methods dt code {
+ background: #d9e6f8;
+}
+
+.constants dt code {
+ background: #ddffd2;
+}
+
+.attributes dd, .methods dd, .constants dd, .fields dd {
+ margin-bottom: 1em;
+}
+
+table.parameters, table.exceptions {
+ border-spacing: 0;
+ border-collapse: collapse;
+ margin: 0.5em 0;
+ width: 100%;
+}
+table.parameters { border-bottom: 1px solid #90b8de; }
+table.exceptions { border-bottom: 1px solid #deb890; }
+
+.parameters th, .exceptions th {
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+ font-family: initial;
+ font-weight: normal;
+ text-shadow: #666 1px 1px 0;
+}
+.parameters th { background: #90b8de; }
+.exceptions th { background: #deb890; }
+
+.parameters td, .exceptions td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+ vertical-align: top;
+}
+
+.parameters tr:first-child td, .exceptions tr:first-child td {
+ border-top: none;
+}
+
+.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
+ width: 100px;
+}
+
+.parameters td.prmType {
+ width: 120px;
+}
+
+table.exceptions table {
+ border-spacing: 0;
+ border-collapse: collapse;
+ width: 100%;
+}
+
+/* --- TOC --- */
+.toc a {
+ text-decoration: none;
+}
+
+a .secno {
+ color: #000;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+
+/* --- EXAMPLES --- */
+pre.example {
+ border-top: 1px solid #ff4500;
+ border-bottom: 1px solid #ff4500;
+ padding: 1em;
+ margin-top: 1em;
+}
+
+pre.example::before {
+ content: "Example";
+ display: block;
+ width: 150px;
+ background: #ff4500;
+ color: #fff;
+ font-family: initial;
+ padding: 3px;
+ font-weight: bold;
+ margin: -1em 0 1em -1em;
+}
+
+/* --- EDITORIAL NOTES --- */
+.issue {
+ padding: 1em;
+ margin: 1em 0em 0em;
+ border: 1px solid #f00;
+ background: #ffc;
+}
+
+.issue::before {
+ content: "Issue";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #f00;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+.note {
+ margin: 1em 0em 0em;
+ padding: 1em;
+ border: 2px solid #cff6d9;
+ background: #e2fff0;
+}
+
+.note::before {
+ content: "Note";
+ display: block;
+ width: 150px;
+ margin: -1.5em 0 0.5em 0;
+ font-weight: bold;
+ border: 1px solid #cff6d9;
+ background: #fff;
+ padding: 3px 1em;
+}
+
+/* --- Best Practices --- */
+div.practice {
+ border: solid #bebebe 1px;
+ margin: 2em 1em 1em 2em;
+}
+
+span.practicelab {
+ margin: 1.5em 0.5em 1em 1em;
+ font-weight: bold;
+ font-style: italic;
+}
+
+span.practicelab { background: #dfffff; }
+
+span.practicelab {
+ position: relative;
+ padding: 0 0.5em;
+ top: -1.5em;
+}
+
+p.practicedesc {
+ margin: 1.5em 0.5em 1em 1em;
+}
+
+@media screen {
+ p.practicedesc {
+ position: relative;
+ top: -2em;
+ padding: 0;
+ margin: 1.5em 0.5em -1em 1em;
+}
+
+/* --- SYNTAX HIGHLIGHTING --- */
+pre.sh_sourceCode {
+ background-color: white;
+ color: black;
+ font-style: normal;
+ font-weight: normal;
+}
+
+pre.sh_sourceCode .sh_keyword { color: #005a9c; font-weight: bold; } /* language keywords */
+pre.sh_sourceCode .sh_type { color: #666; } /* basic types */
+pre.sh_sourceCode .sh_usertype { color: teal; } /* user defined types */
+pre.sh_sourceCode .sh_string { color: red; font-family: monospace; } /* strings and chars */
+pre.sh_sourceCode .sh_regexp { color: orange; font-family: monospace; } /* regular expressions */
+pre.sh_sourceCode .sh_specialchar { color: #ffc0cb; font-family: monospace; } /* e.g., \n, \t, \\ */
+pre.sh_sourceCode .sh_comment { color: #A52A2A; font-style: italic; } /* comments */
+pre.sh_sourceCode .sh_number { color: purple; } /* literal numbers */
+pre.sh_sourceCode .sh_preproc { color: #00008B; font-weight: bold; } /* e.g., #include, import */
+pre.sh_sourceCode .sh_symbol { color: blue; } /* e.g., *, + */
+pre.sh_sourceCode .sh_function { color: black; font-weight: bold; } /* function calls and declarations */
+pre.sh_sourceCode .sh_cbracket { color: red; } /* block brackets (e.g., {, }) */
+pre.sh_sourceCode .sh_todo { font-weight: bold; background-color: #00FFFF; } /* TODO and FIXME */
+
+/* Predefined variables and functions (for instance glsl) */
+pre.sh_sourceCode .sh_predef_var { color: #00008B; }
+pre.sh_sourceCode .sh_predef_func { color: #00008B; font-weight: bold; }
+
+/* for OOP */
+pre.sh_sourceCode .sh_classname { color: teal; }
+
+/* line numbers (not yet implemented) */
+pre.sh_sourceCode .sh_linenum { display: none; }
+
+/* Internet related */
+pre.sh_sourceCode .sh_url { color: blue; text-decoration: underline; font-family: monospace; }
+
+/* for ChangeLog and Log files */
+pre.sh_sourceCode .sh_date { color: blue; font-weight: bold; }
+pre.sh_sourceCode .sh_time, pre.sh_sourceCode .sh_file { color: #00008B; font-weight: bold; }
+pre.sh_sourceCode .sh_ip, pre.sh_sourceCode .sh_name { color: #006400; }
+
+/* for Prolog, Perl... */
+pre.sh_sourceCode .sh_variable { color: #006400; }
+
+/* for LaTeX */
+pre.sh_sourceCode .sh_italics { color: #006400; font-style: italic; }
+pre.sh_sourceCode .sh_bold { color: #006400; font-weight: bold; }
+pre.sh_sourceCode .sh_underline { color: #006400; text-decoration: underline; }
+pre.sh_sourceCode .sh_fixed { color: green; font-family: monospace; }
+pre.sh_sourceCode .sh_argument { color: #006400; }
+pre.sh_sourceCode .sh_optionalargument { color: purple; }
+pre.sh_sourceCode .sh_math { color: orange; }
+pre.sh_sourceCode .sh_bibtex { color: blue; }
+
+/* for diffs */
+pre.sh_sourceCode .sh_oldfile { color: orange; }
+pre.sh_sourceCode .sh_newfile { color: #006400; }
+pre.sh_sourceCode .sh_difflines { color: blue; }
+
+/* for css */
+pre.sh_sourceCode .sh_selector { color: purple; }
+pre.sh_sourceCode .sh_property { color: blue; }
+pre.sh_sourceCode .sh_value { color: #006400; font-style: italic; }
+
+/* other */
+pre.sh_sourceCode .sh_section { color: black; font-weight: bold; }
+pre.sh_sourceCode .sh_paren { color: red; }
+pre.sh_sourceCode .sh_attribute { color: #006400; }
+
+</style><link charset="utf-8" type="text/css" rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"></head><body style="display: inherit;"><div class="head"><p><a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a></p><h1 class="title" id="title">Contacts API</h1><h2 id="w3c-working-draft-09-december-2010">W3C Working Draft 09 December 2010</h2><dl><dt>This version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20101209/">http://www.w3.org/TR/2010/WD-contacts-api-20101209/</a></dd><dt>Latest published version:</dt><dd><a href="http://www.w3.org/TR/contacts-api/">http://www.w3.org/TR/contacts-api/</a></dd><dt>Latest editor's draft:</dt><dd><a href="http://dev.w3.org/2009/dap/contacts/">http://dev.w3.org/2009/dap/contacts/</a></dd><dt>Previous version:</dt><dd><a href="http://www.w3.org/TR/2010/WD-contacts-api-20100817/">http://www.w3.org/TR/2010/WD-contacts-api-20100817/</a></dd><dt>Editor:</dt><dd><a href="http://richt.me">Richard Tibbett</a>, <a href="http://www.opera.com">Opera Software ASA</a></dd>
+</dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2010 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p><hr></div>
+ <div class="introductory section" id="abstract"><h2>Abstract</h2>
+ <p>
+ The Contacts API defines the high-level interfaces required to provide read access to a user's unified address book.
+ </p>
+ <p>
+ Methods to manipulate a user's unified address book, to add and remove contact information, are being developed in an
+ accompanying specification [<cite><a href="#bib-CONTACTS-WRITER-API" rel="biblioentry" class="bibref">CONTACTS-WRITER-API</a></cite>].
+ </p>
+ </div><div id="sotd" class="introductory section"><h2>Status of This Document</h2><p><em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em></p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed Contacts API. Issues and
+ editors note in the document highlight some of the points on which the group is still working and would particularly like to get
+ feedback.
+ </p>
+ <p>This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). All feedback is welcome.</p><p>Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.</p><p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 W3C Patent Policy</a>. W3C maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the W3C Patent Policy</a>.</p></div><div class="section" id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a class="tocxref" href="#conformance"><span class="secno">1. </span>Conformance</a></li><li class="tocline"><a class="tocxref" href="#introduction"><span class="secno">2. </span>
+ Introduction
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#terminology"><span class="secno">2.1 </span>
+ Terminology
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#security-and-privacy-considerations"><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-implementors-of-the-contacts-api"><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </a></li><li class="tocline"><a class="tocxref" href="#privacy-considerations-for-recipients-of-contact-information"><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </a></li><li class="tocline"><a class="tocxref" href="#additional-implementation-considerations"><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#api-description"><span class="secno">4. </span>
+ API Description
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#servicecontacts-interface"><span class="secno">4.1 </span>
+ <span class="idlType formerLink idlType"><code>ServiceContacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes"><span class="secno">4.1.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacts-interface"><span class="secno">4.2 </span>
+ <span class="idlType formerLink idlType"><code>Contacts</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods"><span class="secno">4.2.1 </span>Methods</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-interface"><span class="secno">4.3 </span>
+ <span class="idlType formerLink idlType"><code>Contact</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-1"><span class="secno">4.3.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactname-interface"><span class="secno">4.4 </span>
+ <span class="idlType formerLink idlType"><code>ContactName</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-2"><span class="secno">4.4.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfield-interface"><span class="secno">4.5 </span>
+ <span class="idlType formerLink idlType"><code>ContactField</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-3"><span class="secno">4.5.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactaddress-interface"><span class="secno">4.6 </span>
+ <span class="idlType formerLink idlType"><code>ContactAddress</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-4"><span class="secno">4.6.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactorganization-interface"><span class="secno">4.7 </span>
+ <span class="idlType formerLink idlType"><code>ContactOrganization</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-5"><span class="secno">4.7.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindoptions-interface"><span class="secno">4.8 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindOptions</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-6"><span class="secno">4.8.1 </span>Attributes</a></li></ul></li><li class="tocline"><a class="tocxref" href="#contactfindcb-interface"><span class="secno">4.9 </span>
+ <span class="idlType formerLink idlType"><code>ContactFindCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-1"><span class="secno">4.9.1 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#event-handler-attributes"><span class="secno">4.9.2 </span>
+ Event Handler Attributes
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterrorcb-interface"><span class="secno">4.10 </span>
+ <span class="idlType formerLink idlType"><code>ContactErrorCB</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods-2"><span class="secno">4.10.1 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#event-handler-attributes-1"><span class="secno">4.10.2 </span>
+ Event Handler Attributes
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#contacterror-interface"><span class="secno">4.11 </span>
+ <span class="idlType formerLink idlType"><code>ContactError</code></span> interface
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-7"><span class="secno">4.11.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#constants"><span class="secno">4.11.2 </span>Constants</a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#contact-search-processing"><span class="secno">5. </span>
+ <span class="formerLink">Contact Search Processing</span>
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-qualifiers"><span class="secno">5.1 </span>
+ Search Qualifiers
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#advanced-search-qualifiers"><span class="secno">5.1.1 </span>
+ Advanced Search Qualifiers
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#options-processing"><span class="secno">5.2 </span>
+ Options Processing
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#search-cardinality"><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </a></li><li class="tocline"><a class="tocxref" href="#search-filters"><span class="secno">5.2.2 </span>
+ Search Filters
+ </a></li></ul></li></ul></li><li class="tocline"><a class="tocxref" href="#extended-contact-properties-and-parameters"><span class="secno">6. </span>
+ Extended Contact Properties and Parameters
+ </a></li><li class="tocline"><a class="tocxref" href="#api-invocation-via-dom-events"><span class="secno">A. </span>API Invocation via DOM Events</a></li><li class="tocline"><a class="tocxref" href="#user-interaction-guidelines"><span class="secno">B. </span>
+ User Interaction Guidelines
+ </a><ul class="toc"><li class="tocline"><a class="tocxref" href="#sharing-contact-information---example--1"><span class="secno">B.1 </span>
+ Accessing Contact Information - Example #1
+ </a></li><li class="tocline"><a class="tocxref" href="#sharing-contact-information---example--2"><span class="secno">B.2 </span>
+ Accessing Contact Information - Example #2
+ </a></li></ul></li><li class="tocline"><a class="tocxref" href="#references"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li class="tocline"><a class="tocxref" href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></div>
+
+ <div class="section" id="conformance"><!--OddPage--><h2><span class="secno">1. </span>Conformance</h2><p>As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.</p>
+<p>The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>, and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<cite><a href="#bib-RFC2119" rel="biblioentry" class="bibref">RFC2119</a></cite>].</p>
+
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn id="dfn-user-agent">user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>], as this specification uses that specification and
+ terminology.
+ </p>
+ </div>
+ <div id="introduction" class="informative section">
+ <!--OddPage--><h2><span class="secno">2. </span>
+ Introduction
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of representing address book
+ information. Most users are required to maintain a plurality of contact lists which leads to multiple copies of address book data.
+ The multiplicity of address books that a user is required to maintain often leads to disjointed and inconsistent information being
+ stored across a user's address book providers.
+ </p>
+ <p>
+ Providing address book information to these service providers means handing over all of your data and trusting these providers with
+ the security and privacy of storing and sharing of your information. When sharing this data with third parties users are, more
+ often than not, required to hand over access to their whole address book. Users are implicitly required to trust third parties with
+ all of their data when, in reality, the user may only wish, or need, to share a subset of their address book information so that an
+ application can fulfill its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may be sourced from a
+ plurality of sources - both online and locally. This specification then defines the interfaces on which third party applications
+ can access a user's unified address book, with explicit user permission and filtering. The focus of this data sharing is on
+ making the user aware of the data that they will share and putting them at the center of the data sharing process; free to select
+ both the extent to which they share their address book information and the ability to restrict which pieces of information related
+ to which contact gets shared.
+ </p>
+ <p>
+ A conforming implementation is required to implement all fields defined in this specification.
+ </p>
+ <div class="example">
+ <p>
+ The following code illustrates how to obtain contact information from a user's address book:
+ </p>
+<pre class="sh_javascript sh_sourceCode"><span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>displayName<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span>
+<span class="sh_comment">// ..is equivalent to: navigator.service.contacts(/* parameters */)</span>
+</pre>
+ </div>
+ <div class="section" id="terminology">
+ <h3><span class="secno">2.1 </span>
+ Terminology
+ </h3>
+ <p>
+ The terms <dfn id="dfn-document-base-url">document base URL</dfn>, <dfn id="dfn-browsing-context">browsing context</dfn>, <dfn id="dfn-event-handler-attribute" title="event handler attribute">event handler attributes</dfn>, <dfn id="dfn-event-handler-event-type">event handler event type</dfn>, <dfn id="dfn-task">task</dfn>, <dfn id="dfn-task-source">task
+ source</dfn> and <dfn id="dfn-task-queues">task queues</dfn> are defined by the HTML5 specification [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>].
+ </p>
+ <p>
+ The <a class="internalDFN" href="#dfn-task-source">task source</a> used by this specification is the <dfn id="dfn-pendingop-task-source"><a href="http://dev.w3.org/2009/dap/device/#the-pendingop-interface">PendingOp</a> task source</dfn>.
+ </p>
+
+ <p class="note">
+ PendingOp needs updating in [<cite><a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a></cite>] to show that it is a valid <a class="internalDFN" href="#dfn-task-source">task source</a>.
+ </p>
+ <p>
+ To <dfn id="dfn-dispatch-a-success-event">dispatch a <code>success</code> event</dfn> means that an event with the name <code>success</code>, which does
+ not bubble and is not cancelable, and which uses the <code>Event</code> interface, is to be dispatched at the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> object.
+ </p>
+ <p>
+ To <dfn id="dfn-dispatch-an-error-event">dispatch an <code>error</code> event</dfn> means that an event with the name <code>error</code>, which does
+ not bubble and is not cancelable, and which uses the <code>Event</code> interface, is to be dispatched at the <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> object.
+ </p>
+ </div>
+ </div>
+ <div class="section" id="security-and-privacy-considerations">
+ <!--OddPage--><h2><span class="secno">3. </span>
+ Security and Privacy Considerations
+ </h2>
+ <p class="note">
+ The overall architecture for addressing privacy in DAP is still under construction. As it is finalized, there may be changes made
+ to this API to reflect requirements or support for privacy-related functionality.
+ </p>
+ <p>
+ The API defined in this specification can be used to find contact information from a user's address book(s). This discloses
+ information related to a user's contacts such as their phone number(s), email address(es) and other personally identifying
+ information. The distribution of this information could potentially compromise the user's privacy, or the
+ user’s contacts privacy. A conforming implementation of this specification <em title="must" class="rfc2119">must</em> provide a mechanism that
+ protects the user's privacy and this mechanism should ensure that no contact information is retrievable without the user's
+ express permission.
+ </p>
+ <div class="section" id="privacy-considerations-for-implementors-of-the-contacts-api">
+ <h3><span class="secno">3.1 </span>
+ Privacy considerations for implementors of the Contacts API
+ </h3>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> not retrieve contact information to Web sites without the express permission of the user. A <a class="internalDFN" href="#dfn-user-agent">user
+ agent</a> <em title="must" class="rfc2119">must</em> acquire permission through a user interface, unless they have prearranged trust relationships with users, as
+ described below. The user interface <em title="must" class="rfc2119">must</em> include the <a class="internalDFN" href="#dfn-document-base-url">document base URL</a>. Those permissions that are acquired through the
+ user interface and that are preserved beyond the current browsing session (i.e. beyond the time when the <a class="internalDFN" href="#dfn-browsing-context">browsing context</a>
+ is navigated to another URL) <em title="must" class="rfc2119">must</em> be revocable and a <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> respect revoked permissions.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted permission for the same
+ Web site to access other methods provided by this API, or to access the same method with a different set of arguments, as part of
+ the same permission context. If a user has expressed permission for an implementation to, e.g. find a set of existing contacts,
+ the implementation <em title="must" class="rfc2119">must</em> seek the user's express permission if and when any additional <code>find</code> function is called on
+ this API.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-user-agent">user agent</a> may have prearranged trust relationships that do not require such user interfaces. For example, while a Web
+ browser will present a user interface when a Web site performs an address book request, a Widget [<cite><a href="#bib-WIDGETS" rel="biblioentry" class="bibref">WIDGETS</a></cite>] runtime <em title="may" class="rfc2119">may</em> have a
+ prearranged, delegated security relationship with the user and, as such, a suitable alternative security and privacy mechanism
+ with which to authorize the retrieval of contact information.
+ </p>
+ </div>
+ <div id="privacy-considerations-for-recipients-of-contact-information" class="informative section">
+ <h3><span class="secno">3.2 </span>
+ Privacy considerations for recipients of contact information
+ </h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Web sites owners that retrieve contacts information using this API are denoted as recipients below.
+ </p>
+ <p>
+ Recipients should only request contact information when necessary, and only use the contact information for the task for which it
+ was provided to them.
+ </p>
+ <p>
+ Recipients should dispose of contact information once that task is completed, unless expressly permitted to retain it by the
+ user. Recipients should also take measures to protect this information against unauthorized access. If contact information is
+ stored, users should be allowed to update and delete this information.
+ </p>
+ <p>
+ The recipient of contact information should not retransmit the contact information without the user's express permission.
+ Care should be taken when retransmitting and use of encryption is encouraged.
+ </p>
+ <p>
+ Recipients should clearly and conspicuously disclose the fact that they are collecting contact data, the purpose for the
+ collection, how long the data is retained, how the data is secured, how the data is shared if it is shared, how users can access,
+ update and delete the data, and any other choices that users have with respect to the data. This disclosure should include an
+ explanation of any exceptions to the guidelines listed above.
+ </p>
+ </div>
+ <div id="additional-implementation-considerations" class="informative section">
+ <h3><span class="secno">3.3 </span>
+ Additional implementation considerations
+ </h3><p><em>This section is non-normative.</em></p>
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are also advised to consider the
+ following aspects that can negatively affect the privacy of their users: in certain cases, users can inadvertently grant
+ permission to the User Agent to disclose their contacts to Web sites. In other cases, the content hosted at a certain URL changes
+ in such a way that the previously granted contact permissions no longer apply as far as the user is concerned. Or the users might
+ simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive measures are an
+ implementation responsibility and not prescribed by this specification. However, in designing these measures, implementers are
+ advised to enable user awareness of contact sharing, and to provide easy access to interfaces that enable revocation of
+ permissions.
+ </p>
+ </div>
+ </div>
+ <div class="section" id="api-description">
+ <!--OddPage--><h2><span class="secno">4. </span>
+ API Description
+ </h2>
+ <div class="section" id="servicecontacts-interface">
+ <h3><span class="secno">4.1 </span>
+ <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a> interface
+ </h3>
+ <p>
+ The <a href="#servicecontacts-interface"><code>ServiceContacts</code></a> interface is exposed on the <code>navigator.service</code>
+ object, as defined in [<cite><a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a></cite>].
+ </p>
+ <pre class="idl"><span class="idlImplements"><a>Service</a> implements <a class="idlType" href="#idl-def-ServiceContacts"><code>ServiceContacts</code></a>;</span></pre><div class="idlImplementsDesc">
+
+ </div>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ServiceContacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ServiceContacts</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span> <span class="idlAttrName"><a href="#widl-ServiceContacts-contacts">contacts</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes"><h4><span class="secno">4.1.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ServiceContacts-contacts"><code>contacts</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a></span>, readonly</dt><dd>
+ The root node from which the contacts functionality can be accessed.
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contacts-interface">
+ <h3><span class="secno">4.2 </span>
+ <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface
+ </h3>
+ <p>
+ The <a class="idlType" href="#idl-def-Contacts"><code>Contacts</code></a> interface exposes a database collecting contacts information that may be retrieved.
+ </p>
+ <p>
+ Multiple contact groups can be represented within this unified address book by specifying consistent <a href="#widl-Contact-categories"><code>categories</code></a> value(s) as part of individual <a href="#contact-interface"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering on the
+ required <a href="#widl-Contact-categories"><code>categories</code></a> value(s) via the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> function.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contacts">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contacts</span> {
+<span class="idlMethod"> <span class="idlMethType"><a>caller PendingOp</a></span> <span class="idlMethName"><a href="#widl-Contacts-find">find</a></span> (<span class="idlParam">in <span class="idlParamType"><a>DOMString</a>[]</span> <span class="idlParamName">fields</span></span>, <span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a></span> <span class="idlParamName">successCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a>?</span> <span class="idlParamName">errorCB</span></span>, <span class="idlParam">in optional <span class="idlParamType"><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a>?</span> <span class="idlParamName">options</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods"><h4><span class="secno">4.2.1 </span>Methods</h4><dl class="methods"><dt id="widl-Contacts-find"><code>find</code></dt><dd>
+ <p>
+ Find contacts in the address book according to the <a class="internalDFN" href="#dfn-find-contacts-process">find contacts process</a> detailed below.
+ </p>
+ <p>
+ This method takes two, three or four arguments. When called, it immediately returns a <code>PendingOp</code> object, as
+ defined in [<cite><a href="#bib-CORE-DEVICE" rel="biblioentry" class="bibref">CORE-DEVICE</a></cite>], and then asynchronously starts a <dfn id="dfn-find-contacts-process">find contacts process</dfn> defined as follows:
+ </p>
+ <ol class="rule">
+ <li>
+ If there are any <a>tasks</a> from the <a class="internalDFN" href="#dfn-pendingop-task-source" title="PendingOp task source"><code>PendingOp</code> task source</a> in one of the <a class="internalDFN" href="#dfn-task-queues">task queues</a>
+ (i.e. an existing <code>find()</code> operation is still pending a response), and the current method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, <a class="internalDFN" href="#dfn-dispatch-an-error-event">dispatch an <code>error</code> event</a> with a <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> <code>code</code> value.
+ </li>
+ <li>
+ Search for contacts in the address book according to the rules defined in <a href="#contact-search-processing">Contact Search Processing</a>.
+ </li>
+ <li>
+ If the attempt was successful, <a class="internalDFN" href="#dfn-dispatch-a-success-event">dispatch a <code>success</code> event</a>. If the attempt fails, and the method was
+ invoked with a non-<code>null</code> <code>errorCB</code> argument, this method must <a class="internalDFN" href="#dfn-dispatch-an-error-event">dispatch an <code>error</code>
+ event</a> with the <code>code</code> attribute set according to the type of failure that has occurred.
+ </li>
+ </ol>
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">fields</td><td class="prmType"><code><a>DOMString</a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </td></tr><tr><td class="prmName">successCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ Function to call when the asynchronous operation completes
+ </td></tr><tr><td class="prmName">errorCB</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ Function to call when the asynchronous operation fails.
+ </td></tr><tr><td class="prmName">options</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a></code></td><td class="prmNullTrue">✔</td><td class="prmOptTrue">✔</td><td class="prmDesc">
+ The options to apply to the output of this method.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>caller PendingOp</a></code></div></dd></dl></div>
+ </div>
+ <div class="section" id="contact-interface">
+ <h3><span class="secno">4.3 </span>
+ <a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> interface
+ </h3>
+ <p class="note">
+ The attributes provided in this interface are under review and are likely to change as the recommendation progresses.
+ </p>
+ <p>
+ The <a href="#contact-interface"><code>Contact</code></a> interface captures the properties of a contact object.
+ </p>
+ <p>
+ All <a href="#contact-interface"><code>Contact</code></a> objects <em title="must" class="rfc2119">must</em> include all attributes supported by the implementation,
+ regardless of whether these attributes have been assigned a non-<code>null</code> value or a <code>null</code> value. If a
+ supported attribute has not been assigned a value by the user and/or implementation, then this attribute <em title="must" class="rfc2119">must</em> still be present in
+ the resulting <a href="#contact-interface"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+ <p>
+ Additional attributes <em title="may" class="rfc2119">may</em> be included according to the provisions detailed in <a href="#extended-contact-properties-and-parameters">Extended Contact Properties and Parameters</a>. If an extended attribute is
+ supported by the current implementation and has not been assigned a value by the user and/or implementation, then this extended
+ attribute <em title="must" class="rfc2119">must</em> still be present in the resulting <a href="#contact-interface"><code>Contact</code></a> object and <em title="must" class="rfc2119">must</em> have a value of <code>null</code>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-Contact">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">Contact</span> {
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-id">id</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-displayName">displayName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span> <span class="idlAttrName"><a href="#widl-Contact-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-nickname">nickname</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-phoneNumbers">phoneNumbers</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-emails">emails</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-addresses">addresses</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-ims">ims</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-organizations">organizations</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>Date</a></span> <span class="idlAttrName"><a href="#widl-Contact-revision">revision</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>Date</a></span> <span class="idlAttrName"><a href="#widl-Contact-birthday">birthday</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-gender">gender</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-note">note</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-photos">photos</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-categories">categories</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a>[]</span> <span class="idlAttrName"><a href="#widl-Contact-urls">urls</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-Contact-timezone">timezone</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-1"><h4><span class="secno">4.3.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-Contact-addresses"><code>addresses</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more physical addresses associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-birthday"><code>birthday</code> of type <span class="idlAttrType"><a>Date</a></span></dt><dd>
+ <p>
+ This attribute contains birthday of this Contact.
+ </p>
+ <p>
+ The year value <em title="may" class="rfc2119">may</em> be set to 0000 when the age of the Contact is private or the year is not available.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-categories"><code>categories</code> of type array of <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains one or more user-defined categories/tags/labels associated with this Contact. e.g. "family", "favorite".
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-displayName"><code>displayName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the display name of this Contact which is suitable for display to the end-users.
+ </p>
+ <p>
+ Each Contact <em title="must" class="rfc2119">must</em> include either a <code>displayName</code> or the <code>name</code> attribute.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-emails"><code>emails</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more email addresses associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-gender"><code>gender</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the gender of this Contact. This attribute <em title="should" class="rfc2119">should</em> have one of the following values:
+ </p>
+ <pre>male, female, undisclosed</pre>
+ <p>
+ This attribute <em title="may" class="rfc2119">may</em> return a different value if it is not covered by one of these values.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-id"><code>id</code> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly</dt><dd>
+ <p>
+ A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> <em title="must" class="rfc2119">must</em>
+ include a non-empty <code>id</code> value.
+ </p>
+ <p>
+ An implementation <em title="must" class="rfc2119">must</em> maintain this globally unique resource identifier when a Contact is added to, or present within, an
+ Address Book.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-ims"><code>ims</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more instant messaging identifiers associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-name"><code>name</code> of type <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a></span></dt><dd>
+ <p>
+ This attribute represents the full name of this <a href="#contact-interface"><code>Contact</code></a> indicated by the name
+ components associated with the <a href="#contactname-interface"><code>ContactName</code></a> object.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-nickname"><code>nickname</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the nickname (or a casual name) for this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-note"><code>note</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the personal notes (free-text) for this Contact that is managed by the user of the Address Book.
+ </p>
+ <p>
+ This field <em title="may" class="rfc2119">may</em> contain newlines (<code>\n</code>).
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-organizations"><code>organizations</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more organizations associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-phoneNumbers"><code>phoneNumbers</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more phone numbers associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-photos"><code>photos</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more photos (that may be displayed) associated with this Contact.
+ </p>
+ <p>
+ The photos <em title="must" class="rfc2119">must</em> be specified in the <code>value</code> attribute of the <code>ContactField</code> object either by using a URL
+ (representing an actual image file and not a web page pointing to that image file) or base64 encoded string representing the image data.
+ </p>
+ <p>
+ Service Providers <em title="may" class="rfc2119">may</em> return the same image at different sizes, though it is recognized that no standard for describing images of
+ various sizes currently exists.
+ </p>
+ <p class="note">
+ This attribute <em title="should not" class="rfc2119">should not</em> be used to send down arbitrary photos taken by this user, but specifically profile photos of the contact
+ suitable for display when describing the contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-revision"><code>revision</code> of type <span class="idlAttrType"><a>Date</a></span></dt><dd>
+ <p>
+ This atttribute contains the timestamp information associated with this Contact, which represents
+ the last known modified time. If no modified time exists, then this object contains the timestamp of when
+ the object was created.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-timezone"><code>timezone</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ The value contains the time zone of this Contact as an offset from UTC.
+ </p>
+ <p>
+ The value <em title="must" class="rfc2119">must</em> be specified as a positive or negative difference
+ from the UTC in units of hours and minutes (i.e. <code>+hh:mm</code>). Example, by specifying <code>+05:30</code> indicates the Contact
+ is associated with a current time zone of GMT+05:30.
+ </p>
+ <p class="note">
+ This value <em title="may" class="rfc2119">may</em> change over time due to daylight saving time, and is thus meant to signify only the current value of the user's timezone offset.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-Contact-urls"><code>urls</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a></span></dt><dd>
+ <p>
+ This attribute represents one or more web resources (i.e. URLs) associated with this Contact e.g. personal web page, blog.
+ </p>
+ <p>
+ The web resources <em title="must" class="rfc2119">must</em> be specified by the <code>value</code> attribute of the <code>ContactField</code> object using a URL.
+ </p>
+ <p>
+ In addition to the standard values for <code>type</code>, this field also defines the additional <code>type</code> values:
+ </p>
+ <pre>blog, profile</pre>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactname-interface">
+ <h3><span class="secno">4.4 </span>
+ <a class="idlType" href="#idl-def-ContactName"><code>ContactName</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactname-interface"><code>ContactName</code></a> interface describes a contact's name.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactName">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactName</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-familyName">familyName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-givenName">givenName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-middleName">middleName</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificPrefix">honorificPrefix</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactName-honorificSuffix">honorificSuffix</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-2"><h4><span class="secno">4.4.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactName-familyName"><code>familyName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the family name (also referred to as the last name) of this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the full name, including all the individual components such as <code>givenName</code>, <code>middleName</code>,
+ <code>familyName</code>, <code>prefix</code>, <code>suffix</code> as appropriate, and formatted for display (e.g. <code>Mr. Joe Smith Jr</code>).
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-givenName"><code>givenName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the given name (also referred to as the first name) of this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificPrefix"><code>honorificPrefix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the honorific prefix (or title) of this Contact. E.g. Mr. Dr. Ms. Mrs.,
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-honorificSuffix"><code>honorificSuffix</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the honorific suffix of this Contact. E.g. Jr, III, Sr.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactName-middleName"><code>middleName</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the middle name of this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfield-interface">
+ <h3><span class="secno">4.5 </span>
+ <a class="idlType" href="#idl-def-ContactField"><code>ContactField</code></a> interface
+ </h3>
+ <p>
+ The ContactField interface is a reusable component that is used to support contact fields within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactField">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactField</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-type">type</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactField-value">value</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a></span> <span class="idlAttrName"><a href="#widl-ContactField-pref">pref</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-3"><h4><span class="secno">4.5.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactField-pref"><code>pref</code> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>
+ <p>
+ This attribute indicates whether this instance of the <code>ContactField</code> is the preferred, or primary, value for the contact property this
+ <code>ContactField</code> is representing in the <code>Contact</code> interface.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-type"><code>type</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the type information for this <code>ContactField</code> and is subject to the contact property this
+ <code>ContactField</code> is representing in the <code>Contact</code> interface. For example, if the <code>ContactField</code> is
+ representing a phoneNumber property, the type attribute is set to <code>home</code>, <code>mobile</code>,
+ and if the Contact Field is representing ims property, the type attribute is set to <code>yahoo</code>, <code>gtalk</code>,
+ <code>bbm</code>, etc.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactField-value"><code>value</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the value for this <code>ContactField</code> and is subject to the contact property this
+ <code>ContactField</code> is representing in the <code>Contact</code> interface. For example, if the <code>ContactField</code> is
+ representing an <code>email</code>, the value attribute is set to <var>JoeSmith@example.com</var>, and if the ContactField is representing a <code>url</code>, the value
+ attribute is set to <var>http://www.example.org/joesmith</var>, etc.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactaddress-interface">
+ <h3><span class="secno">4.6 </span>
+ <a class="idlType" href="#idl-def-ContactAddress"><code>ContactAddress</code></a> interface
+ </h3>
+ <p>
+ The ContactAddress interface is a reusable component that is used to support contact addresses within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAddress">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAddress</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-formatted">formatted</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-streetAddress">streetAddress</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-locality">locality</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-region">region</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-postalCode">postalCode</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAddress-country">country</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-4"><h4><span class="secno">4.6.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactAddress-country"><code>country</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the country name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-formatted"><code>formatted</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the full physical address including street, locality, region, postalCode, and country as appropriate, and formatted for display.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-locality"><code>locality</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the locality (or city) name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-postalCode"><code>postalCode</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the postal code (or zip) corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-region"><code>region</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the region (or state/province) name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAddress-streetAddress"><code>streetAddress</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the street address corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactorganization-interface">
+ <h3><span class="secno">4.7 </span>
+ <a class="idlType" href="#idl-def-ContactOrganization"><code>ContactOrganization</code></a> interface
+ </h3>
+ <p>
+ The ContactOrganization interface is a reusable component that is used to support contact organizations within the <a href="#contact-interface"><code>Contact</code></a> interface.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactOrganization">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactOrganization</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-name">name</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-department">department</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactOrganization-title">title</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-5"><h4><span class="secno">4.7.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactOrganization-department"><code>department</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the Job Title information of the Contact associated with this Organization.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-name"><code>name</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the name of the Organization and <em title="must" class="rfc2119">must</em> be assigned a non-null value.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactOrganization-title"><code>title</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ This attribute contains the department information of the Organization associated with this Contact.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindoptions-interface">
+ <h3><span class="secno">4.8 </span>
+ <a class="idlType" href="#idl-def-ContactFindOptions"><code>ContactFindOptions</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> interface describes the options that can be applied to
+ contact searching. When a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation, it should be processed according to the provisions detailed in <a href="#options-processing">Options Processing</a>.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindOptions">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindOptions</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-filter">filter</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>boolean</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-multiple">multiple</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>Date</a>?</span> <span class="idlAttrName"><a href="#widl-ContactFindOptions-updatedSince">updatedSince</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-6"><h4><span class="secno">4.8.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactFindOptions-filter"><code>filter</code> of type <span class="idlAttrType"><a>DOMString</a></span>, nullable</dt><dd>
+ A DOMString-based <a class="internalDFN" href="#dfn-search-filter">search filter</a> with which to search and initially filter the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-multiple"><code>multiple</code> of type <span class="idlAttrType"><a>boolean</a></span>, nullable</dt><dd>
+ A boolean value to indicate whether multiple Contact objects are returnable as part of the associated <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+
+ <p>
+ By default this option is set to <code>true</code>.
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactFindOptions-updatedSince"><code>updatedSince</code> of type <span class="idlAttrType"><a>Date</a></span>, nullable</dt><dd>
+ <p>
+ Return only contact records that have been updated on or after the given time, specified as an ECMAScript <code>Date</code>
+ object.
+ </p>
+ <p>
+ This filter is applied to the <a href="#widl-Contact-revision"><code>revision</code></a> field as defined in <a href="#contact-interface"><code>Contact</code></a>.
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ </div>
+ <div class="section" id="contactfindcb-interface">
+ <h3><span class="secno">4.9 </span>
+ <a class="idlType" href="#idl-def-ContactFindCB"><code>ContactFindCB</code></a> interface
+ </h3>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactFindCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactFindCB</span> : <span class="idlSuperclass"><a>PendingOp</a></span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactFindCB-onsuccess">onsuccess</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</span> <span class="idlParamName">contactObjs</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-1"><h4><span class="secno">4.9.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactFindCB-onsuccess"><code>onsuccess</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">contactObjs</td><td class="prmType"><code><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a>[]</code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact objects resulting from the given <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method. <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a>
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ <div class="section" id="event-handler-attributes">
+ <h4><span class="secno">4.9.2 </span>
+ Event Handler Attributes
+ </h4>
+ <p>
+ The following is the <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a> (and its corresponding <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a>) that <em title="must" class="rfc2119">must</em> be
+ supported as a DOM attribute by the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> object.
+ </p>
+ <table class="simple">
+ <thead>
+ <tr>
+ <th>
+ <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a>
+ </th>
+ <th>
+ <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <strong><code><strong>onsuccess</strong></code></strong>
+ </td>
+ <td>
+ <code>success</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="section" id="contacterrorcb-interface">
+ <h3><span class="secno">4.10 </span>
+ <a class="idlType" href="#idl-def-ContactErrorCB"><code>ContactErrorCB</code></a> interface
+ </h3>
+ <!-- interface intro here -->
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactErrorCB">[<span class="extAttr">Callback=FunctionOnly, NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactErrorCB</span> : <span class="idlSuperclass"><a>PendingOp</a></span> {
+<span class="idlMethod"> <span class="idlMethType"><a>void</a></span> <span class="idlMethName"><a href="#widl-ContactErrorCB-onerror">onerror</a></span> (<span class="idlParam">in <span class="idlParamType"><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></span> <span class="idlParamName">error</span></span>);</span>
+};</span>
+</pre><div class="section" id="methods-2"><h4><span class="secno">4.10.1 </span>Methods</h4><dl class="methods"><dt id="widl-ContactErrorCB-onerror"><code>onerror</code></dt><dd>
+ <!-- interface description here -->
+
+ <table class="parameters"><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">error</td><td class="prmType"><code><a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a></code></td><td class="prmNullFalse">✘</td><td class="prmOptFalse">✘</td><td class="prmDesc">
+ The Contact API related error object.
+ </td></tr></table><div><em>No exceptions.</em></div><div><em>Return type: </em><code><a>void</a></code></div></dd></dl></div>
+ <div class="section" id="event-handler-attributes-1">
+ <h4><span class="secno">4.10.2 </span>
+ Event Handler Attributes
+ </h4>
+ <p>
+ The following is the <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a> (and its corresponding <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a>) that <em title="must" class="rfc2119">must</em> be
+ supported as a DOM attribute by the <a href="#contacterrorcb-interface"><code>ContactErrorCB</code></a> object.
+ </p>
+ <table class="simple">
+ <thead>
+ <tr>
+ <th>
+ <a class="internalDFN" href="#dfn-event-handler-attribute">event handler attribute</a>
+ </th>
+ <th>
+ <a class="internalDFN" href="#dfn-event-handler-event-type">event handler event type</a>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <strong><code><strong>onerror</strong></code></strong>
+ </td>
+ <td>
+ <code>error</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="section" id="contacterror-interface">
+ <h3><span class="secno">4.11 </span>
+ <a class="idlType" href="#idl-def-ContactError"><code>ContactError</code></a> interface
+ </h3>
+ <p>
+ The <a href="#contacterror-interface"><code>ContactError</code></a> interface encapsulates all errors in the manipulation of <a href="#contact-interface"><code>Contact</code></a> objects in the Contacts API.
+ </p>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactError">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactError</span> {
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-UNKNOWN_ERROR">UNKNOWN_ERROR</a></span> = <span class="idlConstValue">0</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-INVALID_ARGUMENT_ERROR">INVALID_ARGUMENT_ERROR</a></span> = <span class="idlConstValue">1</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-TIMEOUT_ERROR">TIMEOUT_ERROR</a></span> = <span class="idlConstValue">2</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PENDING_OPERATION_ERROR">PENDING_OPERATION_ERROR</a></span> = <span class="idlConstValue">3</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-IO_ERROR">IO_ERROR</a></span> = <span class="idlConstValue">4</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-NOT_SUPPORTED_ERROR">NOT_SUPPORTED_ERROR</a></span> = <span class="idlConstValue">5</span>;</span>
+<span class="idlConst"> const <span class="idlConstType"><a>unsigned short</a></span> <span class="idlConstName"><a href="#widl-ContactError-PERMISSION_DENIED_ERROR">PERMISSION_DENIED_ERROR</a></span> = <span class="idlConstValue">20</span>;</span>
+<span class="idlAttribute"> readonly attribute <span class="idlAttrType"><a>unsigned short</a></span> <span class="idlAttrName"><a href="#widl-ContactError-code">code</a></span>;</span>
+};</span>
+</pre><div class="section" id="attributes-7"><h4><span class="secno">4.11.1 </span>Attributes</h4><dl class="attributes"><dt id="widl-ContactError-code"><code>code</code> of type <span class="idlAttrType"><a>unsigned short</a></span>, readonly</dt><dd>
+ An error code assigned by an implementation when an error has occurred in Contacts API processing.
+ <div><em>No exceptions.</em></div></dd></dl></div><div class="section" id="constants"><h4><span class="secno">4.11.2 </span>Constants</h4><dl class="constants"><dt id="widl-ContactError-INVALID_ARGUMENT_ERROR"><code>INVALID_ARGUMENT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An invalid parameter was provided when the requested method was invoked.
+ </dd><dt id="widl-ContactError-IO_ERROR"><code>IO_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An error occurred in communication with the underlying implementation that meant the requested method could not complete.
+ </dd><dt id="widl-ContactError-NOT_SUPPORTED_ERROR"><code>NOT_SUPPORTED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method is not supported by the current implementation.
+ </dd><dt id="widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ If the <a class="internalDFN" href="#dfn-user-agent">user agent</a> is currently waiting for a callback on a current find() operation, as defined in this specification.
+ </dd><dt id="widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ Access to the requested method was denied at the implementation or by the user.
+ </dd><dt id="widl-ContactError-TIMEOUT_ERROR"><code>TIMEOUT_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ The requested method timed out before it could be completed.
+ </dd><dt id="widl-ContactError-UNKNOWN_ERROR"><code>UNKNOWN_ERROR</code> of type <span class="idlConstType"><a>unsigned short</a></span></dt><dd>
+ An unknown error occurred.
+ </dd></dl></div>
+ </div>
+ </div>
+ <!-- end api description section -->
+ <div class="section" id="contact-search-processing">
+ <!--OddPage--><h2><span class="secno">5. </span>
+ <a>Contact Search Processing</a>
+ </h2>
+ <p>
+ The <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method provides an operation to search for one of more <a href="#contact-interface"><code>Contact</code></a> objects within the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <div class="section" id="search-qualifiers">
+ <h3><span class="secno">5.1 </span>
+ Search Qualifiers
+ </h3>
+ <p>
+ The <dfn id="dfn-search-qualifier">search qualifier</dfn> provides an application with a way to request the specific subset of <a href="#contact-interface"><code>Contact</code></a> properties it wishes to obtain in any resulting successful callback. The
+ <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is deployed to minimize the data that needs to be shared with an application in order to let that
+ application fulfill its function on behalf of the user. The <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> is included within a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation as the <code>filter</code> parameter.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> <em title="must" class="rfc2119">must</em> be specified from a requesting application as a part of any <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ If the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must not" class="rfc2119">must not</em> return any <a href="#contact-interface"><code>Contact</code></a> properties within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ In the case that the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided is of <em>non-zero-length</em> then the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return only the matching <a href="#contact-interface"><code>Contact</code></a> properties within any resulting <a href="#contact-interface"><code>Contact</code></a> object(s).
+ </p>
+ <p>
+ If a provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> element (<code>filter[x]</code>) does not match a <a href="#contact-interface"><code>Contact</code></a> attribute, <code>filter[x]</code> <em title="should" class="rfc2119">should</em> be ignored when executing the
+ current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <div class="section" id="advanced-search-qualifiers">
+ <h4><span class="secno">5.1.1 </span>
+ Advanced Search Qualifiers
+ </h4>
+ <p>
+ We call <dfn id="dfn-composed-attributes">composed attributes</dfn> <a href="#contact-interface"><code>Contact</code></a> attributes of types <code>object</code>, <code>sequence</code>,
+ <code>array</code> or <code>any</code> which contain information only available only through child attributes of that object.
+ </p>
+ <p>
+ A requesting application <em title="must" class="rfc2119">must</em> be able to request both the full composed <a href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts of a composed <a href="#contact-interface"><code>Contact</code></a> attribute in the <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ For example, the <code>name</code> attribute of a <a href="#contact-interface"><code>Contact</code></a> object is defined to be of composed type <a href="#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may request either the full
+ composed attribute (i.e. <code>name</code>) or specific individual attributes of this composed attribute (i.e.
+ <code>name.formatted</code>, <code>name.familyName</code>, <code>name.givenName</code>, <code>name.middleName</code>,
+ <code>name.honorificPrefix</code>, <code>name.honorificSuffix</code>) as part of a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation's <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>.
+ </p>
+ <p>
+ In the case that a composed <a href="#contact-interface"><code>Contact</code></a> attribute is defined as a sequence or array of composed objects, specific
+ individual attributes can be referenced by using the composed attribute name, a dot (<code>.</code>) character and the
+ individual attribute to be retrieved.
+ </p>
+ <p>
+ For example, the <code>addresses</code> attribute of <a href="#contact-interface"><code>Contact</code></a> allows multiple <a href="#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request individual attributes of
+ this composed attribute an application would request e.g. <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ </p>
+ </div>
+ <div class="example">
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="sh_javascript sh_sourceCode">
+ navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'emails.value'</span><span class="sh_symbol">,</span> <span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'friends'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>j <span class="sh_keyword">in</span> contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">)</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>emails<span class="sh_symbol">[</span>j<span class="sh_symbol">]);</span>
+ <span class="sh_cbracket">}</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+</pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol class="rule">
+ <li>
+ Return only the valid <a href="#contact-interface"><code>Contact</code></a> attributes requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>emails.value</code> - <code>friends</code> is not a valid <a href="#contact-interface"><code>Contact</code></a> attribute so ignore this element).
+ </li>
+ </ol>
+ </div>
+ </div>
+ <div class="section" id="options-processing">
+ <h3><span class="secno">5.2 </span>
+ Options Processing
+ </h3>
+ <div class="section" id="search-cardinality">
+ <h4><span class="secno">5.2.1 </span>
+ Search Cardinality
+ </h4>
+ <p>
+ By default, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence or a single <a href="#contact-interface"><code>Contact</code></a> object, accessible as part of the sequence returned in the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+ <p>
+ If a <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation and its <code>multiple</code> attribute is set to <code>true</code>, the <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation <em title="must" class="rfc2119">must</em> return either an empty sequence, a single <a href="#contact-interface"><code>Contact</code></a> object or <var>[X]</var> number of <a href="#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> callback function.
+ </p>
+ </div>
+ <div class="section" id="search-filters">
+ <h4><span class="secno">5.2.2 </span>
+ Search Filters
+ </h4>
+ <p>
+ A <dfn id="dfn-search-filter">search filter</dfn> <em title="may" class="rfc2119">may</em> be specified from a requesting web application to initially filter the Contacts database to a
+ more specific set of <a href="#contact-interface"><code>Contact</code></a> objects in which it is interested. The <a class="internalDFN" href="#dfn-search-filter">search filter</a> is included as
+ the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object provided to a <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-search-filter">search filter</a> is used to search <a href="#contact-interface"><code>Contact</code></a> attributes within the <a href="#contacts-interface"><code>Contacts</code></a> database and represents the logical union, or <code>∪</code>, of
+ provided values that are matched therein.
+ </p>
+ <p>
+ All contact searching <em title="must" class="rfc2119">must</em> apply a <dfn id="dfn-loose-matching-policy">loose-matching policy</dfn> to the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided. If an attribute being
+ searched in a <a href="#contact-interface"><code>Contact</code></a> object, stored within the <a href="#contacts-interface"><code>Contacts</code></a> database, is a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> of the input
+ <code>filter</code> value, that <a href="#contact-interface"><code>Contact</code></a> object <em title="must" class="rfc2119">must</em> be returned as part of the resulting <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>.
+ </p>
+ <p>
+ A conforming implementation <em title="must" class="rfc2119">must</em> only allow the provided <a class="internalDFN" href="#dfn-search-filter">search filter</a> to be applied to fields requested in the provided
+ <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>. The <code>id</code> attribute <em title="must" class="rfc2119">must</em> always be implicitly searchable from any requesting web application
+ regardless of whether it has been included as part of any provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>. For example, if the given <a class="internalDFN" href="#dfn-search-qualifier">search
+ qualifier</a> contains 'name' and 'displayName', then the <a class="internalDFN" href="#dfn-rules-for-processing-search-filters">rules for processing search filters</a> should
+ only be applied to all sub-fields of the <code>name</code> attribute (i.e. <code>name.formatted</code>,
+ <code>name.firstName</code>, <code>name.givenName</code>, <code>name.middleName</code>, <code>name.honorificPrefix</code>,
+ <code>name.honorificSuffix</code>), the <code>displayName</code> attribute and the <code>id</code> attribute.
+ </p>
+ <p>
+ A <dfn id="dfn-partial-value-match">partial value match</dfn> refers to both syntactic and semantic partial matching of an input filter value with a
+ corresponding value in the address book and denotes that a corresponding match was found in the address book that begins with,
+ contains or ends with the value of the input filter value, or any variation thereof.
+ </p>
+ <p>
+ Comparing two strings in a <dfn id="dfn-compatibility-caseless">compatibility caseless</dfn> manner means using the Unicode <em>compatibility caseless
+ match</em> operation to compare the two strings. [<cite><a href="#bib-UNICODE" rel="biblioentry" class="bibref">UNICODE</a></cite>]
+ </p>
+ <p>
+ A <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a> <em title="must" class="rfc2119">must</em> use the <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner in which to match against corresponding values
+ in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ </p>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-rules-for-processing-search-filters">rules for processing search filters</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the <code>filter</code> attribute of the <a href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> parameter provided within the current <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> operation.
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="contactsets">contactsets</var> be initially the set of all known contacts in the <a href="#contacts-interface"><code>Contacts</code></a> database.
+ <p>
+ Let <var title="contactsresult">contactsresult</var> be initially an empty Array object.
+ </p>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is a DOMString object
+ </dt>
+ <dd>
+ <ol class="rule">
+ <li>
+ Let <var title="contactset">contactset</var> be the next enumerable Object in <var title="contactsets">contactsets</var>. If there is no next enumerable Object, go to step 5.
+ </li>
+ <li>
+ Let <var title="partialMatchFound">partialMatchFound</var> be the result of applying the <a class="internalDFN" href="#dfn-partial-matching-algorithm">partial matching algorithm</a>,
+ providing <var title="filter">filter</var> and <var title="contactset">contactset</var> as inputs.
+ </li>
+ <li>
+ If <var title="partialMatchFound">partialMatchFound</var> is <code>true</code>, add <var title="contactset">contactset</var> to <var title="contactsresult">contactsresult</var>.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Return <var title="contactsresult">contactsresult</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="filter">filter</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <var title="contactsets">contactsets</var>.
+ </p>
+ </dd>
+ </dl>
+ <p>
+
+ </p>
+ <p>
+ The <dfn id="dfn-partial-matching-algorithm">partial matching algorithm</dfn> is defined below and is always provided with a <var title="filter">filter</var> parameter, representing the input string to compare; and a <var title="contactset">contactset</var> parameter, representing an individual <a href="#contact-interface"><code>Contact</code></a> object:
+ </p>
+ <dl class="switch">
+ <dt>
+
+ </dt>
+ <dd>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be initially set to <code>false</code>.
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is an Object object
+ </dt>
+ <dd>
+ <ol class="rule">
+ <li>
+ Let <var title="elementvalue">elementvalue</var> be the String value of the next enumerable property in <var title="contactset">contactset</var>. If there are no more enumerable properties, go to step 5.
+ </li>
+ <li>
+ Let <var title="hasPartialMatch">hasPartialMatch</var> be the boolean result for the comparison of <var title="filter">filter</var> with <var title="elementvalue">elementvalue</var> in a <a class="internalDFN" href="#dfn-compatibility-caseless">compatibility caseless</a> manner and with a <a class="internalDFN" href="#dfn-partial-value-match">partial value match</a>
+ policy applied to both sides of the comparison operation.
+ </li>
+ <li>
+ If <var title="hasPartialMatch">hasPartialMatch</var> is <code>true</code>, go to step 5.
+ </li>
+ <li>
+ Go to step 1.
+ </li>
+ <li>
+ Return <var title="hasPartialMatch">hasPartialMatch</var>.
+ </li>
+ </ol>
+ </dd>
+ <dt>
+ If <var title="contactset">contactset</var> is another native object type
+ </dt>
+ <dd>
+ <p>
+ Return <code>false</code>.
+ </p>
+ </dd>
+ </dl>
+ <div class="example">
+ <p>
+ The following Contact search is initiated:
+ </p>
+<pre class="sh_javascript sh_sourceCode"> navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.locality'</span><span class="sh_symbol">,</span> <span class="sh_string">'addresses.country'</span><span class="sh_symbol">,</span> <span class="sh_string">'phoneNumbers'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ <span class="sh_keyword">function</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span>x <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>x<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>
+ filter<span class="sh_symbol">:</span> <span class="sh_string">'Robert'</span>
+ <span class="sh_cbracket">}</span><span class="sh_symbol">);</span>
+
+</pre>
+ <p>
+ The above example logically implies:
+ </p>
+ <ol class="rule">
+ <li>
+ Using ECMA-262 3rd Edition regular expression syntax and pseudo-code, the <a class="internalDFN" href="#dfn-search-filter">search filter</a> provided can be represented
+ as:
+<pre>( name.formatted = /∧.*Robert.*$/i ) ∪ ( phoneNumbers.value = /∧.*Robert.*$/i )
+∪ ( emails.value = /∧.*Robert.*$/i ) ∪ ( name.familyName = /∧.*Robert.*$/i )
+∪ ( name.givenName = /∧.*Robert.*$/i ) ∪ ( name.middleName = /∧.*Robert.*$/i )
+∪ ( addresses.country = /∧.*Robert.*$/i ) ∪ ( addresses.locality = /∧.*Robert.*$/i )
+∪ ( phoneNumbers.type = /∧.*Robert.*$/i ) ∪ ( emails.type = /∧.*Robert.*$/i )
+∪ ( id = /∧.*Robert.*$/i )
+</pre>
+ <br>
+ All searches are case-insensitive and apply a <a class="internalDFN" href="#dfn-loose-matching-policy">loose-matching policy</a> as defined in <a href="#search-filters">Search Filters</a>.<br>
+ <br>
+ As noted in <a href="#search-filters">Search Filters</a>, the <code>id</code> attribute is implicitly appended along with any <a class="internalDFN" href="#dfn-search-filter">search
+ filter</a> attributes provided, regardless of whether it was provided as a <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a> from the requesting
+ application.<br>
+ <br>
+ </li>
+ <li>
+ Return only the valid <a href="#contact-interface"><code>Contact</code></a> properties requested in the provided <a class="internalDFN" href="#dfn-search-qualifier">search qualifier</a>
+ (<code>name</code>, <code>addresses.locality</code>, <code>addresses.country</code>, <code>phoneNumbers</code>,
+ <code>emails</code>) and only for the <a href="#contact-interface"><code>Contact</code></a> objects returned from the <a class="internalDFN" href="#dfn-rules-for-processing-search-filters">rules for processing search filters</a>
+ with the <a class="internalDFN" href="#dfn-search-filter">search filter</a> derived in step 1 provided as the <var>filter</var> input parameter.
+ </li>
+ </ol>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="section" id="extended-contact-properties-and-parameters">
+ <!--OddPage--><h2><span class="secno">6. </span>
+ Extended Contact Properties and Parameters
+ </h2>
+ <p>
+ The properties and parameters defined on the <a href="#contact-interface"><code>Contact</code></a> interface <em title="may" class="rfc2119">may</em> be extended by implementors of this specification.
+ </p>
+ <p>
+ Non-standard, private properties and parameters <em title="should" class="rfc2119">should</em> have a prefixed name starting with <code>X</code> (U+0058 LATIN CAPTIAL
+ LETTER X) or use a vendor-specific prefix. Extended properties and parameters can be defined bilaterally between <a class="internalDFN" href="#dfn-user-agent" title="user agent">user agents</a> without outside registration or standardization.
+ </p>
+ <p>
+ It is <em title="recommended" class="rfc2119">recommended</em> that authors define both a formal vCard grammar [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] and a WebIDL grammar [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>] for their proposed
+ extension to ensure interoperability between vCard databases and other non-standard Contact databases and formats. It is also
+ <em title="recommended" class="rfc2119">recommended</em> that authors provide documentation of their extension properties and parameters within the public domain.
+ </p>
+ <div class="example">
+ <p>
+ A new parameter is required by Company X to provide information related to a user's accounts registered across different
+ networks and services.
+ </p>
+ <p>
+ The [<cite><a href="#bib-WEBIDL" rel="biblioentry" class="bibref">WEBIDL</a></cite>] syntax for this parameter is defined as follows:
+ </p>
+ <pre class="idl"><span class="idlImplements"><a class="idlType" href="#idl-def-Contact"><code>Contact</code></a> implements <a class="idlType" href="#idl-def-ContactExtended"><code>ContactExtended</code></a>;</span></pre><div class="idlImplementsDesc">
+
+ </div>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactExtended">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactExtended</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a>[]</span> <span class="idlAttrName"><a href="#widl-ContactExtended-Xaccounts">Xaccounts</a></span>;</span>
+};</span>
+</pre><div class="section"><h3 id="attributes-8">Attributes</h3><dl class="attributes"><dt id="widl-ContactExtended-Xaccounts"><code>Xaccounts</code> of type array of <span class="idlAttrType"><a class="idlType" href="#idl-def-ContactAccount"><code>ContactAccount</code></a></span></dt><dd>
+ One or more user accounts. See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.2.2. <code>accounts</code>].
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ <pre class="idl"><span class="idlInterface" id="idl-def-ContactAccount">[<span class="extAttr">NoInterfaceObject</span>]
+interface <span class="idlInterfaceID">ContactAccount</span> {
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-domain">domain</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-username">username</a></span>;</span>
+<span class="idlAttribute"> attribute <span class="idlAttrType"><a>DOMString</a></span> <span class="idlAttrName"><a href="#widl-ContactAccount-userid">userid</a></span>;</span>
+};</span>
+</pre><div class="section"><h3 id="attributes-9">Attributes</h3><dl class="attributes"><dt id="widl-ContactAccount-domain"><code>domain</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>domain</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-userid"><code>userid</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>userid</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd><dt id="widl-ContactAccount-username"><code>username</code> of type <span class="idlAttrType"><a>DOMString</a></span></dt><dd>
+ <p>
+ See [[<cite><a href="#bib-POCO-SCHEMA" rel="biblioentry" class="bibref">POCO-SCHEMA</a></cite>] Section 7.6. <code>username</code>].
+ </p>
+ <div><em>No exceptions.</em></div></dd></dl></div>
+ <p>
+ The corresponding vCard [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] notation for this parameter is defined as follows:
+ </p>
+<pre> The following ABNF grammar extends the grammar found in [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>] (Section 4).
+
+ <strong>X-ACCOUNT</strong>
+
+ Purpose: To specify the components of the accounts for the vCard
+ object.
+
+ Value type: A single structured text value, separated by the SEMI-
+ COLON character (ASCII decimal 59).
+
+ Cardinality: (0,n)
+
+ Special notes: The structured type value consists of a sequence of
+ account components. The component values must be specified in
+ their corresponding position. The structured type value
+ corresponds, in sequence, to the domain; the username; the userid.
+ When a component value is missing, the associated component
+ separator must still be specified.
+
+ The text components are separated by the SEMI-COLON character
+ (ASCII decimal 59).
+
+ ABNF:
+
+ X-ACCOUNT-param = ; no parameter allowed
+ X-ACCOUNT-value = list-component 3(";" list-component)
+</pre>
+ <p>
+ This parameter will be used within the Contacts API as follows:
+ </p>
+<pre class="sh_javascript sh_sourceCode"> <span class="sh_keyword">var</span> contact <span class="sh_symbol">=</span> <span class="sh_symbol">...;</span> <span class="sh_comment">// ...obtain individual contact object</span>
+ <span class="sh_keyword">for</span><span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>domain<span class="sh_symbol">);</span> <span class="sh_comment">// thesocialnetwork.com</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>username<span class="sh_symbol">);</span> <span class="sh_comment">// null</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>contact<span class="sh_symbol">.</span>Xaccounts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>userid<span class="sh_symbol">);</span> <span class="sh_comment">// 344aesq2</span>
+ <span class="sh_cbracket">}</span>
+</pre>
+ <p>
+ This parameter will be used within the vCard format [<cite><a href="#bib-RFC2426" rel="biblioentry" class="bibref">RFC2426</a></cite>]] as follows:
+ </p>
+<pre> X-ACCOUNT;thesocialnetwork.com;;344aesq2
+</pre>
+ </div>
+ </div>
+ <div id="api-invocation-via-dom-events" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">A. </span>API Invocation via DOM Events</h2><p><em>This section is non-normative.</em></p>
+
+ <p>The API contained in this document can be invoked either programmatically (for example, inline within a general script) or
+ resulting from the <a class="internalDFN" href="#dfn-interaction-of-a-user">interaction of a user</a>.</p>
+
+<p>The <dfn id="dfn-interaction-of-a-user">interaction of a user</dfn> is when a user invokes the API from an
+<a href="http://dev.w3.org/html5/markup/elements.html"><code>HTMLElement</code></a> [<cite><a href="#bib-HTML5" rel="biblioentry" class="bibref">HTML5</a></cite>] within the current
+<a class="internalDFN" href="#dfn-browsing-context">browsing context</a> via a <a class="internalDFN" href="#dfn-valid-auto-invocation-event">valid auto-invocation event</a>.</p>
+
+<p>A <dfn id="dfn-valid-auto-invocation-event">valid auto-invocation event</dfn> includes any of the following event types, as defined in [<cite><a href="#bib-DOM-LEVEL-3-EVENTS" rel="biblioentry" class="bibref">DOM-LEVEL-3-EVENTS</a></cite>]:</p>
+
+<ul>
+ <li><code>click</code></li>
+ <li><code>dblclick</code></li>
+ <li><code>mouseup</code></li>
+</ul>
+
+<p>The <code>find()</code> method on <a href="#contacts-interface"><code>Contacts</code></a> should, if the method was invoked
+by an <a class="internalDFN" href="#dfn-interaction-of-a-user">interaction of a user</a> (as opposed to having been created and executed in general script), display the
+<a class="internalDFN" href="#dfn-contact-picker-1">Contact Picker</a> directly.</p>
+
+
+ </div>
+
+ <div id="user-interaction-guidelines" class="informative appendix section">
+ <!--OddPage--><h2><span class="secno">B. </span>
+ User Interaction Guidelines
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the contact information that may
+ be shared from their unified address book. This annex provides some examples of a conformant user experience that this
+ specification enables.
+ </p>
+ <div class="section" id="sharing-contact-information---example--1">
+ <h3><span class="secno">B.1 </span>
+ Accessing Contact Information - Example #1
+ </h3>
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+ <div class="example">
+<pre class="sh_javascript sh_sourceCode"> <span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+<span class="sh_cbracket">}</span>
+
+<span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+<span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span>
+
+<span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+</pre>
+ </div>
+ <p>
+ As a result of executing this code, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a non-blocking <dfn id="dfn-contact-search-notification">contact search notification</dfn> as
+ follows:
+ </p>
+ <p align="center">
+ <img src="contacts_notification.png" alt="Contact Search Notification"><br>
+ (<a href="contacts_notification.png">View as PNG</a>)
+ </p>
+ <p>
+ If an additional find() operation is called by the current web application before the user has clicked 'Select' or
+ 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that operation was defined with a
+ non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current find() operation, will be
+ invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may provide a <dfn id="dfn-contact-picker">contact picker</dfn>, utilizing all of the
+ parameters provided in the find() operation as follows:
+ </p>
+ <p align="center">
+ <img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is requesting and the option to select
+ one or more contacts (as appropriate) from the user interface.
+ </p>
+ <p>
+ If an additional find() operation is called by the current web application before the user has clicked 'Select' or
+ 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that operation was defined with a
+ non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current find() operation, will be
+ invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> associated to the current find() operation will be invoked with
+ the contact information selected by the user provided as the only parameter.
+ </p>
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the user should easily
+ be able to review and revoke permissions to web applications at a later date.
+ </p>
+ </div>
+
+ <div class="section" id="sharing-contact-information---example--2">
+ <h3><span class="secno">B.2 </span>
+ Accessing Contact Information - Example #2
+ </h3>
+ <p>
+ A website requests access to a user's address book with the following code:
+ </p>
+ <div class="example">
+<pre class="sh_javascript sh_sourceCode"><span class="sh_symbol"><</span>input type<span class="sh_symbol">=</span><span class="sh_string">"button"</span> value<span class="sh_symbol">=</span><span class="sh_string">"Share Contacts"</span> onclick<span class="sh_symbol">=</span><span class="sh_string">"getContacts()"</span> <span class="sh_symbol">/></span>
+
+<span class="sh_symbol"><</span>script type<span class="sh_symbol">=</span><span class="sh_string">"text/javascript"</span><span class="sh_symbol">></span>
+ <span class="sh_keyword">function</span> <span class="sh_function">successContactFindCallback</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting contact objects</span>
+ <span class="sh_keyword">for</span> <span class="sh_symbol">(</span><span class="sh_keyword">var</span> i <span class="sh_keyword">in</span> contacts<span class="sh_symbol">)</span> <span class="sh_function">alert</span><span class="sh_symbol">(</span>contacts<span class="sh_symbol">[</span>i<span class="sh_symbol">].</span>name<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">generalErrorCB</span><span class="sh_symbol">(</span>error<span class="sh_symbol">)</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// do something with resulting errors</span>
+ <span class="sh_function">alert</span><span class="sh_symbol">(</span>error<span class="sh_symbol">.</span>code<span class="sh_symbol">);</span>
+ <span class="sh_comment">// ...</span>
+ <span class="sh_cbracket">}</span>
+
+ <span class="sh_keyword">function</span> <span class="sh_function">getContacts</span><span class="sh_symbol">()</span> <span class="sh_cbracket">{</span>
+ <span class="sh_comment">// Perform an address book search. Obtain the 'name' and 'emails' properties </span>
+ <span class="sh_comment">// and initially filter the list to Contact records containing 'Bob':</span>
+ navigator<span class="sh_symbol">.</span>service<span class="sh_symbol">.</span>contacts<span class="sh_symbol">.</span><span class="sh_function">find</span><span class="sh_symbol">([</span><span class="sh_string">'name'</span><span class="sh_symbol">,</span> <span class="sh_string">'emails'</span><span class="sh_symbol">],</span>
+ successContactFindCallback<span class="sh_symbol">,</span>
+ generalErrorCB<span class="sh_symbol">,</span>
+ <span class="sh_cbracket">{</span>filter<span class="sh_symbol">:</span> <span class="sh_string">'Bob'</span><span class="sh_cbracket">}</span>
+ <span class="sh_symbol">);</span>
+ <span class="sh_cbracket">}</span>
+<span class="sh_symbol"></</span>script<span class="sh_symbol">></span>
+</pre>
+ </div>
+ <p>
+ This code may render as follows within the <a class="internalDFN" href="#dfn-user-agent">user agent</a>:
+ </p>
+ <p align="center">
+ <img src="contacts_element.png" alt="Contact Search via DOM Events"><br>
+ (<a href="contacts_element.png">View as PNG</a>)
+ </p>
+ <p>
+ If the user clicks on the rendered button element then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> may directly provide a <dfn id="dfn-contact-picker-1">contact picker</dfn>, as defined in
+ <a href="#api-invocation-via-dom-events">API Invocation via DOM Events</a>, utilizing all of the
+ parameters provided in the <code>find()</code> operation as follows:
+ </p>
+ <p align="center">
+ <img src="contacts_picker.png" alt="Contact Picker"><br>
+ (<a href="contacts_picker.png">View as PNG</a>)
+ </p>
+ <p>
+ In this dialog, the user is provided with a summary of the sharing that the application is requesting and the option to select
+ one or more contacts (as appropriate) from the user interface.
+ </p>
+ <p>
+ If an additional find() operation is called by the current web application before the user has clicked 'Select' or
+ 'Cancel' on the current notification, an error will be invoked with a code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that operation was defined with a
+ non-<code>null</code> <code>errorCB</code> parameter.
+ </p>
+ <p>
+ If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current find() operation, will be
+ invoked with an error code of <a href="#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
+ </p>
+ <p>
+ If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a> associated to the current find() operation will be invoked with
+ the contact information selected by the user provided as the only parameter.
+ </p>
+ <p>
+ Further to this initial sharing of Contact information, the <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the user should easily
+ be able to review and revoke permissions to web applications at a later date.
+ </p>
+ </div>
+
+ </div>
+ <div class="appendix section" id="references"><!--OddPage--><h2><span class="secno">C. </span>References</h2><div class="section" id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-CORE-DEVICE">[CORE-DEVICE]</dt><dd>Robin Berjon. <a href="http://dev.w3.org/2009/dap/device/"><cite>Core Device Interfaces.</cite></a> 02 December 2009. W3C Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/device/">http://dev.w3.org/2009/dap/device/</a>
+</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2010/WD-html5-20100304/"><cite>HTML 5.</cite></a> 4 March 2010. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2010/WD-html5-20100304/">http://www.w3.org/TR/2010/WD-html5-20100304/</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-UNICODE">[UNICODE]</dt><dd>The Unicode Consortium. <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html"><cite>The Unicode Standard.</cite></a> 2003. Defined by: The Unicode Standard, Version 4.0 (Boston, MA, Addison-Wesley, ISBN 0-321-18578-1), as updated from time to time by the publication of new versions URL: <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html">http://www.unicode.org/unicode/standard/versions/enumeratedversions.html</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219"><cite>Web IDL.</cite></a> 19 December 2008. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219">http://www.w3.org/TR/2008/WD-WebIDL-20081219</a>
+</dd></dl></div><div class="section" id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><dl class="bibliography"><dt id="bib-CONTACTS-WRITER-API">[CONTACTS-WRITER-API]</dt><dd>R. Tibbett. <a href="http://dev.w3.org/2009/dap/contacts/Writer.html"><cite>Contacts Writer API</cite></a>. 3rd August 2010. W3C Latest Editor's Draft. (Work in progress.) URL: <a href="http://dev.w3.org/2009/dap/contacts/Writer.html">http://dev.w3.org/2009/dap/contacts/Writer.html</a>
+</dd><dt id="bib-DOM-LEVEL-3-EVENTS">[DOM-LEVEL-3-EVENTS]</dt><dd>Björn Höhrmann; Tom Pixley; Philippe Le Hégaret. <a href="http://www.w3.org/TR/2007/WD-DOM-Level-3-Events-20071221"><cite>Document Object Model (DOM) Level 3 Events Specification.</cite></a> 21 December 2007. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2007/WD-DOM-Level-3-Events-20071221">http://www.w3.org/TR/2007/WD-DOM-Level-3-Events-20071221</a>
+</dd><dt id="bib-POCO-SCHEMA">[POCO-SCHEMA]</dt><dd>Joseph Smarr. <a href="http://portablecontacts.net/draft-spec.html#schema"><cite>Portable Contacts 1.0 Draft C: Contact Schema</cite></a> 5 August 2008. URL: <a href="http://portablecontacts.net/draft-spec.html#schema">http://portablecontacts.net/draft-spec.html#schema</a>
+</dd><dt id="bib-RFC2426">[RFC2426]</dt><dd>F. Dawson, T. Howes. <a href="http://www.ietf.org/rfc/rfc2426.txt"><cite>vCard MIME Directory Profile.</cite></a> September 1998. URL: <a href="http://www.ietf.org/rfc/rfc2426.txt">http://www.ietf.org/rfc/rfc2426.txt</a>
+</dd><dt id="bib-WIDGETS">[WIDGETS]</dt><dd>Marcos Caceres. <a href="http://www.w3.org/TR/2009/CR-widgets-20091201/"><cite>Widget Packaging and Configuration.</cite></a> 01 December 2009. W3C Candidate Recommendation. (Work in progress.) URL: <a href="http://www.w3.org/TR/2009/CR-widgets-20091201/">http://www.w3.org/TR/2009/CR-widgets-20091201/</a>
+</dd></dl></div></div></body></html>
\ No newline at end of file
Binary file contacts/WD3/contacts_element.png has changed
Binary file contacts/WD3/contacts_notification.png has changed
Binary file contacts/WD3/contacts_picker.png has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/contacts/Writer.html Fri Oct 21 11:56:02 2011 +0200
@@ -0,0 +1,612 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>
+ Contacts Writer API
+ </title>
+ <meta
+ http-equiv='Content-Type'
+ content='text/html;charset=utf-8'>
+<script
+ type="text/javascript"
+ src='../ReSpec.js/js/respec.js'
+ class='remove'>
+</script>
+<script
+ type="text/javascript"
+ src='../ReSpec.js/js/sh_main.min.js'
+ class='remove'>
+</script>
+<script
+ type="text/javascript"
+ class='remove'>
+ var respecConfig = {
+ specStatus: "ED",
+ shortName: "contacts-api",
+ editors: [{name: "Richard Tibbett", company: "Opera Software ASA"}],
+ //publishDate: "2010-07-01",
+ // previousPublishDate: "2010-01-21",
+ edDraftURI: "http://dev.w3.org/2009/dap/contacts/Writer.html",
+ // lcEnd: "2009-08-05",
+ };
+</script>
+<script
+ type="text/javascript"
+ src='../common/config.js'
+ class='remove'>
+
+</script>
+ </head>
+ <body>
+ <section
+ id='abstract'>
+ <p>
+ The Contacts Writer API defines the high-level interfaces required to add and remove contact information to and from a user's
+ unified address book.
+ </p>
+ <p>
+ This specification is built on top of an accompanying specification [[CONTACTS-API]] that enables read access to a user's
+ unified address book.
+ </p>
+ <p class="issue">
+ Interesting summary of the general issues with a Writer API in the web context:
+ <a href="http://lists.w3.org/Archives/Public/public-device-apis/2010Jul/0112.html">http://lists.w3.org/Archives/Public/public-device-apis/2010Jul/0112.html</a>
+
+ </p>
+
+ </section>
+ <section
+ id='sotd'>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed Contacts API. Issues and
+ editors note in the document highlight some of the points on which the group is still working and would particularly like to get
+ feedback.
+ </p>
+ </section>
+ <section
+ id='conformance'>
+ <p>
+ This specification defines conformance criteria that apply to a single product: the <dfn>user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent
+ with the ECMAScript Bindings defined in the Web IDL specification [[!WEBIDL]], as this specification uses that specification and
+ terminology.
+ </p>
+ </section>
+ <section
+ class="informative">
+ <h2>
+ Introduction
+ </h2>
+ <p>
+ Every operating system and a large number of web-based service providers have different ways of representing address book
+ information. Most users are required to maintain a plurality of contact lists which leads to multiple copies of address book data.
+ The multiplicity of address books that a user is required to maintain often leads to disjointed and inconsistent information being
+ stored across a user's address book providers.
+ </p>
+ <p>
+ Providing address book information to these service providers means handing over all of your data and trusting these providers with
+ the security and privacy of storing and sharing of your information. When sharing this data with 3rd parties users are, more often
+ than not, required to hand over access to their whole address book. Users are implicitly required to trust 3rd parties with all of
+ their data when, in reality, the user may only wish, or need, to share a subset of their address book information so that an
+ application can fulfill its purpose.
+ </p>
+ <p>
+ This specification defines the concept of a user's unified address book - where address book data may be sourced from a
+ plurality of sources - both online and locally. This specification then defines the interfaces on which 3rd party applications can
+ access a user's unified address book; with explicit user permission and filtering. The focus of this data sharing is on making
+ the user aware of the data that they will share and putting them at the centre of the data sharing process; free to select both the
+ extent to which they share their address book information and the ability to restrict which pieces of information related to which
+ contact gets shared.
+ </p>
+ <p>
+ The API itself is agnostic of any underlying address book sources and storage. A conforming implementation is required to implement
+ all fields defined in this specification.
+ </p>
+ <section>
+ <h2>
+ Usage Examples
+ </h2>
+ <p>
+ The following code extracts illustrate how to search, add, remove and update contact information in a given address book:
+ </p>
+ <div>
+ <p>
+ Creating a new contact.
+ </p>
+ </div>
+<pre
+ class='example sh_javascript_dom'>
+// Create new contact
+var myContact = navigator.service.contacts.create({displayName: 'Robert'}});
+
+// Add additional contact attributes as required...
+// myContact.nicknames.push('bobby');
+</pre>
+ <div>
+ <p>
+ Saving a new contact in the underlying addressbook.
+ </p>
+ </div>
+<pre
+ class='example sh_javascript_dom'>
+// previous example follow-on...
+
+function successContactCallback(contact) {
+ // do something with resulting contact object
+ alert(contact.displayName);
+ // ...
+}
+
+// Save new contact
+myContact.save(successContactCallback, generalErrorCB);
+</pre>
+ <div>
+ <p>
+ Editing an existing contact.
+ </p>
+ </div>
+<pre
+ class='example sh_javascript_dom'>
+// previous example follow-on...
+
+// e.g. add a new phone number
+myContact.phoneNumbers.push({type: 'home', value: '+440000000002'});
+
+// Update existing contact
+myContact.save(successContactCallback, generalErrorCB);
+</pre>
+ <div>
+ <p>
+ Removing an existing contact.
+ </p>
+ </div>
+<pre
+ class='example sh_javascript_dom'>
+// previous example follow-on...
+
+// Remove existing contact
+myContact.remove(successContactCallback, generalErrorCB);
+</pre>
+ </section>
+ </section>
+ <section>
+ <h2>
+ Security and Privacy Considerations
+ </h2>
+ <p
+ class='note'>
+ The overall architecture for addressing privacy in DAP is still under construction. As it is finalized, there may be changes made
+ to this API to reflect requirements or support for privacy-related functionality.
+ </p>
+ <p>
+ The API defined in this specification can be used to create, find, save and remove contact information from a user's address
+ book(s). All API methods disclose information related to a user's contacts such as their phone number(s), email address(es) and
+ other personally identifying information. The distribution of this information could potentially compromise the user's privacy.
+ A conforming implementation of this specification MUST provide a mechanism that protects the user's privacy and this mechanism
+ should ensure that no contact information is creatable, retrivable, updateable or removable without the user's express
+ permission.
+ </p>
+ <section>
+ <h2>
+ Privacy considerations for implementors of the Contacts API
+ </h2>
+ <p>
+ A <a>user agent</a> must not create, find, save or delete contact information to Web sites without the express permission of the
+ user. A <a>user agent</a> must acquire permission through a user interface, unless they have prearranged trust relationships with
+ users, as described below. The user interface must include the URI of the document origin, as defined in [[HTML5]]. Those
+ permissions that are acquired through the user interface and that are preserved beyond the current browsing session (i.e. beyond
+ the time when the browsing context, as defined in [[HTML5]], is navigated to another URL) MUST be revocable and a <a>user
+ agent</a> must respect revoked permissions.
+ </p>
+ <p>
+ Obtaining the user's express permission to access one API method does not imply the user has granted permission for the same
+ Web site to access other methods provided by this API, or to access the same method with a different set of arguments, as part of
+ the same permission context. If a user has expressed permission for an implementation to, e.g. find a set of existing contacts,
+ the implementation must seek the user's express permission if and when any additional create, find, save or remove function
+ is called on this API.
+ </p>
+ <p>
+ A <a>user agent</a> may have prearranged trust relationships that do not require such user interfaces. For example, while a Web
+ browser will present a user interface when a Web site performs an address book request, a Widget Runtime MAY have a prearranged,
+ delegated security relationship with the user and, as such, a suitable alternative security and privacy mechanism with which to
+ authorize the creation, retrieval, update and/or removal of contact information.
+ </p>
+ </section>
+ <section>
+ <h2>
+ Privacy considerations for recipients of contact information
+ </h2>
+ <p>
+ Recipients MUST only request contact information when necessary. Recipients MUST only use the contact information for the task
+ for which it was provided to them. Recipients MUST dispose of contact information once that task is completed, unless expressly
+ permitted to retain it by the user. Recipients MUST also take measures to protect this information against unauthorized access.
+ If contact information is stored, users should be allowed to update and delete this information.
+ </p>
+ <p>
+ The recipient of contact information MUST not retransmit the contact information without the user's express permission. Care
+ should be taken when retransmitting and use of encryption is encouraged.
+ </p>
+ <p>
+ Recipients MUST clearly and conspicuously disclose the fact that they are collecting contact data, the purpose for the
+ collection, how long the data is retained, how the data is secured, how the data is shared if it is shared, how users can access,
+ update and delete the data, and any other choices that users have with respect to the data. This disclosure MUST include an
+ explanation of any exceptions to the guidelines listed above.
+ </p>
+ </section>
+ <section
+ class='informative'>
+ <h2>
+ Additional implementation considerations
+ </h2>
+ <p>
+ Further to the requirements listed in the previous section, implementors of the Contacts API are also advised to consider the
+ following aspects that can negatively affect the privacy of their users: in certain cases, users can inadvertently grant
+ permission to the User Agent to disclose their contacts to Web sites. In other cases, the content hosted at a certain URL changes
+ in such a way that the previously granted contact permissions no longer apply as far as the user is concerned. Or the users might
+ simply change their minds.
+ </p>
+ <p>
+ Predicting or preventing these situations is inherently difficult. Mitigation and in-depth defensive measures are an
+ implementation responsibility and not prescribed by this specification. However, in designing these measures, implementers are
+ advised to enable user awareness of contact sharing, and to provide easy access to interfaces that enable revocation of
+ permissions.
+ </p>
+ </section>
+ </section>
+ <section>
+ <h2>
+ API Description
+ </h2>
+ <section>
+ <h2>
+ <a>ContactsWriter</a> interface
+ </h2>
+ <p>
+ The <a>ContactsWriter</a> interface exposes a database collecting contacts information, such that they may be created, updated,
+ and deleted.
+ </p>
+ <dl
+ title='[NoInterfaceObject] interface ContactsWriter : Contacts'
+ class='idl'>
+ <dt>
+ Contact create ()
+ </dt>
+ <dd>
+ Create a new <code>Contact</code> object.
+ <p>
+ This method takes one argument. When called, it returns a <a
+ href='#contact-interface'><code>Contact</code></a> object.
+ </p>
+ <p>
+ The newly created <a
+ href='#contact-interface'><code>Contact</code></a> object MUST NOT be stored in the user's address book as a result of
+ calling this method. The <a
+ href='#contact-interface'><code>Contact</code></a> <a
+ href='#widl-Contact-save'>save()</a> method MUST be called on the response of this method to store the new <a
+ href='#contact-interface'><code>Contact</code></a> object in the user's address book.
+ </p>
+ <dl
+ class='parameters'>
+ <dt>
+ ContactProperties attributes
+ </dt>
+ <dd>
+ The attributes to assign to the resulting object.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+ <section>
+ <h2>
+ <a>ContactWriter</a> interface
+ </h2>
+ <p>
+ The <a
+ href="#contact-interface"><code>ContactWriter</code></a> interface captures a single contact item. This interface extends <a
+ href='#contactproperties-interface'><code>ContactProperties</code></a> attributes.
+ </p>
+ <p>
+ All <a
+ href="#contact-interface"><code>Contact</code></a> objects MUST include all attributes supported by the implementation,
+ regardless of whether these attributes have been assigned a non-<code>null</code> value or a <code>null</code> value.
+ </p>
+ <p>
+ If a supported attribute has not been assigned a value by the user and/or implementation, then this attribute MUST still be
+ present in the resulting <a
+ href="#contact-interface"><code>Contact</code></a> object and MUST have a value of <code>null</code>.
+ </p>
+ <dl
+ title='[NoInterfaceObject] interface ContactWriter : Contact'
+ class='idl'>
+ <dt>
+ Contact clone ()
+ </dt>
+ <dd>
+ <p>
+ Create a deep clone copy of the current object minus the current object's <a
+ href='#widl-Contact-id'><code>id</code></a> attribute.
+ </p>
+ <p>
+ The resulting object MUST be provided with a newly generated <a
+ href='#widl-Contact-id'><code>id</code></a> attribute to distiguish the cloned object from the original object.
+ </p>
+ </dd>
+ <dt>
+ PendingOp save ()
+ </dt>
+ <dd>
+ <p>
+ Add or update (as appropriate) the current <a
+ href="#contact-interface"><code>Contact</code></a> object to the <a
+ href="#contacts-interface"><code>Contacts</code></a>.
+ </p>
+ <p>
+ This method takes one or two arguments. When called, it immediately returns a <code>PendingOp</code> object, as defined in
+ [[!CORE-DEVICE]], and then asynchronously starts a <dfn>save contact process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, invoke the <code>errorCB</code> with a <a
+ href='#widl-ContactError-PENDING_OPERATION_ERROR'><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ If the current <a
+ href='#widl-Contact-id'><code>Contact.id</code></a> value is not recognized in <a
+ href='#contacts-interface'><code>Contacts</code></a> or a <a
+ href='#widl-Contact-id'><code>Contact.id</code></a> value has not been set, create and set a new <a
+ href='#widl-Contact-id'><code>Contact.id</code></a> value and add the current object as a new object to <a
+ href='#contacts-interface'><code>Contacts</code></a>.
+ </li>
+ <li>
+ If the <a
+ href='#widl-Contact-id'><code>Contact.id</code></a> already exists in <a
+ href='#contacts-interface'><code>Contacts</code></a> then update the existing object in <a
+ href='#contacts-interface'><code>Contacts</code></a>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a
+ href='#contacterror-interface'><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+ <dl
+ class='parameters'>
+ <dt>
+ ContactSuccessCB successCB
+ </dt>
+ <dd>
+ Function to call when the asynchronous operation completes
+ </dd>
+ <dt>
+ optional ContactErrorCB? errorCB
+ </dt>
+ <dd>
+ Function to call when the asynchronous operation fails.
+ </dd>
+ </dl>
+ </dd>
+ <dt>
+ PendingOp remove ()
+ </dt>
+ <dd>
+ <p>
+ Remove the current contact from the address book.
+ </p>
+ <p>
+ In the case that the current <a
+ href='#widl-Contact-id'><code>id</code></a> attribute is <code>null</code> and this method is invoked, a <a
+ href='#contacterrorcb-interface'><code>ContactErrorCB</code></a> MUST be triggered as part of the <a>remove contact
+ process</a>. This error MUST consist of a <a
+ href="#contacterror-interface"><code>ContactError</code></a> object with a <code>code</code> of <a
+ href='#widl-ContactError-NOT_FOUND_ERROR'><code>NOT_FOUND_ERROR</code></a>.
+ </p>
+ <p>
+ This method takes one or two arguments. When called, it immediately returns a <code>PendingOp</code> object, as defined in
+ [[!CORE-DEVICE]], and then asynchronously starts a <dfn>remove contact process</dfn> defined as follows:
+ </p>
+ <ol>
+ <li>
+ If a current find(), save() or remove() operation is pending a response, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, invoke the <code>errorCB</code> with a <a
+ href='#widl-ContactError-PENDING_OPERATION_ERROR'><code>PENDING_OPERATION_ERROR</code></a> code.
+ </li>
+ <li>
+ Remove the current object from <a
+ href='#contacts-interface'><code>Contacts</code></a>.
+ </li>
+ <li>
+ If the removal of the current object from <a
+ href='#contacts-interface'><code>Contacts</code></a> was successful, set the current object's <a
+ href='#widl-Contact-id'><code>Contact.id</code></a> value to <code>null</code>.
+ </li>
+ <li>
+ If successful, invoke the associated <code>successCB</code>. If the attempt fails, and the method was invoked with a
+ non-<code>null</code> <code>errorCB</code> argument, this method must invoke the <code>errorCB</code> with a <a
+ href='#contacterror-interface'><code>ContactError</code></a> object as an argument.
+ </li>
+ </ol>
+ <dl
+ class='parameters'>
+ <dt>
+ ContactSuccessCB successCB
+ </dt>
+ <dd>
+ Function to call when the asynchronous operation completes
+ </dd>
+ <dt>
+ optional ContactErrorCB? errorCB
+ </dt>
+ <dd>
+ Function to call when the asynchronous operation fails.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+ <section>
+ <h2>
+ <a>ContactSuccessCB</a> interface
+ </h2>
+ <!-- interface intro here -->
+ <dl
+ title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactSuccessCB'
+ class='idl'>
+ <dt>
+ void onsuccess ()
+ </dt>
+ <dd>
+ <!-- interface description here -->
+ <dl
+ class='parameters'>
+ <dt>
+ Contact contactObj
+ </dt>
+ <dd>
+ The Contact object resulting from the given <a
+ href='#contact-interface'><code>Contact</code></a> <a
+ href='#widl-Contact-save'>save()</a> or <a
+ href='#contact-interface'><code>Contact</code></a> <a
+ href='#widl-Contact-remove'>remove()</a> method.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+ <section>
+ <h2>
+ <a>ContactErrorCB</a> interface
+ </h2>
+ <!-- interface intro here -->
+ <dl
+ title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactErrorCB'
+ class='idl'>
+ <dt>
+ void onerror ()
+ </dt>
+ <dd>
+ <!-- interface description here -->
+ <dl
+ class='parameters'>
+ <dt>
+ ContactError error
+ </dt>
+ <dd>
+ The Contact API related error object.
+ </dd>
+ </dl>
+ </dd>
+ </dl>
+ </section>
+ <section>
+ <h2>
+ <a>ContactError</a> interface
+ </h2>
+ <p>
+ The <a
+ href='#contacterror-interface'><code>ContactError</code></a> interface encapsulates all errors in the manipulation of <a
+ href='#contact-interface'><code>Contact</code></a> objects in the Contacts API.
+ </p>
+ <dl
+ title='[NoInterfaceObject] interface ContactError'
+ class='idl'>
+ <dt>
+ const unsigned short UNKNOWN_ERROR = 0
+ </dt>
+ <dd>
+ An unknown error occurred.
+ </dd>
+ <dt>
+ const unsigned short INVALID_ARGUMENT_ERROR = 1
+ </dt>
+ <dd>
+ An invalid parameter was provided when the requested method was invoked.
+ </dd>
+ <dt>
+ const unsigned short NOT_FOUND_ERROR = 2
+ </dt>
+ <dd>
+ If no response information can be provided from the requested method.
+ </dd>
+ <dt>
+ const unsigned short TIMEOUT_ERROR = 3
+ </dt>
+ <dd>
+ The requested method timed out before it could be completed.
+ </dd>
+ <dt>
+ const unsigned short PENDING_OPERATION_ERROR = 4
+ </dt>
+ <dd>
+ If the <a>user agent</a> is currently waiting for a callback on a current find(), save() or remove() operation, as defined in
+ this specification.
+ </dd>
+ <dt>
+ const unsigned short IO_ERROR = 5
+ </dt>
+ <dd>
+ An error occurred in communication with the underlying implementation that meant the requested method could not complete.
+ </dd>
+ <dt>
+ const unsigned short NOT_SUPPORTED_ERROR = 6
+ </dt>
+ <dd>
+ The requested method is not supported by the current implementation.
+ </dd>
+ <dt>
+ const unsigned short PERMISSION_DENIED_ERROR = 20
+ </dt>
+ <dd>
+ Access to the requested method was denied at the implementation or by the user.
+ </dd>
+ <dt>
+ readonly attribute unsigned short code
+ </dt>
+ <dd>
+ An error code assigned by an implementation when an error has occurred in Contacts API processing.
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <!-- end api description section -->
+ <section
+ class="informative appendix">
+ <h2>
+ User Interaction Guidelines
+ </h2>
+ <p>
+ This specification is primarily intended to provide the user with the ability to view and control the contact information that may
+ be shared, saved or removed from their unified address book. This annex provides some examples of a conformant user experience that
+ this specification enables.
+ </p>
+ <section>
+ <h3>
+ Contact Writebacks
+ </h3>
+ <section>
+ <h4>
+ Saving a Contact to the Address Book
+ </h4>
+ <p
+ class="note">
+ Include Contact creation/modification writeback mockup.
+ </p>
+ </section>
+ <section>
+ <h4>
+ Removing a Contact from the Address Book
+ </h4>
+ <p
+ class="note">
+ Include Contact deletion writeback mockup.
+ </p>
+ </section>
+ </section>
+ </section>
+ </body>
+</html>
+
Binary file contacts/contacts_element.png has changed
Binary file contacts/contacts_notification.png has changed
Binary file contacts/contacts_picker.png has changed