Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_s_m_s_engine_8h_source.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: examples/ForumNokia/SMSExample/Engine/inc/SMSEngine.h Source File</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 -->
<h1>examples/ForumNokia/SMSExample/Engine/inc/SMSEngine.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="preprocessor">#ifndef CSMSENGINE_H</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define CSMSENGINE_H</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="comment">// EXTERNAL INCLUDES</span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <e32base.h></span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">// INTERNAL INCLUDES</span>
<a name="l00012"></a>00012 <span class="preprocessor">#include "SMSExampleMtmsEngine.h"</span>
<a name="l00013"></a>00013
<a name="l00014"></a>00014 <span class="comment">// CONSTANTS</span>
<a name="l00015"></a>00015 <span class="keyword">const</span> TInt KSmsMessageLength = 512;
<a name="l00016"></a>00016 <span class="keyword">const</span> TInt KAddressLength = 64;
<a name="l00017"></a>00017
<a name="l00018"></a>00018
<a name="l00019"></a><a class="code" href="class_m_sms_engine_observer.html">00019</a> <span class="keyword">class </span><a class="code" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>
<a name="l00020"></a>00020 {
<a name="l00021"></a>00021 <span class="keyword">public</span>:
<a name="l00022"></a>00022 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendingMessage()=0;
<a name="l00023"></a>00023 <span class="keyword">virtual</span> <span class="keywordtype">void</span> MessageSent()=0;
<a name="l00024"></a>00024 <span class="keyword">virtual</span> <span class="keywordtype">void</span> MessageReceived(<span class="keyword">const</span> TDesC& addr, <span class="keyword">const</span> TDesC& msg)=0;
<a name="l00025"></a>00025 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SmsEngineInitialized()=0;
<a name="l00026"></a>00026 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SmsEngineError(TInt aErrorCode)=0;
<a name="l00027"></a>00027 <span class="keyword">virtual</span> <span class="keywordtype">void</span> MessageDeleted()=0; <span class="comment">//if automatic deletion is on</span>
<a name="l00028"></a>00028 };
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="comment">// CLASS DEFINITION</span>
<a name="l00040"></a><a class="code" href="class_c_sms_engine.html">00040</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_c_sms_engine.html">CSmsEngine</a> : <span class="keyword">public</span> CBase, <span class="keyword">public</span> MMsvSessionObserver, <span class="keyword">public</span> <a class="code" href="class_m_s_m_s_example_mtms_engine_observer.html">MSMSExampleMtmsEngineObserver</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>: <span class="comment">// Constructors and destructor</span>
<a name="l00043"></a>00043
<a name="l00048"></a>00048 IMPORT_C <span class="keyword">static</span> <a class="code" href="class_c_sms_engine.html">CSmsEngine</a>* <a class="code" href="class_c_sms_engine.html#a4dcdb46ce3828113f1e1c22e7acfb308">NewL</a>(<a class="code" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>& aObserver);
<a name="l00049"></a>00049
<a name="l00054"></a>00054 IMPORT_C <span class="keyword">static</span> <a class="code" href="class_c_sms_engine.html">CSmsEngine</a>* <a class="code" href="class_c_sms_engine.html#a1ddd2c41d4e9113c2fc0891e3a610dc0">NewLC</a>(<a class="code" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>& aObserver);
<a name="l00055"></a>00055
<a name="l00059"></a>00059 IMPORT_C <a class="code" href="class_c_sms_engine.html#a5d8fbeef13bd9eab231b1f3bdd3364a6">~CSmsEngine</a>();
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">public</span>: <span class="comment">//new functions</span>
<a name="l00067"></a>00067 <span class="comment"></span> IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#abc9baa422d3bbcff19604eb6f29e3ace">SendSmsL</a>(<span class="keyword">const</span> TDesC& aAddr, <span class="keyword">const</span> TDesC&aMsg); <span class="comment">//nyt CreateSmsMessage, validateCreatedSms ja SendSms, laita kaikki piiloon</span>
<a name="l00068"></a>00068
<a name="l00074"></a>00074 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#a46b8a49fd6c0aeb87745b434c8f320d3">ListenforIncomingSms</a>(TBool aListening);
<a name="l00075"></a>00075
<a name="l00081"></a>00081 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#a769576b9d15321932b045d13210d906f">SetAutomaticDeletetion</a>(TBool aDeletion);
<a name="l00082"></a>00082
<a name="l00083"></a>00083
<a name="l00091"></a>00091 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#acd15ac630458ed527e065a211833b803">GetFolderSMSMessageInformationL</a>(TMsvId aFolderID,
<a name="l00092"></a>00092 CDesCArrayFlat*& aAddresses,
<a name="l00093"></a>00093 CDesCArrayFlat*& aMessages);
<a name="l00094"></a>00094
<a name="l00103"></a>00103 IMPORT_C RArray<TMsvId>* <a class="code" href="class_c_sms_engine.html#a6cae31610a4a889dfd00d3e53bdb8190">GetMessageIds</a>();
<a name="l00104"></a>00104
<a name="l00110"></a>00110 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#a85da6359d90aeabd5810c4be104e6ad0">CopyMessageL</a>( TMsvId aMessageId, TMsvId aFolder );
<a name="l00111"></a>00111
<a name="l00117"></a>00117 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#a5cbacae54ead39a1698ad03302d426d2">MoveToFolderL</a>( TMsvId aMessageId, TMsvId aFolder );
<a name="l00118"></a>00118
<a name="l00123"></a>00123 IMPORT_C <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#ae74f33d236922387739a57b194f54c10">DeleteMessageL</a>( TMsvId aMessageId );
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keyword">public</span>: <span class="comment">//from base classes</span>
<a name="l00126"></a>00126
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#ac46cff0197f2594500352be7f04d1c1e">HandleSessionEventL</a>(TMsvSessionEvent aEvent, TAny* aArg1, TAny* aArg2, TAny* aArg3);
<a name="l00131"></a>00131
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="class_c_sms_engine.html#ae6d43a806c5d1d5ebf7c0dc74272d282">HandleMessageSentL</a>(TInt aError);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">private</span>: <span class="comment">// Constructors</span>
<a name="l00138"></a>00138
<a name="l00143"></a>00143 <a class="code" href="class_c_sms_engine.html">CSmsEngine</a>(<a class="code" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>& aObserver);
<a name="l00144"></a>00144
<a name="l00148"></a>00148 <span class="keywordtype">void</span> ConstructL();
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">private</span>:
<a name="l00151"></a>00151
<a name="l00158"></a>00158 <span class="keywordtype">void</span> SendSmsInThirdEditionL(<span class="keyword">const</span> TDesC& aAddr, <span class="keyword">const</span> TDesC& aMsg);
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keyword">private</span>: <span class="comment">// Data</span>
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">//The observer</span>
<a name="l00163"></a>00163 <a class="code" href="class_m_sms_engine_observer.html">MSmsEngineObserver</a>& iObserver;
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">// SMS engine</span>
<a name="l00166"></a>00166 <a class="code" href="class_c_s_m_s_example_mtms_engine.html">CSMSExampleMtmsEngine</a>* iEngine;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">// Parser that searches phone numbers</span>
<a name="l00169"></a>00169 <span class="comment">//CSMSExampleParser* iParser;</span>
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="comment">// Recipient address</span>
<a name="l00172"></a>00172 TBuf<KAddressLength> iAddress;
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="comment">// Message body</span>
<a name="l00175"></a>00175 TBuf<KSmsMessageLength> iMessage;
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="comment">// ETrue is automatic delete is on, EFalse otherwise</span>
<a name="l00178"></a>00178 TBool iAutomaticDelete;
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="comment">// are we listening for incoming messages</span>
<a name="l00181"></a>00181 TBool iListeningForIncoming;
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment">// Session with the messaging server</span>
<a name="l00184"></a>00184 CMsvSession* iMsvSession;
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">// CMsvEntry accesses and acts upon a particular Message Server entry</span>
<a name="l00187"></a>00187 CMsvEntry* iMsvEntry;
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">// Id of a new message</span>
<a name="l00190"></a>00190 TMsvId iNewMessageId;
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="comment">// Id of the sent message</span>
<a name="l00193"></a>00193 TMsvId iSentMessageId;
<a name="l00194"></a>00194
<a name="l00195"></a>00195 };
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="comment">// INLINE FUNCTIONS</span>
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="preprocessor">#endif // CSMSENGINE_H</span>
<a name="l00200"></a>00200 <span class="preprocessor"></span>
<a name="l00201"></a>00201 <span class="comment">// End of file</span>
</pre></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>