CSmsMessageSettings Class Reference

#include <app/smutset.h>

Link against: ipvoicemailengine.lib

class CSmsMessageSettings : public CBase

Inherits from

CSmsMessageSettings

Public Member Functions
TBool	CanConcatenate()
enum TSmsDataCodingScheme::TSmsAlphabet	CharacterSet()
virtual IMPORT_C void	CopyL(const CSmsMessageSettings &)
TBool	DeliveryReport()
virtual IMPORT_C void	ExternalizeL(RWriteStream &)
virtual IMPORT_C void	InternalizeL(RReadStream &)
TBool	LastSegmentDeliveryReport()
TSmsPIDConversion	MessageConversion()
TUint32	MessageFlags()
TBool	RejectDuplicate()
TBool	ReplyPath()
void	SetCanConcatenate(TBool)
void	SetCharacterSet(TSmsDataCodingScheme::TSmsAlphabet)
void	SetDeliveryReport(TBool)
void	SetLastSegmentDeliveryReport(TBool)
void	SetMessageConversion(TSmsPIDConversion)
void	SetMessageFlags(TUint32)
void	SetRejectDuplicate(TBool)
void	SetReplyPath(TBool)
void	SetUseServiceCenterTimeStampForDate(TBool)
void	SetValidityPeriod(TTimeIntervalMinutes)
void	SetValidityPeriodFormat(TSmsFirstOctet::TSmsValidityPeriodFormat)
TBool	UseServiceCenterTimeStampForDate()
const TTimeIntervalMinutes &	ValidityPeriod()
const TSmsFirstOctet::TSmsValidityPeriodFormat	ValidityPeriodFormat()

Protected Member Functions
	CSmsMessageSettings()

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()

Detailed Description

The SMS settings that are relevant on a per message basis.

Each SMS message has its own settings. Initially they have a default set of values derived from the SMS service settings. They can be changed on an individual message basis. For instance, a messaging application may allow a user to specify/not specify status reports individually for each message.

These settings are only relevant to mobile originated messages - those of SMS-SUBMIT type.

Constructor & Destructor Documentation

CSmsMessageSettings ( )

CSmsMessageSettings

(

)

[protected]

Member Function Documentation

CanConcatenate ( )

TBool

CanConcatenate

(

)

const [inline]

Gets the values of the UI concatenated-SMS-allowed flag.

If true, the UI should pass a long message in one piece to the MTM. If false, it should split the message manually into 140 byte parts. The value of this flag does not affect the behaviour of the SMS MTM.

Returns: The concatenated-SMS-allowed flag.

CharacterSet ( )

enum TSmsDataCodingScheme::TSmsAlphabet

CharacterSet

(

)

const [inline]

Gets the default character set used in the SMS message.

Text is stored in Unicode on the Symbian OS phone and is converted into the appropriate character set when the message is sent.

Returns: The default character set for the message.

CopyL ( const CSmsMessageSettings & )

IMPORT_C void

CopyL

(

const CSmsMessageSettings &

aSettings

)

[virtual]

DeliveryReport ( )

TBool

DeliveryReport

(

)

const [inline]

Tests if a status report (TP-SRR in GSM spec 03.40) will be requested from the Service Centre.

A value of ETrue indicates that a status report will be requested.

Returns: The value of the Status report flag.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const [virtual]

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aReadStream

)

[virtual]

LastSegmentDeliveryReport ( )

TBool

LastSegmentDeliveryReport

(

)

const [inline]

Tests if a status report (TP-SRR in GSM spec 03.40) for the last segment will be requested from the Service Centre.

A value of ETrue indicates that a status report will be requested for the last segment.

Returns: The value of the Status report flag only for the last segment.

MessageConversion ( )

TSmsPIDConversion

MessageConversion

(

)

const [inline]

Gets the form in which the message should be delivered to the recipient by the service centre.

Note that the form may or may not actually be supported by the service centre, and that the format of the recipient address(es) may need to be different to a normal telephone number if MessageConversion() is set to any other value than ESmsConvPIDNone, ESmsConvFax, ESmsConvPaging or ESmsConvErmes.

Returns: The value of the message form specifier.

MessageFlags ( )

TUint32

MessageFlags

(

)

const

RejectDuplicate ( )

TBool

RejectDuplicate

(

)

const [inline]

Gets the value of the reject-duplicate setting.

If this is true, the service instructs the SC to reject an Sms-Submit for an SMS still held in the SC that has the same message reference number and same destination address as an previously submitted SMS from the same originating address.

Returns: The value of the reject-duplicate setting.

ReplyPath ( )

TBool

ReplyPath

(

)

const [inline]

Gets the boolean flag that indicates whether a the reply path (Service Centre address) should be included in the SMS-SUBMIT message (TP-RP in GSM spec 03.40).

