Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_sms_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: CSmsEngine 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>CSmsEngine Class Reference</h1><!-- doxytag: class="CSmsEngine" --><!-- doxytag: inherits="MSMSExampleMtmsEngineObserver" -->
<p>Inherits <a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a>.</p>
<p><a href="class_c_sms_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">IMPORT_C </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a5d8fbeef13bd9eab231b1f3bdd3364a6">~CSmsEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#abc9baa422d3bbcff19604eb6f29e3ace">SendSmsL</a> (const TDesC &aAddr, const TDesC &aMsg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a46b8a49fd6c0aeb87745b434c8f320d3">ListenforIncomingSms</a> (TBool aListening)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a769576b9d15321932b045d13210d906f">SetAutomaticDeletetion</a> (TBool aDeletion)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#acd15ac630458ed527e065a211833b803">GetFolderSMSMessageInformationL</a> (TMsvId aFolderID, CDesCArrayFlat *&aAddresses, CDesCArrayFlat *&aMessages)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C RArray< TMsvId > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a6cae31610a4a889dfd00d3e53bdb8190">GetMessageIds</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a85da6359d90aeabd5810c4be104e6ad0">CopyMessageL</a> (TMsvId aMessageId, TMsvId aFolder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a5cbacae54ead39a1698ad03302d426d2">MoveToFolderL</a> (TMsvId aMessageId, TMsvId aFolder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#ae74f33d236922387739a57b194f54c10">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_sms_engine.html#ac46cff0197f2594500352be7f04d1c1e">HandleSessionEventL</a> (TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#ae6d43a806c5d1d5ebf7c0dc74272d282">HandleMessageSentL</a> (TInt aError)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static IMPORT_C <a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a4dcdb46ce3828113f1e1c22e7acfb308">NewL</a> (<a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a> &aObserver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static IMPORT_C <a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sms_engine.html#a1ddd2c41d4e9113c2fc0891e3a610dc0">NewLC</a> (<a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a> &aObserver)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class <a class="el" href="class_c_sms_engine.html">CSmsEngine</a> wraps the <a class="el" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a> class and offers an easy to use interface for basic SMS functionality.</p>
<p>There are a couple of "almost implemented" features, like deleting the sent message and checking for a response to the sent message. Also some spesial error situations are described in code comments. </p>
<p>Definition at line <a class="el" href="_s_m_s_engine_8h_source.html#l00040">40</a> of file <a class="el" href="_s_m_s_engine_8h_source.html">SMSEngine.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5d8fbeef13bd9eab231b1f3bdd3364a6"></a><!-- doxytag: member="CSmsEngine::~CSmsEngine" ref="a5d8fbeef13bd9eab231b1f3bdd3364a6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C CSmsEngine::~CSmsEngine </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="_sms_engine_8cpp_source.html#l00048">48</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4dcdb46ce3828113f1e1c22e7acfb308"></a><!-- doxytag: member="CSmsEngine::NewL" ref="a4dcdb46ce3828113f1e1c22e7acfb308" args="(MSmsEngineObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C <a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * CSmsEngine::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL </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>the observer </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00033">33</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ddd2c41d4e9113c2fc0891e3a610dc0"></a><!-- doxytag: member="CSmsEngine::NewLC" ref="a1ddd2c41d4e9113c2fc0891e3a610dc0" args="(MSmsEngineObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C <a class="el" href="class_c_sms_engine.html">CSmsEngine</a> * CSmsEngine::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL </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>the observer </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00040">40</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abc9baa422d3bbcff19604eb6f29e3ace"></a><!-- doxytag: member="CSmsEngine::SendSmsL" ref="abc9baa422d3bbcff19604eb6f29e3ace" args="(const TDesC &aAddr, const TDesC &aMsg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::SendSmsL </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aMsg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sending a 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>aAddr</em> </td><td>the receiver address </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMsg</em> </td><td>the message to send </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00308">308</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a46b8a49fd6c0aeb87745b434c8f320d3"></a><!-- doxytag: member="CSmsEngine::ListenforIncomingSms" ref="a46b8a49fd6c0aeb87745b434c8f320d3" args="(TBool aListening)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::ListenforIncomingSms </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aListening</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This enables the client not to listen for incoming messages. By default client receives notitycation when messages arrive </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em></em> </td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00350">350</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a769576b9d15321932b045d13210d906f"></a><!-- doxytag: member="CSmsEngine::SetAutomaticDeletetion" ref="a769576b9d15321932b045d13210d906f" args="(TBool aDeletion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::SetAutomaticDeletetion </td>
<td>(</td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aDeletion</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Do we delete the received message automatically. Default is no. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em></em> </td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00358">358</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd15ac630458ed527e065a211833b803"></a><!-- doxytag: member="CSmsEngine::GetFolderSMSMessageInformationL" ref="acd15ac630458ed527e065a211833b803" args="(TMsvId aFolderID, CDesCArrayFlat *&aAddresses, CDesCArrayFlat *&aMessages)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::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>A main function in viewing folder contect. For usage see GUI's AppUi class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aFolderId</em> </td><td>the folder </td></tr>
<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="_sms_engine_8cpp_source.html#l00366">366</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6cae31610a4a889dfd00d3e53bdb8190"></a><!-- doxytag: member="CSmsEngine::GetMessageIds" ref="a6cae31610a4a889dfd00d3e53bdb8190" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C RArray< TMsvId > * CSmsEngine::GetMessageIds </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used in getting the message Ids to GUI's listbox id array. Note that GetFolderSMSMessageInformationL has to have been called first so the id's for the folder have been collocted. For usage see GUI's <a class="el" href="class_c_listbox_view.html">CListboxView</a> class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>array of ids </dd></dl>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00375">375</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a85da6359d90aeabd5810c4be104e6ad0"></a><!-- doxytag: member="CSmsEngine::CopyMessageL" ref="a85da6359d90aeabd5810c4be104e6ad0" args="(TMsvId aMessageId, TMsvId aFolder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::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>Copying a message to a specified 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="_sms_engine_8cpp_source.html#l00381">381</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5cbacae54ead39a1698ad03302d426d2"></a><!-- doxytag: member="CSmsEngine::MoveToFolderL" ref="a5cbacae54ead39a1698ad03302d426d2" args="(TMsvId aMessageId, TMsvId aFolder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::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>Moving a message to a specified 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="_sms_engine_8cpp_source.html#l00387">387</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae74f33d236922387739a57b194f54c10"></a><!-- doxytag: member="CSmsEngine::DeleteMessageL" ref="ae74f33d236922387739a57b194f54c10" args="(TMsvId aMessageId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void CSmsEngine::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>Deleting a 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="_sms_engine_8cpp_source.html#l00393">393</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac46cff0197f2594500352be7f04d1c1e"></a><!-- doxytag: member="CSmsEngine::HandleSessionEventL" ref="ac46cff0197f2594500352be7f04d1c1e" args="(TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSmsEngine::HandleSessionEventL </td>
<td>(</td>
<td class="paramtype">TMsvSessionEvent </td>
<td class="paramname"> <em>aEvent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg3</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From MMsvSessionObserver </p>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00077">77</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae6d43a806c5d1d5ebf7c0dc74272d282"></a><!-- doxytag: member="CSmsEngine::HandleMessageSentL" ref="ae6d43a806c5d1d5ebf7c0dc74272d282" args="(TInt aError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSmsEngine::HandleMessageSentL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From <a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a> </p>
<p>Implements <a class="el" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a>.</p>
<p>Definition at line <a class="el" href="_sms_engine_8cpp_source.html#l00295">295</a> of file <a class="el" href="_sms_engine_8cpp_source.html">SmsEngine.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>