|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <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 |
|
5 change notifications </title><script type="text/javascript"> |
|
6 function initPage() {} |
|
7 </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 |
|
8 change notifications</h1><div> |
|
9 <p>The <code>criteria</code> object specifies which calendar |
|
10 and calendar entries to monitor for changes and when.</p> |
|
11 <p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Filter</code>. |
|
12 These are described in the following table. Properties enclosed in brackets |
|
13 are optional.</p> |
|
14 <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> |
|
15 |
|
16 <thead align="left"> |
|
17 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e24564"> |
|
18 <p>Property</p> |
|
19 </th><th class="cellrowborder" valign="top" width="25%" id="d0e24569"> |
|
20 <p>Description</p> |
|
21 </th><th class="cellrowborder" valign="top" width="25%" id="d0e24574"> |
|
22 <p>Type</p> |
|
23 </th><th class="cellrowborder" valign="top" width="25%" id="d0e24579"> |
|
24 <p>Value</p> |
|
25 </th></tr> |
|
26 </thead> |
|
27 <tbody> |
|
28 <tr class=""> |
|
29 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
30 <p><code>criteria.Type</code></p> |
|
31 </td> |
|
32 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
33 <p>Specifies the type of calendar information to monitor. This is always <code>"CalendarEntry"</code>.</p> |
|
34 </td> |
|
35 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
36 <p>string</p> |
|
37 </td> |
|
38 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> |
|
39 <p>Possible values:</p> |
|
40 <ul> |
|
41 <li><p><code>"CalendarEntry"</code></p></li> |
|
42 </ul> |
|
43 </td> |
|
44 </tr> |
|
45 <tr class="bg "> |
|
46 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
47 <p><code>[criteria.Filter]</code></p> |
|
48 </td> |
|
49 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
50 <p>Specifies the calendar and calendar entries to monitor.</p> |
|
51 <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 |
|
52 notifications for all entries in the default calendar.</p> |
|
53 </td> |
|
54 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
55 <p>object</p> |
|
56 </td> |
|
57 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> |
|
58 <p>Object with the properties specified below</p> |
|
59 </td> |
|
60 </tr> |
|
61 <tr class=""> |
|
62 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
63 <p><code>[criteria.Filter.CalendarName]</code></p> |
|
64 </td> |
|
65 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
66 <p>Specifies the calendar whose entries to monitor.</p> |
|
67 <p>If this property is not specified, the default calendar is used.</p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
70 <p>string</p> |
|
71 </td> |
|
72 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> |
|
73 <p><code><DriveLetter>:<FileName></code></p> |
|
74 <p>For example: <code>"C:Calendar"</code></p> |
|
75 </td> |
|
76 </tr> |
|
77 <tr class="bg "> |
|
78 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
79 <p><code>[criteria.Filter.LocalIdList]</code></p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
82 <p>Specifies the <code>LocalId</code>s of the entries to monitor. |
|
83 Use <a href="GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html#GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><code>GetList</code></a> to |
|
84 retrieve these.</p> |
|
85 <p>If this property is not specified, all entries in the calendar are monitored.</p> |
|
86 <p>The first <code>LocalId</code> is specified in <code>Filter.LocalIdList[0]</code>.</p> |
|
87 </td> |
|
88 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
89 <p>array of strings</p> |
|
90 </td> |
|
91 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> </td> |
|
92 </tr> |
|
93 <tr class=""> |
|
94 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
95 <p><code>[criteria.Filter.StartRange]</code></p> |
|
96 </td> |
|
97 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
98 <p>If only <code>StartRange</code> is specified, notifications |
|
99 are returned from this date onwards.</p> |
|
100 <p>If both <code>StartRange</code> and <code>EndRange</code> are |
|
101 specified, only changes that occur within these dates are notified about.</p> |
|
102 <p/> |
|
103 </td> |
|
104 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
105 <p>date object</p> |
|
106 </td> |
|
107 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> </td> |
|
108 </tr> |
|
109 <tr class="bg "> |
|
110 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
111 <p><code>[criteria.Filter.EndRange]</code></p> |
|
112 </td> |
|
113 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
114 <p>If only <code>EndRange</code> is specified, notifications are |
|
115 returned until this date.</p> |
|
116 <p>If both <code>StartRange</code> and <code>EndRange</code> are |
|
117 specified, only changes that occur within these dates are notified about.</p> |
|
118 <p/> |
|
119 </td> |
|
120 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
121 <p>date object</p> |
|
122 </td> |
|
123 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> </td> |
|
124 </tr> |
|
125 <tr class=""> |
|
126 <td class="cellrowborder" valign="top" width="25%" headers="d0e24564 "> |
|
127 <p><code>[criteria.Filter.IncludeUndatedTodos]</code></p> |
|
128 </td> |
|
129 <td class="cellrowborder" valign="top" width="25%" headers="d0e24569 "> |
|
130 <p>Specifies whether notifications are returned for <code>ToDo</code> entries |
|
131 that have no date.</p> |
|
132 </td> |
|
133 <td class="cellrowborder" valign="top" width="25%" headers="d0e24574 "> |
|
134 <p>boolean</p> |
|
135 </td> |
|
136 <td class="cellrowborder" valign="top" width="25%" headers="d0e24579 "> </td> |
|
137 </tr> |
|
138 </tbody> |
|
139 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |