williamr@2
|
1 |
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
|
williamr@2
|
2 |
// All rights reserved.
|
williamr@2
|
3 |
// This component and the accompanying materials are made available
|
williamr@2
|
4 |
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
|
williamr@2
|
5 |
// which accompanies this distribution, and is available
|
williamr@2
|
6 |
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
|
williamr@2
|
7 |
//
|
williamr@2
|
8 |
// Initial Contributors:
|
williamr@2
|
9 |
// Nokia Corporation - initial contribution.
|
williamr@2
|
10 |
//
|
williamr@2
|
11 |
// Contributors:
|
williamr@2
|
12 |
//
|
williamr@2
|
13 |
// Description:
|
williamr@2
|
14 |
//
|
williamr@2
|
15 |
|
williamr@2
|
16 |
#ifndef __SMUTHDR_H__
|
williamr@2
|
17 |
#define __SMUTHDR_H__
|
williamr@2
|
18 |
|
williamr@2
|
19 |
#include <e32base.h>
|
williamr@2
|
20 |
#include <gsmubuf.h>
|
williamr@2
|
21 |
#include <bif.h>
|
williamr@2
|
22 |
#include <gsmupdu.h>
|
williamr@2
|
23 |
#include <msvstd.h>
|
williamr@2
|
24 |
#include <smutset.h>
|
williamr@2
|
25 |
|
williamr@2
|
26 |
class RMsvReadStream;
|
williamr@2
|
27 |
class RMsvWriteStream;
|
williamr@2
|
28 |
class CMsvStore;
|
williamr@2
|
29 |
class CSmsEmailFields;
|
williamr@2
|
30 |
|
williamr@2
|
31 |
/**
|
williamr@2
|
32 |
The SMS MTM encapsulation of an SMS message.
|
williamr@2
|
33 |
|
williamr@2
|
34 |
This class allows a messaging client to access the lower-level message encapsulation
|
williamr@2
|
35 |
used by the SMS stack.
|
williamr@2
|
36 |
|
williamr@2
|
37 |
It also provides functionality to restore and store an SMS message from/to the
|
williamr@2
|
38 |
message store.
|
williamr@2
|
39 |
|
williamr@2
|
40 |
An SMS message is encapsulated in a Protocol Data Unit (PDU). In GSM there are
|
williamr@2
|
41 |
six types of SMS message PDU. In the descriptions below, SC means Service Center
|
williamr@2
|
42 |
and MS means Mobile Station (the phone).
|
williamr@2
|
43 |
|
williamr@2
|
44 |
1. SMS-DELIVER - sent from SC to MS
|
williamr@2
|
45 |
|
williamr@2
|
46 |
2. SMS-DELIVER-REPORT - sent from MS to SC
|
williamr@2
|
47 |
|
williamr@2
|
48 |
3. SMS-SUBMIT - sent from MS to SC
|
williamr@2
|
49 |
|
williamr@2
|
50 |
4. SMS-SUBMIT-REPORT - sent from SC to MS
|
williamr@2
|
51 |
|
williamr@2
|
52 |
5. SMS-STATUS-REPORT - sent from SC to MS
|
williamr@2
|
53 |
|
williamr@2
|
54 |
6. SMS-COMMAND - sent from MS to SC
|
williamr@2
|
55 |
|
williamr@2
|
56 |
@publishedAll
|
williamr@2
|
57 |
@released
|
williamr@2
|
58 |
*/
|
williamr@2
|
59 |
class CSmsHeader : public CBase
|
williamr@2
|
60 |
{
|
williamr@2
|
61 |
public:
|
williamr@2
|
62 |
|
williamr@2
|
63 |
IMPORT_C static CSmsHeader* NewL(CSmsPDU::TSmsPDUType aType,CEditableText& aText);
|
williamr@2
|
64 |
IMPORT_C static CSmsHeader* NewL(CSmsPDU::TSmsPDUType aType,CEditableText& aText,RFs& aFs);
|
williamr@2
|
65 |
IMPORT_C static CSmsHeader* NewL(CSmsMessage* aMessage);
|
williamr@2
|
66 |
IMPORT_C ~CSmsHeader();
|
williamr@2
|
67 |
|
williamr@2
|
68 |
inline CSmsPDU::TSmsPDUType Type() const;
|
williamr@2
|
69 |
|
williamr@2
|
70 |
inline CSmsSubmit& Submit();
|
williamr@2
|
71 |
inline const CSmsSubmit& Submit() const;
|
williamr@2
|
72 |
inline CSmsDeliver& Deliver();
|
williamr@2
|
73 |
inline const CSmsDeliver& Deliver() const;
|
williamr@2
|
74 |
inline CSmsCommand& Command();
|
williamr@2
|
75 |
inline const CSmsCommand& Command() const;
|
williamr@2
|
76 |
inline CSmsStatusReport& StatusReport();
|
williamr@2
|
77 |
inline const CSmsStatusReport& StatusReport() const;
|
williamr@2
|
78 |
|
williamr@2
|
79 |
inline CSmsMessage& Message();
|
williamr@2
|
80 |
inline const CSmsMessage& Message() const;
|
williamr@2
|
81 |
|
williamr@2
|
82 |
inline TBool ReplyPathProvided() const;
|
williamr@2
|
83 |
inline void SetReplyPathProvided(TBool aReplyPathProvided);
|
williamr@2
|
84 |
|
williamr@2
|
85 |
inline TBioMsgIdType BioMsgIdType() const;
|
williamr@2
|
86 |
inline void SetBioMsgIdType(TBioMsgIdType aBioMsgIdType = EBioMsgIdNbs);
|
williamr@2
|
87 |
|
williamr@2
|
88 |
inline TPtrC ServiceCenterAddress() const;
|
williamr@2
|
89 |
inline void SetServiceCenterAddressL(const TDesC& aAddress);
|
williamr@2
|
90 |
|
williamr@2
|
91 |
IMPORT_C void SetSmsSettingsL(const CSmsMessageSettings& aSmsSettings);
|
williamr@2
|
92 |
IMPORT_C void GetSmsSettingsL(CSmsMessageSettings& aSmsSettings) const;
|
williamr@2
|
93 |
|
williamr@2
|
94 |
inline const CArrayPtrFlat<CSmsNumber>& Recipients() const;
|
williamr@2
|
95 |
inline CArrayPtrFlat<CSmsNumber>& Recipients();
|
williamr@2
|
96 |
|
williamr@2
|
97 |
inline void SetFromAddressL(const TDesC& aAddress);
|
williamr@2
|
98 |
inline TPtrC FromAddress() const;
|
williamr@2
|
99 |
|
williamr@2
|
100 |
TPtrC ReplyAddressL() const;
|
williamr@2
|
101 |
|
williamr@2
|
102 |
IMPORT_C void SetEmailFieldsL(const CSmsEmailFields& aEmailFields);
|
williamr@2
|
103 |
void SetReplyEmailFieldsL(const CSmsEmailFields& aEmailFields, const TDesC& aReplySubjectFormat);
|
williamr@2
|
104 |
void SetForwardEmailFieldsL(const CSmsEmailFields& aEmailFields, const TDesC& aForwardSubjectFormat);
|
williamr@2
|
105 |
IMPORT_C const CSmsEmailFields& EmailFields() const;
|
williamr@2
|
106 |
|
williamr@2
|
107 |
IMPORT_C void InternalizeL( RMsvReadStream& aStream);
|
williamr@2
|
108 |
IMPORT_C void ExternalizeL( RMsvWriteStream& aStream) const;
|
williamr@2
|
109 |
|
williamr@2
|
110 |
IMPORT_C void RestoreL(CMsvStore& aStore);
|
williamr@2
|
111 |
IMPORT_C void StoreL(CMsvStore& aStore) const;
|
williamr@2
|
112 |
|
williamr@2
|
113 |
IMPORT_C TBool ContainsSmsHeaderL(const CMsvStore& aStore);
|
williamr@2
|
114 |
|
williamr@2
|
115 |
private:
|
williamr@2
|
116 |
CSmsHeader(CSmsMessage* aSmsMessage = NULL);
|
williamr@2
|
117 |
void ConstructL(CSmsPDU::TSmsPDUType aType, CEditableText& aText);
|
williamr@2
|
118 |
void ConstructL(CSmsPDU::TSmsPDUType aType, CEditableText& aText, RFs& aFs);
|
williamr@2
|
119 |
void ConstructL();
|
williamr@2
|
120 |
|
williamr@2
|
121 |
enum TSmsHeaderFlags
|
williamr@2
|
122 |
{
|
williamr@2
|
123 |
ESmsHeaderNoFlags = 0x00,
|
williamr@2
|
124 |
ESmsHeaderReplyPathProvided = 0x01,
|
williamr@2
|
125 |
ESmsHeaderCanConcatenate = 0x02
|
williamr@2
|
126 |
};
|
williamr@2
|
127 |
|
williamr@2
|
128 |
TBool CanConcatenate() const;
|
williamr@2
|
129 |
void SetCanConcatenate(TBool aCanConcatenate);
|
williamr@2
|
130 |
|
williamr@2
|
131 |
void SetEmailReplyForwardSubjectL(CSmsEmailFields* aEmailFields, const TDesC& aSubject, const TDesC& aSubjectFormat);
|
williamr@2
|
132 |
|
williamr@2
|
133 |
private:
|
williamr@2
|
134 |
CArrayPtrFlat<CSmsNumber> iRecipients;
|
williamr@2
|
135 |
CSmsMessage* iMessage;
|
williamr@2
|
136 |
TUint32 iFlags;
|
williamr@2
|
137 |
RFs iFs;
|
williamr@2
|
138 |
|
williamr@2
|
139 |
// iBioMsgIdType is only used during sending and will be ignored if the
|
williamr@2
|
140 |
// TMsvEntry.iBioType == 0. The default is EBioMsgIdNbs.
|
williamr@2
|
141 |
TBioMsgIdType iBioMsgIdType;
|
williamr@2
|
142 |
CSmsEmailFields* iEmailFields;
|
williamr@2
|
143 |
TBool iCloseFs;
|
williamr@2
|
144 |
};
|
williamr@2
|
145 |
|
williamr@2
|
146 |
/**
|
williamr@2
|
147 |
A specialisation of the message server index class for SMS message entries.
|
williamr@2
|
148 |
|
williamr@2
|
149 |
It provides accessers for SMS message specific data, for instance the class type
|
williamr@2
|
150 |
of the SMS message.
|
williamr@2
|
151 |
|
williamr@2
|
152 |
@publishedPartner
|
williamr@2
|
153 |
@released
|
williamr@2
|
154 |
*/
|
williamr@2
|
155 |
class TMsvSmsEntry : public TMsvEntry
|
williamr@2
|
156 |
{
|
williamr@2
|
157 |
public:
|
williamr@2
|
158 |
|
williamr@2
|
159 |
/**
|
williamr@2
|
160 |
Defines a set flags used to access message entry data specific to an SMS message.
|
williamr@2
|
161 |
|
williamr@2
|
162 |
@internalTechnology
|
williamr@2
|
163 |
@released
|
williamr@2
|
164 |
|
williamr@2
|
165 |
*/
|
williamr@2
|
166 |
enum TMsvSmsEntryFlags
|
williamr@2
|
167 |
{
|
williamr@2
|
168 |
/**
|
williamr@2
|
169 |
Clears the entire set of SMS flags.
|
williamr@2
|
170 |
*/
|
williamr@2
|
171 |
EMsvSmsEntryClearFlag = 0x00000000,
|
williamr@2
|
172 |
/**
|
williamr@2
|
173 |
Mask for the protocol identifier data.
|
williamr@2
|
174 |
*/
|
williamr@2
|
175 |
EMsvSmsEntryProtocolIdentifier = 0x000000FF,
|
williamr@2
|
176 |
/**
|
williamr@2
|
177 |
Mask for the User Prompt Indicator flag.
|
williamr@2
|
178 |
*/
|
williamr@2
|
179 |
EMsvSmsEntryUserPromptIndicator = 0x00000100,
|
williamr@2
|
180 |
/**
|
williamr@2
|
181 |
Mask for the SMS class data.
|
williamr@2
|
182 |
*/
|
williamr@2
|
183 |
EMsvSmsEntryClass = 0x00000E00,
|
williamr@2
|
184 |
/**
|
williamr@2
|
185 |
Mask for the flag indicating whether the class data has been defined.
|
williamr@2
|
186 |
*/
|
williamr@2
|
187 |
EMsvSmsEntryClassDefined = 0x00001000,
|
williamr@2
|
188 |
/**
|
williamr@2
|
189 |
Mask for the flag indicating whether the message ID is valid.
|
williamr@2
|
190 |
*/
|
williamr@2
|
191 |
EMsvSmsMessageValid = 0x00002000,
|
williamr@2
|
192 |
/**
|
williamr@2
|
193 |
Mask for the delivery acknowledgement information.
|
williamr@2
|
194 |
*/
|
williamr@2
|
195 |
EMsvSmsEntryDeliveryAckSummary = 0x0001C000,
|
williamr@2
|
196 |
/**
|
williamr@2
|
197 |
Parameter defining the number of bits to be shifted in order for the SMS class
|
williamr@2
|
198 |
data to be at the LSB of the data block.
|
williamr@2
|
199 |
*/
|
williamr@2
|
200 |
EMsvSmsEntryClassShift = 9,
|
williamr@2
|
201 |
/**
|
williamr@2
|
202 |
Parameter defining the number of bits to be shifted in order for the delivery
|
williamr@2
|
203 |
acknowlwdgement information to be at the LSB of the data block.
|
williamr@2
|
204 |
*/
|
williamr@2
|
205 |
EMsvSmsEntryDeliveryAckSummaryShift = 14
|
williamr@2
|
206 |
};
|
williamr@2
|
207 |
|
williamr@2
|
208 |
/**
|
williamr@2
|
209 |
Defines the summary acknowledgement information.
|
williamr@2
|
210 |
|
williamr@2
|
211 |
This information indicates whether the SMS message is not supplying a summary
|
williamr@2
|
212 |
for an acknowledgement, is still expecting acknowledgments or it has received
|
williamr@2
|
213 |
all expected acknowledgements.
|
williamr@2
|
214 |
|
williamr@2
|
215 |
If all acknowledgements have been received the summary indicates whether all
|
williamr@2
|
216 |
the recipients have successfully acknowledged the message, all failed or there
|
williamr@2
|
217 |
was a mixture of successful and failed acknowledgements from the recipients.
|
williamr@2
|
218 |
*/
|
williamr@2
|
219 |
enum TMsvSmsEntryAckSummary
|
williamr@2
|
220 |
{
|
williamr@2
|
221 |
/**
|
williamr@2
|
222 |
No summary information is being formed.
|
williamr@2
|
223 |
*/
|
williamr@2
|
224 |
ENoAckSummary = 0,
|
williamr@2
|
225 |
/**
|
williamr@2
|
226 |
The message is waiting for acknowledgements to be received for all recipients
|
williamr@2
|
227 |
of this message. Some recipients may have received their acknowledgements but
|
williamr@2
|
228 |
there are still some recipients that have not.
|
williamr@2
|
229 |
*/
|
williamr@2
|
230 |
EPendingAcks,
|
williamr@2
|
231 |
/**
|
williamr@2
|
232 |
The summary indicates that the message was successfully acknowledged by all recipients.
|
williamr@2
|
233 |
*/
|
williamr@2
|
234 |
EAllSuccessful,
|
williamr@2
|
235 |
/**
|
williamr@2
|
236 |
The summary indicates that the message failed to be acknowledged by all recipients.
|
williamr@2
|
237 |
*/
|
williamr@2
|
238 |
EAllFailed,
|
williamr@2
|
239 |
/**
|
williamr@2
|
240 |
The summary indicates a mixture of successful and failed acknowledgements from
|
williamr@2
|
241 |
the recipients of the message. All recipients of this message have received
|
williamr@2
|
242 |
their acknowledgements.
|
williamr@2
|
243 |
*/
|
williamr@2
|
244 |
EMixed
|
williamr@2
|
245 |
};
|
williamr@2
|
246 |
|
williamr@2
|
247 |
public:
|
williamr@2
|
248 |
inline TMsvSmsEntry();
|
williamr@2
|
249 |
inline TMsvSmsEntry(const TMsvEntry& aEntry);
|
williamr@2
|
250 |
|
williamr@2
|
251 |
inline void SetUserPromptIndicator(TBool aUPI);
|
williamr@2
|
252 |
inline TBool UserPromptIndicator() const;
|
williamr@2
|
253 |
|
williamr@2
|
254 |
inline TUint8 ProtocolIdentifier() const;
|
williamr@2
|
255 |
inline void SetProtocolIdentifier(TSmsProtocolIdentifier aPID);
|
williamr@2
|
256 |
inline void SetProtocolIdentifier(TUint8 aPID);
|
williamr@2
|
257 |
|
williamr@2
|
258 |
inline TBool Class(TSmsDataCodingScheme::TSmsClass& aClass) const;
|
williamr@2
|
259 |
inline void SetClass(TBool aClassDefined,TSmsDataCodingScheme::TSmsClass aClass = TSmsDataCodingScheme::ESmsClass0);
|
williamr@2
|
260 |
|
williamr@2
|
261 |
IMPORT_C TMsvSmsEntryAckSummary AckSummary(TSmsAckType aAckType) const;
|
williamr@2
|
262 |
IMPORT_C void SetAckSummary(TSmsAckType aAckType, TMsvSmsEntryAckSummary aAckSummary);
|
williamr@2
|
263 |
|
williamr@2
|
264 |
IMPORT_C TBool MessageId(TInt32& aMessageId) const;
|
williamr@2
|
265 |
IMPORT_C void SetMessageId(TInt32 aMessageId, TBool aIsValid);
|
williamr@2
|
266 |
};
|
williamr@2
|
267 |
|
williamr@2
|
268 |
#include <smuthdr.inl>
|
williamr@2
|
269 |
|
williamr@2
|
270 |
#endif // __SMUTHDR_H__
|