epoc32/include/smsclnt.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/smsclnt.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/smsclnt.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,209 @@
-smsclnt.h
+// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// 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
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#ifndef __SMSCLNT_H__
+#define __SMSCLNT_H__
+
+#include <mtclbase.h>
+#include <smuthdr.h>
+
+
+/**
+The UID that indentifies the SMS message editor application.
+
+This is the response to the query for the KUidMsvMtmQueryEditorUidValue
+capability.
+
+@see	CSmsClientMtm::QueryCapability
+
+@publishedPartner
+@released
+*/
+const TInt KUidMsgSmsEditorAppVal=0x1000163f;
+
+/**
+The maximum number of SMS PDUs allowed in a concatenated SMS message.
+
+Together with KSmcmMaxCharsInMessageConcatenated7Bit, this is the response to
+the query for the KUidMtmQueryMaxTotalMsgSizeValue capability.
+
+@see	CSmsClientMtm::QueryCapability
+@see	KSmcmMaxCharsInMessageConcatenated7Bit
+
+@internalComponent
+@released
+*/
+const TInt KSmcmMaxMessageNumber=0x32;
+
+/**
+The maximum number of characters in a concatenated SMS PDU.
+
+Together with KSmcmMaxMessageNumber, this is the response to the query for the
+KUidMtmQueryMaxTotalMsgSizeValue capability.
+
+@see	CSmsClientMtm::QueryCapability
+@see	KSmcmMaxCharsInMessageConcatenated7Bit
+
+@internalComponent
+@released
+*/
+const TInt KSmcmMaxCharsInMessageConcatenated7Bit=0x99;
+
+/**
+The maximum number of characters in a non-concatenated SMS PDU.
+
+This is the response to the query for the KUidMtmQueryMaxBodySizeValue
+capability.
+
+@see	CSmsClientMtm::QueryCapability
+
+@internalComponent
+@released
+*/
+const TInt KSmcmMaxTotalMsgSize=160;
+
+/**
+The granularity of the in-memory buffer for CRichText objects.
+
+@see	CRichText::NewL
+
+@internalComponent
+@released
+*/
+const TInt KSmcmRichTextConstant=256;
+
+class CSmsHeader;
+class CSmsMessage;
+class CSmsSettings;
+class TSmsUtilities;
+class CSmsSimParamOperation;
+class CMobilePhoneSmspList;
+class RResourceFile;
+
+/** 
+The SMS client MTM interface.
+
+Most of the functions in this class are implementations of the virtual functions 
+defined by the base class CBaseMtm.
+
+An object of this class can be obtained from the Client MTM registry. The message
+server provides the necessary information required by the registry to provide
+the SMS client MTM.
+
+All client MTM objects have a current context. This is an entry in the message 
+store that will be manipulated by certain APIs supplied by the MTM. If the 
+current context is not set then certain APIs will panic. 
+
+The CBaseMtm::HasContext API can be used to check that the current context has 
+been set. It can be set using either the CBaseMtm::SwitchCurrenEntryL API or the
+CBaseMtm::SetCurrentEntryL API.
+
+@see	CClientMtmRegistry
+@see	CBaseMtm::HasContext
+@see	CBaseMtm::SetCurrentEntryL
+@see	CBaseMtm::SwitchCurrenEntryL
+
+@publishedAll
+@released
+*/
+class CSmsClientMtm : public CBaseMtm
+	{
+public:
+
+	IMPORT_C static CSmsClientMtm* NewL(CRegisteredMtmDll& aRegisteredMtmDll,CMsvSession& aSession);
+	virtual ~CSmsClientMtm();
+
+	void HandleEntryEvent(enum MMsvEntryObserver::TMsvEntryEvent,TAny*,TAny*,TAny*);
+
+	inline CSmsHeader& SmsHeader();
+	inline const CSmsHeader& SmsHeader() const;
+	inline CSmsSettings& ServiceSettings();
+	inline const CSmsSettings& ServiceSettings() const;
+	inline TInt ServiceId() const;
+
+	IMPORT_C void RestoreServiceAndSettingsL();
+	IMPORT_C CSmsSimParamOperation* ReadSimParamsL(TRequestStatus& aObserverRequestStatus);
+	IMPORT_C CSmsSimParamOperation* WriteSimParamsL(const CMobilePhoneSmspList& aList, TRequestStatus& aObserverRequestStatus); 
+	
+	/** 
+	Sets the character encoding value. The character encoding value options are 7-bit,
+	8-bit and 16-Bit Unicode. By default the character set encoding is 7 bit encoding.
+	*/
+	void SetMessageCharacterSetL(TSmsDataCodingScheme::TSmsAlphabet aTsmsAlphabet);
+
+public:	// methods from CBaseMtm
+
+	virtual void SaveMessageL(); 
+	virtual void LoadMessageL();
+	virtual TMsvPartList ValidateMessage(TMsvPartList aPartList);
+	virtual TMsvPartList Find(const TDesC& aTextToFind, TMsvPartList aPartList);
+	virtual CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);
+	virtual CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);
+	virtual void AddAddresseeL(const TDesC& aRealAddress);
+	virtual void AddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias);
+	virtual void RemoveAddressee(TInt aIndex);
+	virtual TInt QueryCapability(TUid aCapability, TInt& aResponse);
+	virtual void InvokeSyncFunctionL(TInt aFunctionId,const CMsvEntrySelection& aSelection, TDes8& aParameter);
+	virtual CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId,const CMsvEntrySelection& aSelection, TDes8& aParameter, TRequestStatus& aCompletionStatus);
+
+	IMPORT_C void CreateMessageL(TMsvId aServiceId);
+	IMPORT_C void BioTypeChangedL(TUid aBioTypeUid);
+	
+protected: 
+	/**
+	Methods from CBaseMtm, The implementation of this function assumes that
+    the new service for setting the charset encoding value for a SMS message is supported.
+    */
+	IMPORT_C virtual TInt Extension_(TUint aExtensionId, TAny*& a0, TAny* a1);
+ 
+private:
+
+	CSmsClientMtm(CRegisteredMtmDll& aRegisteredMtmDll,CMsvSession& aSession);
+	void ConstructL();
+
+	void BasicReplyForwardEntry(TMsvEntry& aNewEntry) const;
+	CMsvOperation* CreateNewEntryL(TMsvEntry& aNewEntry, TMsvId aDestination,CSmsHeader& aSmsHeader,const CRichText& aBody, TRequestStatus& aCompletionStatus);
+	TBool ValidRecipients() const;
+	TBool ValidNumber(const TDesC& aNumber) const;
+
+private:	// methods from CBaseMtm
+
+	virtual void ContextEntrySwitched(); 
+
+private:
+
+	void DoAddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias);
+	void AddRecipientL(const TDesC& aRealAddress, const TDesC& aAlias);
+	void DoAddRecipientL(CSmsHeader* aSmsHeader, const TDesC& aRealAddress, const TDesC& aAlias);
+	void ResetHeader();
+	TMsvPartList DoFindL(const TDesC& aTextToFind,TMsvPartList aPartList);
+	void FindL(const TDesC& aTextToFind, const TMsvPartList aPartList,TMsvPartList& aFoundList);
+	void FindInBodyL(const TDesC& aTextToFind, const TMsvPartList& aFoundList, TMsvPartList& aResult);
+	HBufC* ReadEmailSubjectFormatL(RResourceFile& aResourceFile, TInt aResourceId, const TDesC& aDefaultFormat);
+
+private:
+
+	CSmsSettings*	iServiceSettings;
+	TMsvId			iServiceId;
+	CSmsHeader*		iSmsHeader;
+	TChar			iRealAddressOpen;
+	TChar			iRealAddressClose;
+	HBufC*			iEmailForwardSubjectFormat;
+	HBufC*			iEmailReplySubjectFormat;
+	};
+
+#include <smsclnt.inl>
+
+#endif	// __SMSCLNT_H__