|
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.ChangeStatus()"/><meta name="DC.Relation" scheme="URI" content="GUID-BE6FB5B3-020A-44F3-A4AC-DFD0FEA42B7A"/><meta name="DC.Relation" scheme="URI" content="GUID-E2FDB3FB-2B5E-430C-81B5-9C0C22C4CC04"/><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-74A4C52A-6150-4237-81B5-A864F01FADF5"/><title>IMessaging.ChangeStatus() </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-74A4C52A-6150-4237-81B5-A864F01FADF5"><span>IMessaging.</span>ChangeStatus()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>ChangeStatus</code> method changes the read status |
|
9 of a message. The status can be <code>"Read"</code>, <code>"Unread"</code>, <code>"Replied"</code>, |
|
10 or <code>"Forwarded"</code>.</p> |
|
11 <p>This is a synchronous method.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 <pre class="codeblock" id="GUID-821DB6C8-B042-465E-953C-15CEF323CF43">result = so.IMessaging.ChangeStatus(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 the message whose status to change |
|
20 and the new status. The following table describes the properties of this object.</p> |
|
21 |
|
22 </li> |
|
23 </ul> |
|
24 <div class="tablenoborder"><a name="GUID-E58F3C4E-7181-48F3-AE31-0F2CC921F092"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-E58F3C4E-7181-48F3-AE31-0F2CC921F092" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
25 |
|
26 <thead align="left"> |
|
27 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e61091"> |
|
28 <p>Property</p> |
|
29 </th><th class="cellrowborder" valign="top" width="25%" id="d0e61096"> |
|
30 <p>Description</p> |
|
31 </th><th class="cellrowborder" valign="top" width="25%" id="d0e61101"> |
|
32 <p>Type</p> |
|
33 </th><th class="cellrowborder" valign="top" width="25%" id="d0e61106"> |
|
34 <p>Value</p> |
|
35 </th></tr> |
|
36 </thead> |
|
37 <tbody> |
|
38 <tr class=""> |
|
39 <td class="cellrowborder" valign="top" width="25%" headers="d0e61091 "> |
|
40 <p><code>criteria.MessageId</code></p> |
|
41 </td> |
|
42 <td class="cellrowborder" valign="top" width="25%" headers="d0e61096 "> |
|
43 <p>Specifies the unique ID of the message whose status to change.</p> |
|
44 </td> |
|
45 <td class="cellrowborder" valign="top" width="25%" headers="d0e61101 "> |
|
46 <p>number</p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="25%" headers="d0e61106 "> </td> |
|
49 </tr> |
|
50 <tr class="bg "> |
|
51 <td class="cellrowborder" valign="top" width="25%" headers="d0e61091 "> |
|
52 <p><code>criteria.Status</code></p> |
|
53 </td> |
|
54 <td class="cellrowborder" valign="top" width="25%" headers="d0e61096 "> |
|
55 <p>Specifies the new read status for the message.</p> |
|
56 </td> |
|
57 <td class="cellrowborder" valign="top" width="25%" headers="d0e61101 "> |
|
58 <p>string</p> |
|
59 </td> |
|
60 <td class="cellrowborder" valign="top" width="25%" headers="d0e61106 "> |
|
61 <p>Possible values:</p> |
|
62 <ul> |
|
63 <li><p><code>"Read"</code></p></li> |
|
64 <li><p><code>"Unread"</code></p></li> |
|
65 <li><p><code>"Replied"</code></p></li> |
|
66 <li><p><code>"Forwarded"</code></p></li> |
|
67 </ul> |
|
68 <p><code>Replied</code> and <code>Forwarded</code> are |
|
69 only valid for email messages.</p> |
|
70 <div class="note"><p><strong class="note_title">Note: </strong>The Messaging Service does not currently support emails.</p> |
|
71 </div> |
|
72 </td> |
|
73 </tr> |
|
74 </tbody> |
|
75 </table></div> |
|
76 <p><strong>Return value:</strong></p> |
|
77 <p>The <code>ChangeStatus</code> method returns an object that |
|
78 contains an error code and an error message.</p> |
|
79 <div class="tablenoborder"><a name="GUID-321B3CED-08F7-44B7-B5C7-ADFCFF0897E0"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-321B3CED-08F7-44B7-B5C7-ADFCFF0897E0" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
80 properties for ChangeStatus</caption> |
|
81 |
|
82 <thead align="left"> |
|
83 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61230"> |
|
84 <p>Property</p> |
|
85 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61235"> |
|
86 <p>Description</p> |
|
87 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61240"> |
|
88 <p>Value</p> |
|
89 </th></tr> |
|
90 </thead> |
|
91 <tbody> |
|
92 <tr class=""> |
|
93 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61230 "> |
|
94 <p><code>result.ErrorCode</code></p> |
|
95 </td> |
|
96 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61235 "> |
|
97 <p>This is a number that specifies a predefined error code.</p> |
|
98 </td> |
|
99 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61240 "> |
|
100 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
101 </td> |
|
102 </tr> |
|
103 <tr class="bg "> |
|
104 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61230 "> |
|
105 <p><code>result.ErrorMessage</code></p> |
|
106 </td> |
|
107 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61235 "> |
|
108 <p>This is a text string that describes the error.</p> |
|
109 </td> |
|
110 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61240 "> |
|
111 <p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p> |
|
112 </td> |
|
113 </tr> |
|
114 </tbody> |
|
115 </table></div> |
|
116 <p><strong>Example code:</strong></p> |
|
117 <p/> |
|
118 <p>For the complete source of a sample widget |
|
119 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> |
|
120 |
|
121 |
|
122 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |