- From: Richard Tibbett via cvs-syncmail <cvsmail@w3.org>
- Date: Tue, 05 Oct 2010 14:38:22 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv3429/contacts
Modified Files:
Overview.html
Log Message:
Update Contact fields and descriptions according to feedback: http://lists.w3.org/Archives/Public/public-device-apis/2010Oct/0005.html
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.92
retrieving revision 1.93
diff -u -d -r1.92 -r1.93
--- Overview.html 4 Oct 2010 10:48:43 -0000 1.92
+++ Overview.html 5 Oct 2010 14:38:20 -0000 1.93
@@ -328,10 +328,10 @@
</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='#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-tags'><code>tags</code></a> value(s) via the <a href="#contacts-interface"><code>Contacts</code></a> <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>
<dl
@@ -408,7 +408,7 @@
<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 [[!POCO-SCHEMA]] and are intended to be direct mappings to
+ included in this interface have a corresponding definition in [[POCO-SCHEMA]] and are intended to be direct mappings to
attributes also defined in [[RFC2426]].
</p>
<p>
@@ -434,23 +434,23 @@
</dt>
<dd>
<p>
- A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> referenced from
- <a href="#contacts-interface"><code>Contacts</code></a> MUST include a non-empty <code>id</code> value.
+ A globally unique identifier for the given <code>Contact</code> object. Each <code>Contact</code> MUST
+ include a non-empty <code>id</code> value.
</p>
<p>
An implementation MUST maintain this globally unique resource identifier when a Contact is added to, or present within, an
Address Book.
</p>
- <p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>id</code>] for additional definition of this attribute.
- </p>
</dd>
<dt>
attribute DOMString displayName
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>displayName</code>].
+ This attribute contains the display name of this Contact which is suitable for display to the end-users.
+ </p>
+ <p>
+ Each Contact MUST include either a <code>displayName</code> or the <code>name</code> attribute.
</p>
</dd>
<dt>
@@ -458,7 +458,8 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>name</code>].
+ 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>
</dd>
<dt>
@@ -466,7 +467,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>nickname</code>].
+ This attribute contains the nickname (or a casual name) for this Contact.
</p>
</dd>
<dt>
@@ -474,7 +475,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>phoneNumbers</code>].
+ This attribute represents one or more phone numbers associated with this Contact.
</p>
</dd>
<dt>
@@ -482,7 +483,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>emails</code>].
+ This attribute represents one or more email addresses associated with this Contact.
</p>
</dd>
<dt>
@@ -490,7 +491,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>addresses</code>].
+ This attribute represents one or more physical addresses associated with this Contact.
</p>
</dd>
<dt>
@@ -498,7 +499,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>ims</code>].
+ This attribute represents one or more instant messaging identifiers associated with this Contact.
</p>
</dd>
<dt>
@@ -506,23 +507,28 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>organizations</code>].
+ This attribute represents one or more organizations associated with this Contact.
</p>
</dd>
<dt>
- attribute DOMString updated
+ attribute Date revision
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>updated</code>].
+ 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>
</dd>
<dt>
- attribute DOMString birthday
+ attribute Date birthday
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>birthday</code>].
+ This attribute contains birthday of this Contact.
+ </p>
+ <p>
+ The year value MAY be set to 0000 when the age of the Contact is private or the year is not available.
</p>
</dd>
<dt>
@@ -530,7 +536,11 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>gender</code>].
+ This attribute contains the gender of this Contact. This attribute SHOULD have one of the following values:
+ </p>
+ <pre>male, female, undisclosed</pre>
+ <p>
+ This attribute MAY return a different value if it is not covered by one of these values.
</p>
</dd>
<dt>
@@ -538,7 +548,10 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>note</code>].
+ 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 MAY contain newlines (<code>\n</code>).
</p>
</dd>
<dt>
@@ -546,15 +559,27 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>photos</code>].
+ This attribute represents one or more photos (that may be displayed) associated with this Contact.
+ </p>
+ <p>
+ The photos MUST 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 MAY 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 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 ContactField[] tags
+ attribute DOMString[] categories
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>tags</code>].
+ This attribute contains one or more user-defined categories/tags/labels associated with this Contact. e.g. "family", "favorite".
</p>
</dd>
<dt>
@@ -562,15 +587,30 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>urls</code>].
+ 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 MUST 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>
</dd>
<dt>
- attribute DOMString utcOffset
+ attribute DOMString timezone
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.1. <code>utcOffset</code>].
+ The value contains the time zone of this Contact as an offset from UTC.
+ </p>
+ <p>
+ The value MUST 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 MAY 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>
</dd>
</dl>
@@ -591,7 +631,8 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>formatted</code>].
+ 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>
</dd>
<dt>
@@ -599,7 +640,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>familyName</code>].
+ This attribute contains the family name (also referred to as the last name) of this Contact.
</p>
</dd>
<dt>
@@ -607,7 +648,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>givenName</code>].
+ This attribute contains the given name (also referred to as the first name) of this Contact.
</p>
</dd>
<dt>
@@ -615,7 +656,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>middleName</code>].
+ This attribute contains the middle name of this Contact.
</p>
</dd>
<dt>
@@ -623,7 +664,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>honorificPrefix</code>].
+ This attribute contains the honorific prefix (or title) of this Contact. E.g. Mr. Dr. Ms. Mrs.,
</p>
</dd>
<dt>
@@ -631,7 +672,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.3. <code>honorificSuffix</code>].
+ This attribute contains the honorific suffix of this Contact. E.g. Jr, III, Sr.
</p>
</dd>
</dl>
@@ -652,7 +693,11 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>type</code>].
+ 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>
</dd>
<dt>
@@ -660,15 +705,19 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>value</code>].
+ 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>
</dd>
<dt>
- attribute boolean primary
+ attribute boolean pref
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.2.2. <code>primary</code>].
+ 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>
</dd>
</dl>
@@ -689,7 +738,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>formatted</code>].
+ This attribute contains the full physical address including street, locality, region, postalCode, and country as appropriate, and formatted for display.
</p>
</dd>
<dt>
@@ -697,7 +746,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>streetAddress</code>].
+ This attribute contains the street address corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
</p>
</dd>
<dt>
@@ -705,7 +754,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>locality</code>].
+ This attribute contains the locality (or city) name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
</p>
</dd>
<dt>
@@ -713,7 +762,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>region</code>].
+ This attribute contains the region (or state/province) name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
</p>
</dd>
<dt>
@@ -721,7 +770,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>postalCode</code>].
+ This attribute contains the postal code (or zip) corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
</p>
</dd>
<dt>
@@ -729,7 +778,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.4. <code>country</code>].
+ This attribute contains the country name corresponding to this <a href="#contactaddress-interface"><code>ContactAddress</code></a>.
</p>
</dd>
</dl>
@@ -750,7 +799,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>name</code>].
+ This attribute contains the name of the Organization and MUST be assigned a non-null value.
</p>
</dd>
<dt>
@@ -758,7 +807,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>department</code>].
+ This attribute contains the Job Title information of the Contact associated with this Organization.
</p>
</dd>
<dt>
@@ -766,39 +815,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>title</code>].
- </p>
- </dd>
- <dt>
- attribute DOMString startDate
- </dt>
- <dd>
- <p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>startDate</code>].
- </p>
- </dd>
- <dt>
- attribute DOMString endDate
- </dt>
- <dd>
- <p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>endDate</code>].
- </p>
- </dd>
- <dt>
- attribute DOMString location
- </dt>
- <dd>
- <p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>location</code>].
- </p>
- </dd>
- <dt>
- attribute DOMString description
- </dt>
- <dd>
- <p>
- See [[[!POCO-SCHEMA]] Section 7.5. <code>description</code>].
+ This attribute contains the department information of the Organization associated with this Contact.
</p>
</dd>
</dl>
@@ -844,7 +861,7 @@
</p>
<p>
This filter is applied to the <a
- href="#widl-Contact-updated"><code>updated</code></a> field as defined in <a
+ href="#widl-Contact-revision"><code>revision</code></a> field as defined in <a
href="#contact-interface"><code>Contact</code></a>.
</p>
</dd>
@@ -1452,7 +1469,7 @@
attribute ContactAccount[] Xaccounts
</dt>
<dd>
- One or more user accounts. See [[[!POCO-SCHEMA]] Section 7.2.2. <code>accounts</code>].
+ One or more user accounts. See [[[POCO-SCHEMA]] Section 7.2.2. <code>accounts</code>].
</dd>
</dl>
<dl
@@ -1463,7 +1480,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.6. <code>domain</code>].
+ See [[[POCO-SCHEMA]] Section 7.6. <code>domain</code>].
</p>
</dd>
<dt>
@@ -1471,7 +1488,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.6. <code>username</code>].
+ See [[[POCO-SCHEMA]] Section 7.6. <code>username</code>].
</p>
</dd>
<dt>
@@ -1479,7 +1496,7 @@
</dt>
<dd>
<p>
- See [[[!POCO-SCHEMA]] Section 7.6. <code>userid</code>].
+ See [[[POCO-SCHEMA]] Section 7.6. <code>userid</code>].
</p>
</dd>
</dl>
Received on Tuesday, 5 October 2010 14:38:25 UTC