|
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="IMessaging.GetList()"/><meta name="DC.Relation" scheme="URI" content="GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB"/><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.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-C12C81D1-13A4-4B8C-81B9-694D414A4A48"/><title>IMessaging.GetList() </title><script type="text/javascript"> |
|
5 function initPage() {} |
|
6 </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-C12C81D1-13A4-4B8C-81B9-694D414A4A48"><span>IMessaging.</span>GetList()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetList</code> method retrieves a list of messaging |
|
9 objects from the Messaging Center of the S60 device. Each object contains |
|
10 messaging information, that is, header and content data for a single message.</p> |
|
11 <p>This is a synchronous method.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 <pre class="codeblock" id="GUID-2D4C231F-8EE3-4092-AF17-E71B29685228">result = so.IMessaging.GetList(criteria);</pre> |
|
14 |
|
15 <p><strong>Arguments:</strong></p> |
|
16 <ul> |
|
17 <li><p><code>criteria</code>:</p> |
|
18 |
|
19 <p>This is an object that specifies what messaging information is returned |
|
20 and how the returned information is sorted. For more information about the |
|
21 object properties and how to define them, see section <a href="GUID-5720512C-9198-4883-81B1-46F1B963C6B9.html#GUID-5720512C-9198-4883-81B1-46F1B963C6B9">Criteria for retrieving messaging information</a>.</p> |
|
22 |
|
23 </li> |
|
24 </ul> |
|
25 <p><strong>Return value:</strong></p> |
|
26 <p>The <code>GetList</code> method returns an object that contains |
|
27 the requested messaging information, an error code, and an error message.</p> |
|
28 <div class="tablenoborder"><a name="GUID-C6726530-BC9B-4982-9579-8F95692BB379"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-C6726530-BC9B-4982-9579-8F95692BB379" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
29 properties for GetList</caption> |
|
30 |
|
31 <thead align="left"> |
|
32 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e58357"> |
|
33 <p>Property</p> |
|
34 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e58362"> |
|
35 <p>Description</p> |
|
36 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e58367"> |
|
37 <p>Value</p> |
|
38 </th></tr> |
|
39 </thead> |
|
40 <tbody> |
|
41 <tr class=""> |
|
42 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58357 "> |
|
43 <p><code>result.ReturnValue</code></p> |
|
44 </td> |
|
45 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58362 "> |
|
46 <p>This is an iterator that contains the requested messaging information.</p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58367 "> |
|
49 <p>See <a href="GUID-C8571941-AD6E-4FAD-B4A1-35E7BDB99689.html#GUID-C8571941-AD6E-4FAD-B4A1-35E7BDB99689">Returned messaging information</a>.</p> |
|
50 </td> |
|
51 </tr> |
|
52 <tr class="bg "> |
|
53 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58357 "> |
|
54 <p><code>result.ErrorCode</code></p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58362 "> |
|
57 <p>This is a number that specifies a predefined error code.</p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58367 "> |
|
60 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
61 </td> |
|
62 </tr> |
|
63 <tr class=""> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58357 "> |
|
65 <p><code>result.ErrorMessage</code></p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58362 "> |
|
68 <p>This is a text string that describes the error.</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e58367 "> |
|
71 <p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p> |
|
72 </td> |
|
73 </tr> |
|
74 </tbody> |
|
75 </table></div> |
|
76 <p><strong>Remarks:</strong></p> |
|
77 <p>To access information about individual messages, iterate through the |
|
78 list of objects contained in <code>result.ReturnValue</code>.</p> |
|
79 <p><strong>Example code:</strong></p> |
|
80 <p/> |
|
81 <p>For the complete source of a sample widget |
|
82 that demonstrates how to use this Service API, see <a href="GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B.html#GUID-DBF41DB5-44D7-4822-A611-FBF7DA3A8F3B">the full example</a>.</p> |
|
83 |
|
84 |
|
85 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |