|
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 retrieving calendar information"/><meta name="DC.Relation" scheme="URI" content="GUID-10DA851F-1022-4B8C-8F01-F4242AD6EA08"/><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-C2E995C2-535C-41A2-B69D-D36009BBE8C4"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-00DB3F96-E09F-4CA2-B02D-598EAEF214FF"/><title>Criteria for |
|
5 retrieving calendar information </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-00DB3F96-E09F-4CA2-B02D-598EAEF214FF"><span>Criteria</span> for |
|
8 retrieving calendar information</h1><div> |
|
9 <p>The <code>criteria</code> object specifies what calendar |
|
10 information is returned.</p> |
|
11 <p>Each <a href="GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html#GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><code>GetList</code></a> call |
|
12 targets one type of calendar information:</p> |
|
13 <ul> |
|
14 <li><p>Calendar</p></li> |
|
15 <li><p><a href="GUID-798E9CA0-2A46-4D10-B567-04C9567500F4.html#GUID-798E9CA0-2A46-4D10-B567-04C9567500F4">Calendar |
|
16 entry</a></p></li> |
|
17 </ul> |
|
18 <p>For more information about the types, see the <a href="GUID-AE9A928B-F938-49B5-BC9E-72CB42046571.html#GUID-AE9A928B-F938-49B5-BC9E-72CB42046571">Calendar |
|
19 Service overview page</a>.</p> |
|
20 <p>The <code>criteria</code> object has two main properties: <code>Type</code> and <code>Filter</code>. |
|
21 These are described in the following table. Properties enclosed in brackets |
|
22 are optional.</p> |
|
23 <div class="tablenoborder"><a name="GUID-93AEB426-1A4C-4A26-B55D-542C688AF629"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-93AEB426-1A4C-4A26-B55D-542C688AF629" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
24 |
|
25 <thead align="left"> |
|
26 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e20627"> |
|
27 <p>Property</p> |
|
28 </th><th class="cellrowborder" valign="top" width="25%" id="d0e20632"> |
|
29 <p>Description</p> |
|
30 </th><th class="cellrowborder" valign="top" width="25%" id="d0e20637"> |
|
31 <p>Type</p> |
|
32 </th><th class="cellrowborder" valign="top" width="25%" id="d0e20642"> |
|
33 <p>Value</p> |
|
34 </th></tr> |
|
35 </thead> |
|
36 <tbody> |
|
37 <tr class=""> |
|
38 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
39 <p><code>criteria.Type</code></p> |
|
40 </td> |
|
41 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
42 <p>Specifies the type of calendar information to retrieve.</p> |
|
43 <div class="note"><p><strong class="note_title">Note: </strong>The available <code>Filter</code> properties depend on the selected |
|
44 type.</p> |
|
45 </div> |
|
46 </td> |
|
47 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
48 <p>string</p> |
|
49 </td> |
|
50 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> |
|
51 <p>Possible values:</p> |
|
52 <ul> |
|
53 <li><p><code>"Calendar"</code></p></li> |
|
54 <li><p><code>"CalendarEntry"</code></p></li> |
|
55 </ul> |
|
56 </td> |
|
57 </tr> |
|
58 <tr class="bg "> |
|
59 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
60 <p><code>[criteria.Filter]</code></p> |
|
61 </td> |
|
62 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
63 <p>Specifies how the information to be retrieved is filtered.</p> |
|
64 <p>If this property is not specified, <code>GetList</code> returns |
|
65 a list of all available calendars or calendar entries (instances).</p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
68 <p>object</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> |
|
71 <p>Object with the properties specified below</p> |
|
72 </td> |
|
73 </tr> |
|
74 <tr class=""> |
|
75 <td class="cellrowborder" colspan="4" valign="top" headers="d0e20627 d0e20632 d0e20637 d0e20642 "> |
|
76 <p><strong>The following properties are only valid if Type is "Calendar"</strong></p> |
|
77 </td> |
|
78 </tr> |
|
79 <tr class="bg "> |
|
80 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
81 <p><code>[criteria.Filter.DefaultCalendar]</code></p> |
|
82 </td> |
|
83 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
84 <p>If this property is set to <code>true</code>, <code>GetList</code> returns |
|
85 a list with only one item, the default calendar.</p> |
|
86 <p>If this property is set to <code>false</code>, <code>GetList</code> returns |
|
87 a list of all available calendars, including the default one.</p> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
90 <p>boolean</p> |
|
91 </td> |
|
92 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> |
|
93 <p>Possible values:</p> |
|
94 <ul> |
|
95 <li><p><code>true</code></p></li> |
|
96 <li><p><code>false</code></p></li> |
|
97 </ul> |
|
98 </td> |
|
99 </tr> |
|
100 <tr class=""> |
|
101 <td class="cellrowborder" colspan="4" valign="top" headers="d0e20627 d0e20632 d0e20637 d0e20642 "> |
|
102 <p><strong>The following properties are only valid if Type is "CalendarEntry"</strong></p> |
|
103 </td> |
|
104 </tr> |
|
105 <tr class="bg "> |
|
106 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
107 <p><code>[criteria.Filter.CalendarName]</code></p> |
|
108 </td> |
|
109 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
110 <p>Specifies the calendar file from which the information is retrieved.</p> |
|
111 <p>If this property is not specified, the default calendar is used.</p> |
|
112 </td> |
|
113 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
114 <p>string</p> |
|
115 </td> |
|
116 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> |
|
117 <p><code><DriveLetter>:<FileName></code></p> |
|
118 <p>For example: <code>"C:Calendar"</code></p> |
|
119 </td> |
|
120 </tr> |
|
121 <tr class=""> |
|
122 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
123 <p><code>[criteria.Filter.id]</code></p> |
|
124 </td> |
|
125 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
126 <p>Specifies the globally unique identifier of a calendar entry. This is |
|
127 unique across all calendars on any device. If the entry has child entries, |
|
128 they share the same <code>id</code> as the parent but have unique <code>LocalId</code>s.</p> |
|
129 <p>If this property is specified, <code>GetList</code> returns |
|
130 the entry whose <code>id</code> matches the specified value. If the |
|
131 entry has child entries, <code>GetList</code> returns both the parent |
|
132 and child entries. In this case, the parent entry is the first item in the |
|
133 returned array.</p> |
|
134 <div class="note"><p><strong class="note_title">Note: </strong>Specify either <code>Filter.id</code> or <code>Filter.LocalId</code> or |
|
135 neither, but not both. If you specify either one, the other <code>Filter</code> properties |
|
136 are ignored. If you specify neither, <code>GetList</code> returns |
|
137 a list of instances.</p> |
|
138 </div> |
|
139 </td> |
|
140 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
141 <p>string</p> |
|
142 </td> |
|
143 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> </td> |
|
144 </tr> |
|
145 <tr class="bg "> |
|
146 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
147 <p><code>[criteria.Filter.LocalId]</code></p> |
|
148 </td> |
|
149 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
150 <p>Specifies the locally unique identifier of a parent entry or child entry. |
|
151 This is unique within a calendar and distinguishes between parent and child |
|
152 entries that share the same <code>id</code>.</p> |
|
153 <p>If this property is specified, <code>GetList</code> returns |
|
154 the parent or child entry whose <code>LocalId</code> matches the specified |
|
155 value.</p> |
|
156 <div class="note"><p><strong class="note_title">Note: </strong>Specify either <code>Filter.id</code> or <code>Filter.LocalId</code> or |
|
157 neither, but not both. If you specify either one, the other <code>Filter</code> properties |
|
158 are ignored. If you specify neither, <code>GetList</code> returns |
|
159 a list of instances.</p> |
|
160 </div> |
|
161 </td> |
|
162 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
163 <p>string</p> |
|
164 </td> |
|
165 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> </td> |
|
166 </tr> |
|
167 <tr class=""> |
|
168 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
169 <p><code>[criteria.Filter.StartRange]</code></p> |
|
170 </td> |
|
171 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
172 <p>If only <code>StartRange</code> is specified, all entries that |
|
173 occur on or after this date are retrieved.</p> |
|
174 <p>If both <code>StartRange</code> and <code>EndRange</code> are |
|
175 specified, all entries that occur within these dates are retrieved.</p> |
|
176 </td> |
|
177 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
178 <p>date object</p> |
|
179 </td> |
|
180 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> </td> |
|
181 </tr> |
|
182 <tr class="bg "> |
|
183 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
184 <p><code>[criteria.Filter.EndRange]</code></p> |
|
185 </td> |
|
186 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
187 <p>If only <code>EndRange</code> is specified, all entries that |
|
188 occur on or before this date are retrieved.</p> |
|
189 <p>If both <code>StartRange</code> and <code>EndRange</code> are |
|
190 specified, all entries that occur within these dates are retrieved.</p> |
|
191 </td> |
|
192 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
193 <p>date object</p> |
|
194 </td> |
|
195 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> </td> |
|
196 </tr> |
|
197 <tr class=""> |
|
198 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
199 <p><code>[criteria.Filter.SearchText]</code></p> |
|
200 </td> |
|
201 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
202 <p>Specifies a text string matched against the <code>Summary</code> value |
|
203 of an entry. The match is not case sensitive.</p> |
|
204 <p>For more information about calendar entries, see section <a href="GUID-798E9CA0-2A46-4D10-B567-04C9567500F4.html#GUID-798E9CA0-2A46-4D10-B567-04C9567500F4">Calendar entries</a>.</p> |
|
205 </td> |
|
206 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
207 <p>string</p> |
|
208 </td> |
|
209 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> </td> |
|
210 </tr> |
|
211 <tr class="bg "> |
|
212 <td class="cellrowborder" valign="top" width="25%" headers="d0e20627 "> |
|
213 <p><code>[criteria.Filter.Type]</code></p> |
|
214 </td> |
|
215 <td class="cellrowborder" valign="top" width="25%" headers="d0e20632 "> |
|
216 <p>Specifies the type of calendar entries about which to return information.</p> |
|
217 <p>If this property is not specified or if it is set to <code>"IncludeAll"</code>, <code>GetList</code> returns |
|
218 information about all types of entries.</p> |
|
219 </td> |
|
220 <td class="cellrowborder" valign="top" width="25%" headers="d0e20637 "> |
|
221 <p>string</p> |
|
222 </td> |
|
223 <td class="cellrowborder" valign="top" width="25%" headers="d0e20642 "> |
|
224 <p>Possible values:</p> |
|
225 <ul> |
|
226 <li><p><code>"Anniversary"</code></p></li> |
|
227 <li><p><code>"DayEvent"</code></p></li> |
|
228 <li><p><code>"Meeting"</code></p></li> |
|
229 <li><p><code>"Reminder"</code></p></li> |
|
230 <li><p><code>"ToDo"</code></p></li> |
|
231 <li><p><code>"IncludeAll"</code></p></li> |
|
232 </ul> |
|
233 </td> |
|
234 </tr> |
|
235 </tbody> |
|
236 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |