Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_s_m_s_example_mtms_engine.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: CSMSExampleMtmsEngine Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CSMSExampleMtmsEngine Class Reference</h1><!-- doxytag: class="CSMSExampleMtmsEngine" -->
<p><a href="class_c_s_m_s_example_mtms_engine-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a7873afb32e7c26392959cc6d5bae3925">~CSMSExampleMtmsEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a5290be4e1e51624dd93a32481cd232ab">MoveToFolderL</a> (TMsvId aMessageId, TMsvId aFolder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a984ee82d84638e17466f90e3361518dc">DeleteMessageL</a> (TMsvId aMessageId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a97fe65f73c36e75f95dfa5f74fccb3f2">CopyMessageL</a> (TMsvId aMessageId, TMsvId aFolder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a77cafdea7482dfe45f713806ea98aff0">GetMessageAddressL</a> (TMsvId aMessageId, TDes &aAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a47cec0be7fbd4b7c3eeb5c568a560693">GetMessageL</a> (TMsvId aMessageId, TDes &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#aaf1586b4d36213206e5ad65915538354">GetMessageIndexBodyTextL</a> (TMsvId aMessageId, TDes &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#a190337cfafc2bd34b742af77e6c40a3e">GetFolderSMSMessageInformationL</a> (TMsvId aFolderID, CDesCArrayFlat *&aAddresses, CDesCArrayFlat *&aMessages)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RArray< TMsvId > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#ab5f0023ce3f3d8d4214a43019671d9f9">GetMessageIds</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_m_s_example_mtms_engine.html#ae9012c6beffaf400409c0d2966838474">NewL</a> (<a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a> &aObserver)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>SMS engine handles SMS message handling (i.e moving, deleting, copying, retrieving message data). </p>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8h_source.html#l00024">24</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8h_source.html">SMSExampleMtmsEngine.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7873afb32e7c26392959cc6d5bae3925"></a><!-- doxytag: member="CSMSExampleMtmsEngine::~CSMSExampleMtmsEngine" ref="a7873afb32e7c26392959cc6d5bae3925" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSMSExampleMtmsEngine::~CSMSExampleMtmsEngine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00073">73</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae9012c6beffaf400409c0d2966838474"></a><!-- doxytag: member="CSMSExampleMtmsEngine::NewL" ref="ae9012c6beffaf400409c0d2966838474" args="(MSMSExampleMtmsEngineObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a> * CSMSExampleMtmsEngine::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new <a class="el" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a> object</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aObserver</em> </td><td>a reference to <a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the created instance of <a class="el" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a> </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00027">27</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5290be4e1e51624dd93a32481cd232ab"></a><!-- doxytag: member="CSMSExampleMtmsEngine::MoveToFolderL" ref="a5290be4e1e51624dd93a32481cd232ab" args="(TMsvId aMessageId, TMsvId aFolder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleMtmsEngine::MoveToFolderL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aFolder</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move an SMS message to folder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aFolder</em> </td><td>target folder id. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00101">101</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a984ee82d84638e17466f90e3361518dc"></a><!-- doxytag: member="CSMSExampleMtmsEngine::DeleteMessageL" ref="a984ee82d84638e17466f90e3361518dc" args="(TMsvId aMessageId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleMtmsEngine::DeleteMessageL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete an SMS message. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00116">116</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a97fe65f73c36e75f95dfa5f74fccb3f2"></a><!-- doxytag: member="CSMSExampleMtmsEngine::CopyMessageL" ref="a97fe65f73c36e75f95dfa5f74fccb3f2" args="(TMsvId aMessageId, TMsvId aFolder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleMtmsEngine::CopyMessageL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aFolder</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy an SMS message to folder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aFolder</em> </td><td>target folder id. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00203">203</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a77cafdea7482dfe45f713806ea98aff0"></a><!-- doxytag: member="CSMSExampleMtmsEngine::GetMessageAddressL" ref="a77cafdea7482dfe45f713806ea98aff0" args="(TMsvId aMessageId, TDes &aAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleMtmsEngine::GetMessageAddressL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aAddress</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the originator address. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAddress</em> </td><td>originator address. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00126">126</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a47cec0be7fbd4b7c3eeb5c568a560693"></a><!-- doxytag: member="CSMSExampleMtmsEngine::GetMessageL" ref="a47cec0be7fbd4b7c3eeb5c568a560693" args="(TMsvId aMessageId, TDes &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CSMSExampleMtmsEngine::GetMessageL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the message body from the messaging store. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>the message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ETrue if message correspongin aMessageId is valid SMS (.sis files / settings are filtered out), EFalse otherwise. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00143">143</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaf1586b4d36213206e5ad65915538354"></a><!-- doxytag: member="CSMSExampleMtmsEngine::GetMessageIndexBodyTextL" ref="aaf1586b4d36213206e5ad65915538354" args="(TMsvId aMessageId, TDes &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CSMSExampleMtmsEngine::GetMessageIndexBodyTextL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aMessageId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the message body summary information(just the beginning of body) </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessageID</em> </td><td>id of an SMS message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>the beginning of message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ETrue if message correspongin aMessageId is valid SMS (.sis files / settings are filtered out), EFalse otherwise. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00192">192</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a190337cfafc2bd34b742af77e6c40a3e"></a><!-- doxytag: member="CSMSExampleMtmsEngine::GetFolderSMSMessageInformationL" ref="a190337cfafc2bd34b742af77e6c40a3e" args="(TMsvId aFolderID, CDesCArrayFlat *&aAddresses, CDesCArrayFlat *&aMessages)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSMSExampleMtmsEngine::GetFolderSMSMessageInformationL </td>
<td>(</td>
<td class="paramtype">TMsvId </td>
<td class="paramname"> <em>aFolderID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CDesCArrayFlat *& </td>
<td class="paramname"> <em>aAddresses</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CDesCArrayFlat *& </td>
<td class="paramname"> <em>aMessages</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve one folder's SMS messages (their address+message body). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aAddresses</em> </td><td>Array of recipient addresses </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMessages</em> </td><td>Array of message bodys. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00226">226</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab5f0023ce3f3d8d4214a43019671d9f9"></a><!-- doxytag: member="CSMSExampleMtmsEngine::GetMessageIds" ref="ab5f0023ce3f3d8d4214a43019671d9f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RArray< TMsvId > * CSMSExampleMtmsEngine::GetMessageIds </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>All ids of messages that has been got with GetFolderSMSMessageInformationL. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of ids. </dd></dl>
<p>Definition at line <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html#l00217">217</a> of file <a class="el" href="_s_m_s_example_mtms_engine_8cpp_source.html">SMSExampleMtmsEngine.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>