A value of ETrue indicates that the Service Centre address should be included. This flag is only relavent for SMS-SUBMIT messages.

Returns: The value of the reply path flag.

SetCanConcatenate ( TBool )

void

SetCanConcatenate

(

TBool

)

[inline]

Sets the values of the UI concatenated-SMS-allowed flag.

Parameter	Description
	The value to set the concatenated-SMS-allowed flag to.

SetCharacterSet ( TSmsDataCodingScheme::TSmsAlphabet )

void

SetCharacterSet

(

TSmsDataCodingScheme::TSmsAlphabet

)

[inline]

Sets the default character set used in the SMS message.

Text is stored in Unicode on the Symbian OS phone and is converted into the appropriate character set when the message is sent.

Parameter	Description
	The value of the default character set for the message.

SetDeliveryReport ( TBool )

void

SetDeliveryReport

(

TBool

)

[inline]

Sets if a status report (TP-SRR in GSM spec 03.40) will be requested from the Service Centre.

A value of ETrue indicates that a status report will be requested.

Parameter	Description
	The value of the status report flag.

SetLastSegmentDeliveryReport ( TBool )

void

SetLastSegmentDeliveryReport

(

TBool

)

[inline]

Sets if a status report (TP-SRR in GSM spec 03.40) for the last segment will be requested from the Service Centre.

A value of ETrue indicates that a status report will be requested for the last segment.

Parameter	Description
	The value of the status report flagfor the last segment.

SetMessageConversion ( TSmsPIDConversion )

void

SetMessageConversion

(

TSmsPIDConversion

)

[inline]

Sets the form in which the message should be delivered to the recipient by the Service Centre.

Parameter	Description
	The message form specifier.

SetMessageFlags ( TUint32 )

void

SetMessageFlags

(

TUint32

aMsgFlags

)

SetRejectDuplicate ( TBool )

void

SetRejectDuplicate

(

TBool

)

[inline]

Sets the value of the reject-duplicate setting.

Parameter	Description
	The value to set the reject-duplicate setting to.

SetReplyPath ( TBool )

void

SetReplyPath

(

TBool

)

[inline]

Sets the boolean flag that indicates whether a the reply path (Service Centre address) should be included in the SMS-SUBMIT message (TP-RP in GSM spec 03.40).

A value of ETrue indicates that the Service Centre address should be included. This flag is only relavent for SMS-SUBMIT messages.

Parameter	Description
	The value of the reply path flag.

SetUseServiceCenterTimeStampForDate ( TBool )

void

SetUseServiceCenterTimeStampForDate

(

TBool

aUseServiceCenterTimestamp

)

[inline]

Sets the flag which indicates whether the service center timestamp should be used for the date field in the TMsvEntry in message store. If the flag is not set, then the timestamp from the associated CSmsMessage is used.

Parameter	Description
aUseServiceCenterTimestamp	Flag to indicate whether to use the service center timestamp

SetValidityPeriod ( TTimeIntervalMinutes )

void

SetValidityPeriod

(

TTimeIntervalMinutes

)

[inline]

Sets the validity period for messages sent by the SMS MTM.

panic: SMCM 8 The validity period is negative or greater than the maximum validity period (debug only).

Parameter	Description
	The validity period.

SetValidityPeriodFormat ( TSmsFirstOctet::TSmsValidityPeriodFormat )

void

SetValidityPeriodFormat

(

TSmsFirstOctet::TSmsValidityPeriodFormat

aValidityPeriodFormat

)

[inline]

Sets the format in which the validity period should be sent in a SMS-DELIVER type message.

This is field TP-VPF from GSM spec 03.40.

Parameter	Description
aValidityPeriodFormat	The validity period format.

UseServiceCenterTimeStampForDate ( )

TBool

UseServiceCenterTimeStampForDate

(

)

const [inline]

Gets the flag which indicates whether the service center timestamp should be used for the date field in the TMsvEntry in message store. If the flag is not set, then the timestamp from the associated CSmsMessage is used.

Returns: Flag which indcates if service center timestamp will be used.

ValidityPeriod ( )

const TTimeIntervalMinutes &

ValidityPeriod

(

)

const [inline]

Gets the validity period for messages sent by the SMS MTM.

If the service centre is unable to deliver the SMS message before this time expires, a failure report may be generated by the service centre, and no further attempts will be made to deliver the message to ther recipient.

Validity period is only used for SMS-SUBMIT, mobile originated messages.

Returns: The validity period of the message.

ValidityPeriodFormat ( )

const TSmsFirstOctet::TSmsValidityPeriodFormat

ValidityPeriodFormat

(

)

const [inline]

Gets the format in which the validity period should be sent in a SMS-DELIVER type message.

Returns: The validity period format.