CSmsSettings Class Reference

#include <app/smutset.h>

Link against: ipvoicemailengine.lib

class CSmsSettings : public CSmsMessageSettings

Inherits from

CSmsSettings
- CSmsMessageSettings

Public Member Enumerations
enum	TMobileSmsBearer { ESmsBearerPacketOnly, ESmsBearerCircuitOnly, ESmsBearerPacketPreferred, ESmsBearerCircuitPreferred }
enum	TSmsReportHandling { EMoveReportToInboxInvisible, EMoveReportToInboxVisible, EDiscardReport, EDoNotWatchForReport, ..., EDiscardReportAndMatch }
enum	TSmsSettingsCommDbAction { ENone, EStoreToCommDb }

Public Member Functions
virtual	~CSmsSettings()
IMPORT_C void	AddServiceCenterL(const TDesC &, const TDesC &)
TMsvId	Class2Folder()
TSmsSettingsCommDbAction	CommDbAction()
IMPORT_C void	CopyL(const CSmsSettings &)
IMPORT_C TInt	DefaultServiceCenter()
TSmsDelivery	Delivery()
TInt	DescriptionLength()
TBool	DiscardUnknownPortMessage()
IMPORT_C CSmsServiceCenter &	GetServiceCenter(TInt)
IMPORT_C CSmsSettings *	NewL()
IMPORT_C CSmsSettings *	NewLC()
void	RemoveSCAddresses()
IMPORT_C void	RemoveServiceCenter(TInt)
TBool	ReplyQuoted()
IMPORT_C TInt	ServiceCenterCount()
void	SetClass2Folder(TMsvId)
void	SetCommDbAction(TSmsSettingsCommDbAction)
IMPORT_C void	SetDefaultServiceCenter(TInt)
void	SetDelivery(TSmsDelivery)
void	SetDescriptionLength(TInt)
void	SetDiscardUnknownPortMessage(TBool)
void	SetReplyQuoted(TBool)
void	SetSettingsFlags(TUint32)
void	SetSmsBearer(TMobileSmsBearer)
void	SetSmsBearerAction(TSmsSettingsCommDbAction)
void	SetSpecialMessageHandling(TSmsReportHandling)
void	SetStatusReportHandling(TSmsReportHandling)
TUint32	SettingsFlags()
TMobileSmsBearer	SmsBearer()
TSmsSettingsCommDbAction	SmsBearerAction()
TSmsReportHandling	SpecialMessageHandling()
TSmsReportHandling	StatusReportHandling()
void	StoreToCommDbL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CSmsMessageSettings::CSmsMessageSettings()
	CSmsMessageSettings::CanConcatenate()const
	CSmsMessageSettings::CharacterSet()const
	CSmsMessageSettings::CopyL(const CSmsMessageSettings &)
	CSmsMessageSettings::DeliveryReport()const
	CSmsMessageSettings::ExternalizeL(RWriteStream &)const
	CSmsMessageSettings::InternalizeL(RReadStream &)
	CSmsMessageSettings::LastSegmentDeliveryReport()const
	CSmsMessageSettings::MessageConversion()const
	CSmsMessageSettings::MessageFlags()const
	CSmsMessageSettings::RejectDuplicate()const
	CSmsMessageSettings::ReplyPath()const
	CSmsMessageSettings::SetCanConcatenate(TBool)
	CSmsMessageSettings::SetCharacterSet(TSmsDataCodingScheme::TSmsAlphabet)
	CSmsMessageSettings::SetDeliveryReport(TBool)
	CSmsMessageSettings::SetLastSegmentDeliveryReport(TBool)
	CSmsMessageSettings::SetMessageConversion(TSmsPIDConversion)
	CSmsMessageSettings::SetMessageFlags(TUint32)
	CSmsMessageSettings::SetRejectDuplicate(TBool)
	CSmsMessageSettings::SetReplyPath(TBool)
	CSmsMessageSettings::SetUseServiceCenterTimeStampForDate(TBool)
	CSmsMessageSettings::SetValidityPeriod(TTimeIntervalMinutes)
	CSmsMessageSettings::SetValidityPeriodFormat(TSmsFirstOctet::TSmsValidityPeriodFormat)
	CSmsMessageSettings::UseServiceCenterTimeStampForDate()const
	CSmsMessageSettings::ValidityPeriod()const
	CSmsMessageSettings::ValidityPeriodFormat()const

Detailed Description

The SMS Service settings.

An SMS service entry stores an object of this type in its message store. These settings define the default settings for mobile originated messages (SMS-SUBMIT type messages). They also provide some global settings that are applied to all messages, both outward going and received messages.

The SMS service also uses this class to store the set of avilable Servive Centre numbers. The default Service Centre is defined from this set.

Member Enumeration Documentation

Enum TMobileSmsBearer

Defines the SMS bearer. Modes: GSM

Enumerator	Value	Description
ESmsBearerPacketOnly		SMS messages will only be sent over a packet-switched (GPRS) network.
ESmsBearerCircuitOnly		SMS messages will only be sent over a circuit-switched (GSM) network.
ESmsBearerPacketPreferred		SMS messages will be sent over the packet-switched (GPRS) network if possible, otherwise over circuit-switched (GSM) network.
ESmsBearerCircuitPreferred		SMS messages will be sent over the circuit-switched (GSM) network if possible, otherwise over packet-switched (GPRS) network.

Enum TSmsReportHandling

Defines the ways in which status reports that are received by the watcher may be handled.

This can be applied to both SMS-STATUS-REPORT type messages and Special Messages (e.g. Voice Mail Indication messages).

Enumerator	Value	Description
EMoveReportToInboxInvisible		The reports are put in the inbox and made invisible.
EMoveReportToInboxVisible		The reports are put in the inbox and made visible.
EDiscardReport		The reports are deleted.
EDoNotWatchForReport		Not supported.
EMoveReportToInboxInvisibleAndMatch		Reports are put in the inbox and made invisible. The status report is matched against the sent mesasge and its summary info updated.
EMoveReportToInboxVisibleAndMatch		Reports are put in the inbox and made visible. The status report is matched against the sent mesasge and its summary info updated.
EDiscardReportAndMatch		Reports are deleted. The status report is matched against the sent mesasge and its summary info updated.

Enum TSmsSettingsCommDbAction

Sets whether the service settings should be used to update the communications database.

If the update is specified, it is done when the Service settings are stored into the message store.

Enumerator	Value	Description
ENone		The comms database should not be updated.
EStoreToCommDb		Use the Service settings to update the comms datebase.

Constructor & Destructor Documentation

~CSmsSettings ( )

IMPORT_C

~CSmsSettings

(

)

[virtual]

Member Function Documentation

AddServiceCenterL ( const TDesC &, const TDesC & )

IMPORT_C void	AddServiceCenterL	(	const TDesC &	aName,
			const TDesC &	aNumber
		)

Class2Folder ( )

TMsvId

Class2Folder

(

)

const [inline]

Gets the folder ID into which received class 2 SMS-DELIVER messages are stored.

Returns: The class 2 folder ID.

CommDbAction ( )

TSmsSettingsCommDbAction

CommDbAction

(

)

const [inline]

Gets the communications database action.

For details, see CSmsSettings::SetCommDbAction().

Returns: The communications database action.

CopyL ( const CSmsSettings & )

IMPORT_C void

CopyL

(

const CSmsSettings &

aSmsSettings

)

DefaultServiceCenter ( )

IMPORT_C TInt

DefaultServiceCenter

(

)

const

Delivery ( )

TSmsDelivery

Delivery

(

)

const [inline]

Gets the default schedule delivery type of a new message created using the SMS client MTM.

Returns: The schedule delivery type.

DescriptionLength ( )

TInt

DescriptionLength

(

)

const [inline]

Gets the maximum length of the message entry description.

DiscardUnknownPortMessage ( )

TBool

DiscardUnknownPortMessage

(

)

const [inline]

Gets the boolean flag that indicates whether to discard unknown port message.

A value of ETrue indicates to discard unknown port message.

Returns: The value of the discard message flag.

GetServiceCenter ( TInt )

IMPORT_C CSmsServiceCenter &

GetServiceCenter

(

TInt

aIndex

)

const

NewL ( )

IMPORT_C CSmsSettings *

NewL

(

)

[static]

NewLC ( )

IMPORT_C CSmsSettings *

NewLC

(

)

[static]

RemoveSCAddresses ( )

void

RemoveSCAddresses

(

)

RemoveServiceCenter ( TInt )

IMPORT_C void

RemoveServiceCenter

(

TInt

aIndex

)

ReplyQuoted ( )

TBool

ReplyQuoted

(

)

const [inline]

Gets whether the editor should quote the received message at the beginning of the reply message.

Returns: A value of ETrue if the editor should quote the received message at the beginning of the reply. EFalse if not.

ServiceCenterCount ( )

IMPORT_C TInt

ServiceCenterCount

(

)

const

SetClass2Folder ( TMsvId )

void

SetClass2Folder

(

TMsvId

aId

)

[inline]

Sets the folder ID into which received class 2 SMS-DELIVER messages are stored.

Parameter	Description
aId	The folder ID for received class 2 messages.

SetCommDbAction ( TSmsSettingsCommDbAction )

void

SetCommDbAction

(

TSmsSettingsCommDbAction

aCommDbAction

)

[inline]

Sets whether the Service settings should be used to update the communications database.

If set, this uses the service settings to update the comms db MODEM table's MODEM_MESSAGE_CENTRE_NUMBER, MODEM_MESSAGE_VALIDITY_PERIOD and MODEM_MESSAGE_DELIVERY_REPORT fields. The update is done when the Service settings are stored into the message store using CSmsSettings::StoreL().

The default setting is for the comms db not to be updated - TSmsSettingsCommDbAction::ENone.

See also: CSmsSettings::TSmsSettingsCommDbAction CSmsSettings::StoreL

Parameter	Description
aCommDbAction	The communications database action.

SetDefaultServiceCenter ( TInt )

IMPORT_C void

SetDefaultServiceCenter

(

TInt

aDefaultSC

)

SetDelivery ( TSmsDelivery )

void

SetDelivery

(

TSmsDelivery

)

[inline]

Sets the default schedule delivery type of a new message created using the SMS client MTM.

Parameter	Description
	The schedule delivery type.

SetDescriptionLength ( TInt )

void

SetDescriptionLength

(

TInt

aLength

)

[inline]

Sets the maximum length of the message entry description.

The default value is given by KSmsDescriptionLength.

Parameter	Description
aLength	The maximum length.

SetDiscardUnknownPortMessage ( TBool )

void

SetDiscardUnknownPortMessage

(

TBool

aDeleteMessage

)

[inline]

Sets the boolean flag that indicates whether to discard unknown port message.

A value of ETrue indicates that discard unknown port message, it will be done without indicating the user.

SetReplyQuoted ( TBool )

void

SetReplyQuoted

(

TBool

)

[inline]

Sets whether the editor should quote the received message at the beginning of the reply message.

SetSettingsFlags ( TUint32 )

void

SetSettingsFlags

(

TUint32

aSetFlags

)

SetSmsBearer ( TMobileSmsBearer )

void

SetSmsBearer

(

TMobileSmsBearer

aSmsBearer

)

[inline]

Sets the SMS bearer.

Parameter	Description
aSmsBearer	The SMS bearer.

SetSmsBearerAction ( TSmsSettingsCommDbAction )

void

SetSmsBearerAction

(

TSmsSettingsCommDbAction

aSmsBearerAction

)

[inline]

Sets whether the Service's SMS bearer setting should be used to update the communications database.

If set, this uses the service setting to update the comm db global table's SMS_BEARER field. The update is done when the Service settings are stored into the message store using CSmsSettings::StoreL().

The default setting is for the comms db not to be updated - TSmsSettingsCommDbAction::ENone.

See also: CSmsSettings::TSmsSettingsCommDbAction CSmsSettings::StoreL

Parameter	Description
aSmsBearerAction	The SMS bearer action.

SetSpecialMessageHandling ( TSmsReportHandling )

void

SetSpecialMessageHandling

(

TSmsReportHandling

aSpecialMessageHandling

)

[inline]

Sets the way in which special messages that are received by the watcher are handled.

Parameter	Description
aSpecialMessageHandling	The special messages handling data.

SetStatusReportHandling ( TSmsReportHandling )

void

SetStatusReportHandling

(

TSmsReportHandling

aStatusReportHandling

)

[inline]

Sets the way in which status reports that are received by the watcher are handled.

Parameter	Description
aStatusReportHandling	The SMS status report handling data.

SettingsFlags ( )

TUint32

SettingsFlags

(

)

const

SmsBearer ( )

TMobileSmsBearer

SmsBearer

(

)

const [inline]

Gets the SMS bearer.

Returns: The SMS bearer.

SmsBearerAction ( )

TSmsSettingsCommDbAction

SmsBearerAction

(

)

const [inline]

Gets the SMS bearer action.

For details, see CSmsSettings::SetCommDbAction().

Returns: The SMS bearer action.

SpecialMessageHandling ( )

TSmsReportHandling

SpecialMessageHandling

(

)

const [inline]

Gets the way in which special messages that are received by the watcher are handled.

By default, this is EDoNotWatchForReport. This value is not supported and therefore the value must be changed from the default.

Returns: How special messages are handled.

StatusReportHandling ( )

TSmsReportHandling

StatusReportHandling

(

)

const [inline]

Gets the way in which status reports that are received by the watcher are handled.

By default, this is EDoNotWatchForReport. This value is not supported and therefore the value must be changed from the default.

Returns: How SMS status reports are handled.

StoreToCommDbL ( )

void

StoreToCommDbL

(

)

const