|
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 messaging information"/><meta name="DC.Relation" scheme="URI" content="GUID-C8571941-AD6E-4FAD-B4A1-35E7BDB99689"/><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-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Relation" scheme="URI" content="GUID-C12C81D1-13A4-4B8C-81B9-694D414A4A48"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-5720512C-9198-4883-81B1-46F1B963C6B9"/><title>Criteria for |
|
5 retrieving messaging 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-5720512C-9198-4883-81B1-46F1B963C6B9"><span>Criteria</span> for |
|
8 retrieving messaging information</h1><div> |
|
9 <p>The <code>criteria</code> object specifies what messaging |
|
10 information is returned and how the returned information is sorted.</p> |
|
11 <p>The <code>criteria</code> object has three main properties: <code>Type</code>, <code>Filter</code>, |
|
12 and <code>Sort</code>. These are described in the following table. |
|
13 Properties enclosed in brackets are optional.</p> |
|
14 <div class="tablenoborder"><a name="GUID-730956F1-7540-4012-ADC6-E9C25B8E7E0A"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-730956F1-7540-4012-ADC6-E9C25B8E7E0A" 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="d0e58537"> |
|
18 <p>Property</p> |
|
19 </th><th class="cellrowborder" valign="top" width="25%" id="d0e58542"> |
|
20 <p>Description</p> |
|
21 </th><th class="cellrowborder" valign="top" width="25%" id="d0e58547"> |
|
22 <p>Type</p> |
|
23 </th><th class="cellrowborder" valign="top" width="25%" id="d0e58552"> |
|
24 <p>Value</p> |
|
25 </th></tr> |
|
26 </thead> |
|
27 <tbody> |
|
28 <tr class=""> |
|
29 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
30 <p><code>criteria.Type</code></p> |
|
31 </td> |
|
32 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
33 <p>Specifies the type of messaging objects to retrieve.</p> |
|
34 </td> |
|
35 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
36 <p>string</p> |
|
37 </td> |
|
38 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
39 <p>Possible values:</p> |
|
40 <ul> |
|
41 <li><p><code>"Inbox"</code></p></li> |
|
42 </ul> |
|
43 </td> |
|
44 </tr> |
|
45 <tr class="bg "> |
|
46 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
47 <p><code>[criteria.Filter]</code></p> |
|
48 </td> |
|
49 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
50 <p>Specifies how the information to be retrieved is filtered.</p> |
|
51 </td> |
|
52 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
53 <p>object</p> |
|
54 </td> |
|
55 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
56 <p>Object with the properties specified below</p> |
|
57 </td> |
|
58 </tr> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
61 <p><code>[criteria.Filter.MessageTypeList]</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
64 <p>Specifies the type or types of messages to retrieve.</p> |
|
65 </td> |
|
66 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
67 <p>array of strings</p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
70 <p>Possible values:</p> |
|
71 <ul> |
|
72 <li><p><code>"SMS"</code></p></li> |
|
73 <li><p><code>"MMS"</code></p></li> |
|
74 <li><p><code>"unknown"</code></p></li> |
|
75 </ul> |
|
76 <div class="note"><p><strong class="note_title">Note: </strong>The current implementation only recognizes SMS and MMS. Other types |
|
77 of messages are <code>unknown</code>.</p> |
|
78 </div> |
|
79 </td> |
|
80 </tr> |
|
81 <tr class="bg "> |
|
82 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
83 <p><code>[criteria.Filter.MessageId]</code></p> |
|
84 </td> |
|
85 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
86 <p>Specifies the unique ID of the message to retrieve.</p> |
|
87 <p>If <code>MessageId</code> is specified, then only the message |
|
88 with that ID is retrieved.</p> |
|
89 </td> |
|
90 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
91 <p>number</p> |
|
92 </td> |
|
93 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> </td> |
|
94 </tr> |
|
95 <tr class=""> |
|
96 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
97 <p><code>[criteria.Filter.SenderList]</code></p> |
|
98 </td> |
|
99 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
100 <p>Specifies the message recipients. Only messages sent to these recipients |
|
101 are retrieved.</p> |
|
102 </td> |
|
103 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
104 <p>array of strings</p> |
|
105 </td> |
|
106 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> </td> |
|
107 </tr> |
|
108 <tr class="bg "> |
|
109 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
110 <p><code>[criteria.Filter.Subject]</code></p> |
|
111 </td> |
|
112 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
113 <p>Specifies the message subjects. Only messages with these subjects are |
|
114 retrieved.</p> |
|
115 <div class="note"><p><strong class="note_title">Note: </strong>SMS does not support subject. This property is only valid for MMS.</p> |
|
116 </div> |
|
117 </td> |
|
118 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
119 <p>string</p> |
|
120 </td> |
|
121 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> </td> |
|
122 </tr> |
|
123 <tr class=""> |
|
124 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
125 <p><code>[criteria.Filter.StartDate]</code></p> |
|
126 </td> |
|
127 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
128 <p>If only <code>StartDate</code> is specified, all messages received |
|
129 on or after this date are retrieved.</p> |
|
130 <p>If both <code>StartDate</code> and <code>EndDate</code> are |
|
131 specified, all messages received within these dates are retrieved.</p> |
|
132 <p>If <code>EndDate</code> is earlier than <code>StartDate</code>, |
|
133 an error is returned.</p> |
|
134 </td> |
|
135 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
136 <p>date object</p> |
|
137 </td> |
|
138 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> </td> |
|
139 </tr> |
|
140 <tr class="bg "> |
|
141 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
142 <p><code>[criteria.Filter.EndDate]</code></p> |
|
143 </td> |
|
144 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
145 <p>If only <code>EndDate</code> is specified, all messages received |
|
146 on or before this date are retrieved.</p> |
|
147 <p>If both <code>StartDate</code> and <code>EndDate</code> are |
|
148 specified, all messages received within these dates are retrieved.</p> |
|
149 <p>If <code>EndDate</code> is earlier than <code>StartDate</code>, |
|
150 an error is returned.</p> |
|
151 </td> |
|
152 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
153 <p>date object</p> |
|
154 </td> |
|
155 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> </td> |
|
156 </tr> |
|
157 <tr class=""> |
|
158 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
159 <p><code>[criteria.Sort]</code></p> |
|
160 </td> |
|
161 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
162 <p>Specifies how the returned list of information is sorted.</p> |
|
163 </td> |
|
164 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
165 <p>object</p> |
|
166 </td> |
|
167 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
168 <p>Object with the properties specified below</p> |
|
169 </td> |
|
170 </tr> |
|
171 <tr class="bg "> |
|
172 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
173 <p><code>[criteria.Sort.Key]</code></p> |
|
174 </td> |
|
175 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
176 <p>Specifies the value to sort by.</p> |
|
177 <div class="note"><p><strong class="note_title">Note: </strong>By default, sorting is done in ascending order based on <code>Date</code>.</p> |
|
178 </div> |
|
179 </td> |
|
180 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
181 <p>string</p> |
|
182 </td> |
|
183 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
184 <p>Possible values:</p> |
|
185 <ul> |
|
186 <li><p><code>"Date"</code></p></li> |
|
187 <li><p><code>"Size"</code></p></li> |
|
188 <li><p><code>"Sender"</code></p></li> |
|
189 <li><p><code>"Subject"</code></p></li> |
|
190 <li><p><code>"MessageId"</code></p></li> |
|
191 </ul> |
|
192 </td> |
|
193 </tr> |
|
194 <tr class=""> |
|
195 <td class="cellrowborder" valign="top" width="25%" headers="d0e58537 "> |
|
196 <p><code>[criteria.Sort.Order]</code></p> |
|
197 </td> |
|
198 <td class="cellrowborder" valign="top" width="25%" headers="d0e58542 "> |
|
199 <p>Specifies the sort order.</p> |
|
200 </td> |
|
201 <td class="cellrowborder" valign="top" width="25%" headers="d0e58547 "> |
|
202 <p>string</p> |
|
203 </td> |
|
204 <td class="cellrowborder" valign="top" width="25%" headers="d0e58552 "> |
|
205 <p>Possible values:</p> |
|
206 <ul> |
|
207 <li><p><code>"Ascending"</code></p></li> |
|
208 <li><p><code>"Descending"</code></p></li> |
|
209 </ul> |
|
210 </td> |
|
211 </tr> |
|
212 </tbody> |
|
213 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |