org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C.html
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="IDataSource.RequestNotification()"/><meta name="DC.Relation" scheme="URI" content="GUID-0D3A1E17-C699-4A9D-9124-9CEB71E2EBBF"/><meta name="DC.Relation" scheme="URI" content="GUID-890D2F5C-D43F-44B2-97A0-5F5B9230C85F"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-CABB28B8-D2B1-496B-BD7E-34FF496E60B4"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C"/><title>IDataSource.RequestNotification() </title><script type="text/javascript">
function initPage() {}
</script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C"><span>IDataSource.</span>RequestNotification()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>RequestNotification</code> method notifies the client
when entries are created, updated, or deleted in the specified calendar. If
no calendar is specified, the default calendar is used.</p>
<p>This is an asynchronous method.</p>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-0DB3E2B4-9B49-4F09-900A-069B2EB24260">result = so.IDataSource.RequestNotification(criteria, callback);</pre>
<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>
<p>This is an object that specifies which calendar and calendar entries
to monitor for changes and when. For more information about the object properties
and how to define them, see section <a href="GUID-B11EEC60-6A5C-40A6-A54A-74504B2BEE4F.html#GUID-B11EEC60-6A5C-40A6-A54A-74504B2BEE4F">Criteria for change notifications</a>.</p>
</li>
<li><p><code>callback</code>:</p>
<p>The <code>callback</code> argument is the name of the method
that is executed when <code>RequestNotification</code> has results
or status information to return. You must define this method separately. Follow
the instructions in section <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608">Defining the callback handler for an asynchronous method</a> to
define the <code>callback</code> method.</p>
</li>
</ul>
<p><strong>Return value:</strong></p>
<p>The <code>RequestNotification</code> method returns an object
that contains the initial return value for the asynchronous call it started.
The actual notification information is returned by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method in the <code>ReturnValue</code> property of its result object.
The returned information is described in section <a href="GUID-13C405C4-F914-469C-84BF-D1EDF0322A24.html#GUID-13C405C4-F914-469C-84BF-D1EDF0322A24">Returned notification information</a>.</p>
<div class="tablenoborder"><a name="GUID-24769524-6168-4419-AD95-4ABDF4215428"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-24769524-6168-4419-AD95-4ABDF4215428" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for RequestNotification</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e24369">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e24374">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e24379">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24369 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24374 ">
<p>This is a number used as an identification to match transactions started
with a <code>RequestNotification</code> call to one or more calls
it generates to <code>callback</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24379 "> </td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24369 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24374 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24379 ">
<p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24369 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24374 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e24379 ">
<p>See <a href="GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35.html#GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35">Calendar Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Remarks:</strong></p>
<ul>
<li><p><code>RequestNotification</code> returns notifications
until cancelled with <a href="GUID-0D3A1E17-C699-4A9D-9124-9CEB71E2EBBF.html#GUID-0D3A1E17-C699-4A9D-9124-9CEB71E2EBBF"><code>Cancel</code></a>. You can have
multiple <code>RequestNotification</code> calls (instances) pending
or in use at the same time.</p></li>
<li><p>The calendar file to be monitored must exist on the device.</p>
</li>
</ul>
<p><strong>Example code:</strong></p>
<p/>
<p>For the complete source of a sample widget
that demonstrates how to use this Service API, see <a href="GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3.html#GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3">the full example</a>.</p>
</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>