Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: SMUTSET.H
Link against: smcm.lib

Class CSmsMessageSettings

class CSmsMessageSettings : public CBase;

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.

Derivation

Members

Defined in CSmsMessageSettings:
CanConcatenate(), CanConcatenate(), CharacterSet(), CharacterSet(), CopyL(), CopyL(), DeliveryReport(), DeliveryReport(), ExternalizeL(), ExternalizeL(), InternalizeL(), InternalizeL(), LastSegmentDeliveryReport(), LastSegmentDeliveryReport(), MessageConversion(), MessageConversion(), RejectDuplicate(), RejectDuplicate(), ReplyPath(), ReplyPath(), SetCanConcatenate(), SetCanConcatenate(), SetCharacterSet(), SetCharacterSet(), SetDeliveryReport(), SetDeliveryReport(), SetLastSegmentDeliveryReport(), SetLastSegmentDeliveryReport(), SetMessageConversion(), SetMessageConversion(), SetRejectDuplicate(), SetRejectDuplicate(), SetReplyPath(), SetReplyPath(), SetUseServiceCenterTimeStampForDate(), SetUseServiceCenterTimeStampForDate(), SetValidityPeriod(), SetValidityPeriod(), SetValidityPeriodFormat(), SetValidityPeriodFormat(), UseServiceCenterTimeStampForDate(), UseServiceCenterTimeStampForDate(), ValidityPeriod(), ValidityPeriod(), ValidityPeriodFormat(), ValidityPeriodFormat()

Inherited from CBase:
Delete(), Extension_(), operator new()


Member functions


InternalizeL()

virtual IMPORT_C void InternalizeL(RReadStream &aReadStream);

Description

Internalises the settings from a read stream.

Parameters

RReadStream &aReadStream

The stream from which the settings should be internalised.


ExternalizeL()

virtual IMPORT_C void ExternalizeL(RWriteStream &aWriteStream) const;

Description

Externalises the settings to a write stream.

Parameters

RWriteStream &aWriteStream

The stream to which the settings should be externalised.


ValidityPeriod()

inline const TTimeIntervalMinutes &ValidityPeriod() const;

Description

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.

Return value

const TTimeIntervalMinutes &

The validity period of the message.


SetValidityPeriod()

inline void SetValidityPeriod(TTimeIntervalMinutes);

Description

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

Parameters

TTimeIntervalMinutes

The validity period.

Panic codes

SMCM

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


SetValidityPeriodFormat()

inline void SetValidityPeriodFormat(TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat);

Description

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.

Parameters

TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat

The validity period format.


ValidityPeriodFormat()

inline const TSmsFirstOctet::TSmsValidityPeriodFormat ValidityPeriodFormat() const;

Description

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

Return value

const TSmsFirstOctet::TSmsValidityPeriodFormat

The validity period format.


RejectDuplicate()

inline TBool RejectDuplicate() const;

Description

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.

Return value

TBool

The value of the reject-duplicate setting.


SetRejectDuplicate()

inline void SetRejectDuplicate(TBool);

Description

Sets the value of the reject-duplicate setting.

Parameters

TBool

The value to set the reject-duplicate setting to.


DeliveryReport()

inline TBool DeliveryReport() const;

Description

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.

Return value

TBool

The value of the Status report flag.


SetDeliveryReport()

inline void SetDeliveryReport(TBool);

Description

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.

Parameters

TBool

The value of the status report flag.


ReplyPath()

inline TBool ReplyPath() const;

Description

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.

Return value

TBool

The value of the reply path flag.


SetReplyPath()

inline void SetReplyPath(TBool);

Description

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.

Parameters

TBool

The value of the reply path flag.


MessageConversion()

inline TSmsPIDConversion MessageConversion() const;

Description

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.

Return value

TSmsPIDConversion

The value of the message form specifier.


SetMessageConversion()

inline void SetMessageConversion(TSmsPIDConversion);

Description

Sets 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.

Parameters

TSmsPIDConversion

The message form specifier.


InternalizeL()

virtual IMPORT_C void InternalizeL(RReadStream &aReadStream);

Description

Parameters

RReadStream &aReadStream


ExternalizeL()

virtual IMPORT_C void ExternalizeL(RWriteStream &aWriteStream) const;

Description

Parameters

RWriteStream &aWriteStream


CanConcatenate()

inline TBool CanConcatenate() const;

Description

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.

Return value

TBool

The concatenated-SMS-allowed flag.


SetCanConcatenate()

inline void SetCanConcatenate(TBool);

Description

Sets 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.

Parameters

TBool

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


ValidityPeriod()

inline const TTimeIntervalMinutes &ValidityPeriod() const;

Description

Return value

const TTimeIntervalMinutes &


SetValidityPeriod()

inline void SetValidityPeriod(TTimeIntervalMinutes);

Description

Parameters

TTimeIntervalMinutes


CharacterSet()

inline enum TSmsDataCodingScheme::TSmsAlphabet CharacterSet() const;

Description

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.

Return value

enum TSmsDataCodingScheme::TSmsAlphabet

The default character set for the message.


SetCharacterSet()

inline void SetCharacterSet(TSmsDataCodingScheme::TSmsAlphabet);

Description

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.

Parameters

TSmsDataCodingScheme::TSmsAlphabet

The value of the default character set for the message.


SetValidityPeriodFormat()

inline void SetValidityPeriodFormat(TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat);

Description

Parameters

TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat


ValidityPeriodFormat()

inline const TSmsFirstOctet::TSmsValidityPeriodFormat ValidityPeriodFormat() const;

Description

Return value

const TSmsFirstOctet::TSmsValidityPeriodFormat


CopyL()

virtual IMPORT_C void CopyL(const CSmsMessageSettings &aSettings);

Description

Copies the settings stored in the specified object into this object.

Parameters

const CSmsMessageSettings &aSettings

The settings to be copied.


RejectDuplicate()

inline TBool RejectDuplicate() const;

Description

Return value

TBool


SetRejectDuplicate()

inline void SetRejectDuplicate(TBool);

Description

Parameters

TBool


LastSegmentDeliveryReport()

inline TBool LastSegmentDeliveryReport() const;

Description

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.

Return value

TBool

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


DeliveryReport()

inline TBool DeliveryReport() const;

Description

Return value

TBool


SetLastSegmentDeliveryReport()

inline void SetLastSegmentDeliveryReport(TBool);

Description

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.

Parameters

TBool

The value of the status report flagfor the last segment.


SetDeliveryReport()

inline void SetDeliveryReport(TBool);

Description

Parameters

TBool


SetUseServiceCenterTimeStampForDate()

inline void SetUseServiceCenterTimeStampForDate(TBool aUseServiceCenterTimestamp);

Description

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.

Parameters

TBool aUseServiceCenterTimestamp

Flag to indicate whether to use the service center timestamp


ReplyPath()

inline TBool ReplyPath() const;

Description

Return value

TBool


UseServiceCenterTimeStampForDate()

inline TBool UseServiceCenterTimeStampForDate() const;

Description

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.

Return value

TBool

Flag which indcates if service center timestamp will be used.


SetReplyPath()

inline void SetReplyPath(TBool);

Description

Parameters

TBool


MessageConversion()

inline TSmsPIDConversion MessageConversion() const;

Description

Return value

TSmsPIDConversion


SetMessageConversion()

inline void SetMessageConversion(TSmsPIDConversion);

Description

Parameters

TSmsPIDConversion


CanConcatenate()

inline TBool CanConcatenate() const;

Description

Return value

TBool


SetCanConcatenate()

inline void SetCanConcatenate(TBool);

Description

Parameters

TBool


CharacterSet()

inline enum TSmsDataCodingScheme::TSmsAlphabet CharacterSet() const;

Description

Return value

enum TSmsDataCodingScheme::TSmsAlphabet


SetCharacterSet()

inline void SetCharacterSet(TSmsDataCodingScheme::TSmsAlphabet);

Description

Parameters

TSmsDataCodingScheme::TSmsAlphabet


CopyL()

virtual IMPORT_C void CopyL(const CSmsMessageSettings &aSettings);

Description

Parameters

const CSmsMessageSettings &aSettings


LastSegmentDeliveryReport()

inline TBool LastSegmentDeliveryReport() const;

Description

Return value

TBool


SetLastSegmentDeliveryReport()

inline void SetLastSegmentDeliveryReport(TBool aDeliveryReport);

Description

Parameters

TBool aDeliveryReport


SetUseServiceCenterTimeStampForDate()

inline void SetUseServiceCenterTimeStampForDate(TBool aUseServiceCenterTimestamp);

Description

Parameters

TBool aUseServiceCenterTimestamp


UseServiceCenterTimeStampForDate()

inline TBool UseServiceCenterTimeStampForDate() const;

Description

Return value

TBool