org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-B11EEC60-6A5C-40A6-A54A-74504B2BEE4F.html
author tasneems@symbian.org
Fri, 05 Mar 2010 19:11:15 -0800
changeset 229 716254ccbcc0
permissions -rw-r--r--
Fixed 2046: WRTKit help topics. Fixed 2170: Added support for Web Developer Library. Fixed 1952: Event Trigger icons unreadable


<!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="Criteria for change notifications"/><meta name="DC.Relation" scheme="URI" content="GUID-13C405C4-F914-469C-84BF-D1EDF0322A24"/><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.Relation" scheme="URI" content="GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-B11EEC60-6A5C-40A6-A54A-74504B2BEE4F"/><title>Criteria for
change notifications </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-B11EEC60-6A5C-40A6-A54A-74504B2BEE4F"><span>Criteria</span> for
change notifications</h1><div>
<p>The <code>criteria</code> object specifies which calendar
and calendar entries to monitor for changes and when.</p>
<p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Filter</code>.
These are described in the following table. Properties enclosed in brackets
are optional.</p>
<div class="tablenoborder"><a name="GUID-F991F428-E4DB-4DF1-A9BD-59A7FCD1C574"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-F991F428-E4DB-4DF1-A9BD-59A7FCD1C574" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e24564">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e24569">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e24574">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e24579">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>criteria.Type</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>Specifies the type of calendar information to monitor. This is always <code>"CalendarEntry"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">
<p>Possible values:</p>
<ul>
<li><p><code>"CalendarEntry"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>Specifies the calendar and calendar entries to monitor.</p>
<p>If this property is not specified, <a href="GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C.html#GUID-D4014B08-C48C-48EB-B3A5-1A09FF636B3C"><code>RequestNotification</code></a> returns
notifications for all entries in the default calendar.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter.CalendarName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>Specifies the calendar whose entries to monitor.</p>
<p>If this property is not specified, the default calendar is used.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">
<p><code>&lt;DriveLetter&gt;:&lt;FileName&gt;</code></p>
<p>For example: <code>"C:Calendar"</code></p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter.LocalIdList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>Specifies the <code>LocalId</code>s of the entries to monitor.
Use <a href="GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html#GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><code>GetList</code></a> to
retrieve these.</p>
<p>If this property is not specified, all entries in the calendar are monitored.</p>
<p>The first <code>LocalId</code> is specified in <code>Filter.LocalIdList[0]</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter.StartRange]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>If only <code>StartRange</code> is specified, notifications
are returned from this date onwards.</p>
<p>If both <code>StartRange</code> and <code>EndRange</code> are
specified, only changes that occur within these dates are notified about.</p>
<p/>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>date object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter.EndRange]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>If only <code>EndRange</code> is specified, notifications are
returned until this date.</p>
<p>If both <code>StartRange</code> and <code>EndRange</code> are
specified, only changes that occur within these dates are notified about.</p>
<p/>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>date object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e24564 ">
<p><code>[criteria.Filter.IncludeUndatedTodos]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24569 ">
<p>Specifies whether notifications are returned for <code>ToDo</code> entries
that have no date.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24574 ">
<p>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e24579 ">&nbsp;</td>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>