diff -r 666f914201fb -r 2fe1408b6811 epoc32/include/smsclnt.inl --- a/epoc32/include/smsclnt.inl Tue Nov 24 13:55:44 2009 +0000 +++ b/epoc32/include/smsclnt.inl Tue Mar 16 16:12:26 2010 +0000 @@ -1,1 +1,146 @@ -smsclnt.inl +// 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: +// + +#include +#include + +/** +Gets the message header for a message context. + +The current context must be set to a message entry with type KUidMsvMessageEntryValue. +If the current context is not set, or is set to an entry not of type +KUidMsvMessageEntryValuethen a panic will occur. + +The message header object is the SMS MTM encapsulation of an SMS message. The +contents of the message header has been extracted from the current context. + +@return +The (non-const) message header object. + +@panic SMCM 1 +The current context has not been set (debug only). + +@panic SMCM 2 +The current context was not of type KUidMsvMessageEntry (debug only). + +@see CSmsHeader +*/ +inline CSmsHeader& CSmsClientMtm::SmsHeader() + { + __ASSERT_DEBUG(iMsvEntry, Panic(ESmscEntryNotSet)); + __ASSERT_DEBUG(iMsvEntry->Entry().iType==KUidMsvMessageEntry, Panic(ESmscWrongContextType)); + return *iSmsHeader; + } + +/** +Gets the (const) message header for a message context. + +The current context must be set to a message entry with type KUidMsvMessageEntryValue. +If the current context is not set, or is set to an entry not of type +KUidMsvMessageEntryValuethen a panic will occur. + +The message header object is the SMS MTM encapsulation of an SMS message. The +contents of the message header has been extracted from the current context. + +@return +The (const) message header object. + +@panic SMCM 1 +The current context has not been set (debug only). + +@panic SMCM 2 +The current context was not of type KUidMsvMessageEntry (debug only). + +@see CSmsHeader +*/ +inline const CSmsHeader& CSmsClientMtm::SmsHeader() const + { + __ASSERT_DEBUG(iMsvEntry, Panic(ESmscEntryNotSet)); + __ASSERT_DEBUG(iMsvEntry->Entry().iType==KUidMsvMessageEntry, Panic(ESmscWrongContextType)); + return *iSmsHeader; + } + +/** +Gets the current SMS service settings. + +The current context must be set. If the current context is not set then a panic +will occur. + +The SMS service settings must have been set or a panic will occur. The +CSmsClientMtm::RestoreServiceAndSettingsL API can restore the SMS service +settings. This also sets the SMS service ID. + +@return +The current (non-const) SMS service settings. + +@panic SMCM 1 +The current context has not been set (debug only). + +@panic SMCM 11 +The SMS Service settings have not been set (debug only). + +@see CSmsClientMtm::RestoreServiceAndSettingsL +*/ +inline CSmsSettings& CSmsClientMtm::ServiceSettings() + { + __ASSERT_DEBUG(iMsvEntry, Panic(ESmscEntryNotSet)); + __ASSERT_DEBUG(iServiceSettings, Panic(ESmscSettingsNotSet)); + return *iServiceSettings; + } + +/** +Gets the current (const) SMS service settings. + +The current context must be set. If the current context is not set then a panic +will occur. + +The SMS service settings must have been set or a panic will occur. The +CSmsClientMtm::RestoreServiceAndSettingsL API can restore the SMS service +settings. This also sets the SMS service ID. + +@return +The current (const) SMS service settings. + +@panic SMCM 1 +The current context has not been set (debug only). + +@panic SMCM 11 +The SMS Service settings have not been set (debug only). + +@see CSmsClientMtm::RestoreServiceAndSettingsL +*/ +inline const CSmsSettings& CSmsClientMtm::ServiceSettings() const + { + __ASSERT_DEBUG(iMsvEntry, Panic(ESmscEntryNotSet)); + __ASSERT_DEBUG(iServiceSettings, Panic(ESmscSettingsNotSet)); + return *iServiceSettings; + } + +/** +Gets the ID of the current SMS service. + +If there is no current SMS service, the ID will be a value of 0. The +CSmsClientMtm::RestoreServiceAndSettingsL API can set the SMS service IS. This +also restores the SMS service settings. + +@return +The ID for the current SMS service + +@see CSmsClientMtm::RestoreServiceAndSettingsL +*/ +inline TInt CSmsClientMtm::ServiceId() const + { + return iServiceId; + }