Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-74A4C52A-6150-4237-81B5-A864F01FADF5.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Tue, 11 May 2010 18:12:49 -0700
changeset 331 7e0aa6ca3db1
parent 229 716254ccbcc0
permissions -rw-r--r--
Removed 'beta' from the about screen


<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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">
      function initPage() {}
    </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>
<p><strong>Description:</strong></p>
<p>The <code>ChangeStatus</code> method changes the read status
of a message. The status can be <code>"Read"</code>, <code>"Unread"</code>, <code>"Replied"</code>,
or <code>"Forwarded"</code>.</p>
<p>This is a synchronous method.</p>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-821DB6C8-B042-465E-953C-15CEF323CF43">result = so.IMessaging.ChangeStatus(criteria);</pre>

<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>

<p>This is an object that specifies the message whose status to change
and the new status. The following table describes the properties of this object.</p>

</li>
</ul>
<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>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e61091">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e61096">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e61101">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e61106">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e61091 ">
<p><code>criteria.MessageId</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61096 ">
<p>Specifies the unique ID of the message whose status to change.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61101 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61106 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e61091 ">
<p><code>criteria.Status</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61096 ">
<p>Specifies the new read status for the message.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61101 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e61106 ">
<p>Possible values:</p>
<ul>
<li><p><code>"Read"</code></p></li>
<li><p><code>"Unread"</code></p></li>
<li><p><code>"Replied"</code></p></li>
<li><p><code>"Forwarded"</code></p></li>
</ul>
<p><code>Replied</code> and <code>Forwarded</code> are
only valid for email messages.</p>
<div class="note"><p><strong class="note_title">Note: </strong>The Messaging Service does not currently support emails.</p>
</div>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Return value:</strong></p>
<p>The <code>ChangeStatus</code> method returns an object that
contains an error code and an error message.</p>
<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
properties for ChangeStatus</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61230">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61235">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e61240">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61230 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61235 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61240 ">
<p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61230 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61235 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e61240 ">
<p>See <a href="GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A.html#GUID-1F17637B-4439-4FFE-AFD8-93D84B01666A">Messaging Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Example code:</strong></p>
<p/>
<p>For the complete source of a sample widget
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>


</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
FCL/sftools/dev/eclipseenv/wrttools