- From: Robin Berjon via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 06 Apr 2011 13:38:00 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv16081/contacts
Modified Files:
Overview.html
Log Message:
editorials, section 4 including contacts, task sourcing, algorithmifying
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.120
retrieving revision 1.121
diff -u -d -r1.120 -r1.121
--- Overview.html 6 Apr 2011 13:08:42 -0000 1.120
+++ Overview.html 6 Apr 2011 13:37:58 -0000 1.121
@@ -18,6 +18,7 @@
previousPublishDate: "2010-12-09",
previousMaturity: "WD",
edDraftURI: "http://dev.w3.org/2009/dap/contacts/",
+ noIDLIn: true,
// lcEnd: "2009-08-05",
};
</script>
@@ -67,17 +68,20 @@
/*
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; /* CSS 2.0 */
- white-space: pre-wrap; /* CSS 2.1 */
- white-space: pre-line; /* CSS 3.0 */
- white-space: -pre-wrap; /* Opera 4-6 */
- white-space: -o-pre-wrap; /* Opera 7 */
- white-space: -moz-pre-wrap; /* Mozilla */
- white-space: -hp-pre-wrap; /* HP Printers */
- word-wrap: break-word; /* IE 5+ */
+ 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>
@@ -298,86 +302,93 @@
<section>
<h2><a>ServiceContacts</a> interface</h2>
-
<p>
- The <a href='#servicecontacts-interface'><code>ServiceContacts</code></a> interface is exposed on
- the <a class="externalDFN">Navigator</a> interface [[NAVIGATOR]].
+ 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 root node from which the contacts functionality can be accessed.</dd>
+ <dd>The object through which the contacts functionality can be accessed.</dd>
</dl>
-
- <div class='idl' title='Navigator implements ServiceContacts'>
-
- </div>
+ <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 collecting contacts information that may be
- retrieved.
+ 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> 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.
+ 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'>find()</a> operation.
</p>
<dl title='[NoInterfaceObject] interface Contacts' class='idl'>
<dt>caller void find ()</dt>
-
<dd>
<p>
- Find contacts in the address book according to the <a>find contacts process</a> detailed
- below.
+ 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 immediately returns and then
- asynchronously starts a <dfn>find contacts process</dfn> defined as follows:
+ This method takes two, three or four arguments. When called, it starts the following
+ <dfn>find contacts process</dfn>:
</p>
-
<ol class="rule">
- <li>If there are any <a>tasks</a> from the <a>device task source</a> in one of the <a>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>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>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>dispatch an <code>error</code> event</a> with the <code>code</code> attribute
- set according to the type of failure that has occurred.</li>
+ <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>If <var>successCallback</var> is null, abort these steps.</li>
+ <li>
+ 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</dd>
-
+ <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>
Received on Wednesday, 6 April 2011 13:38:02 UTC