Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: SMUTSET.H
Link against: smcm.lib

Class CSmsSettings

class CSmsSettings : public CSmsMessageSettings;

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.

Derivation

Members

Defined in CSmsSettings:
AddServiceCenterL(), AddServiceCenterL(), AlertOnDelivery(), Class2Folder(), Class2Folder(), CommDbAction(), CommDbAction(), CopyL(), CopyL(), DefaultServiceCenter(), DefaultServiceCenter(), DefaultTeleservice(), Delivery(), Delivery(), DescriptionLength(), DescriptionLength(), DigitMode(), EDiscardReport, EDiscardReport, EDiscardReportAndMatch, EDiscardReportAndMatch, EDoNotWatchForReport, EDoNotWatchForReport, EMoveReportToInboxInvisible, EMoveReportToInboxInvisible, EMoveReportToInboxInvisibleAndMatch, EMoveReportToInboxInvisibleAndMatch, EMoveReportToInboxVisible, EMoveReportToInboxVisible, EMoveReportToInboxVisibleAndMatch, EMoveReportToInboxVisibleAndMatch, ENone, ENone, ESmsBearerCircuitOnly, ESmsBearerCircuitOnly, ESmsBearerCircuitPreferred, ESmsBearerCircuitPreferred, ESmsBearerPacketOnly, ESmsBearerPacketOnly, ESmsBearerPacketPreferred, ESmsBearerPacketPreferred, EStoreToCommDb, EStoreToCommDb, GetServiceCenter(), GetServiceCenter(), MessageDisplayMode(), NewL(), NewL(), NewLC(), NewLC(), PreferedLanguageList(), PreferedLanguageList(), RemoveServiceCenter(), RemoveServiceCenter(), ReplyQuoted(), ReplyQuoted(), ReplyWithOriginalMessage(), ServiceCenterCount(), ServiceCenterCount(), SetAlertOnDelivery(), SetClass2Folder(), SetClass2Folder(), SetCommDbAction(), SetCommDbAction(), SetDefaultServiceCenter(), SetDefaultServiceCenter(), SetDefaultTeleservice(), SetDelivery(), SetDelivery(), SetDescriptionLength(), SetDescriptionLength(), SetDigitMode(), SetMessageDisplayMode(), SetReplyQuoted(), SetReplyQuoted(), SetReplyWithOriginalMessage(), SetSmsBearer(), SetSmsBearer(), SetSmsBearerAction(), SetSmsBearerAction(), SetSpecialMessageHandling(), SetSpecialMessageHandling(), SetStatusReportHandling(), SetStatusReportHandling(), SmsBearer(), SmsBearer(), SmsBearerAction(), SmsBearerAction(), SpecialMessageHandling(), SpecialMessageHandling(), StatusReportHandling(), StatusReportHandling(), TMobileSmsBearer, TMobileSmsBearer, TSmsReportHandling, TSmsReportHandling, TSmsSettingsCommDbAction, TSmsSettingsCommDbAction, ~CSmsSettings(), ~CSmsSettings()

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

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


Construction and destruction


NewL()

static IMPORT_C CSmsSettings *NewL();

Description

Allocates and constructs an SMS settings object.

Initialises all member data to their default values.

Return value

CSmsSettings *

The newly constructed SMS settings object.


NewLC()

static IMPORT_C CSmsSettings *NewLC();

Description

Allocates and constructs an SMS settings object.

Initialises all member data to their default values.

Return value

CSmsSettings *

The newly constructed SMS settings object.


~CSmsSettings()

virtual IMPORT_C ~CSmsSettings();

Description

Destructor.


NewL()

static IMPORT_C CSmsSettings *NewL();

Description

Return value

CSmsSettings *


NewLC()

static IMPORT_C CSmsSettings *NewLC();

Description

Return value

CSmsSettings *


~CSmsSettings()

virtual IMPORT_C ~CSmsSettings();

Description

[Top]


Member functions


ServiceCenterCount()

IMPORT_C TInt ServiceCenterCount() const;

Description

Gets the number of Service Centre addresses stored in this object.

Return value

TInt

The number of addresses.


GetServiceCenter()

IMPORT_C CSmsServiceCenter &GetServiceCenter(TInt aIndex) const;

Description

Gets the Service Centre address at the specified index in the list.

Parameters

TInt aIndex

The index of the specified address.

Return value

CSmsServiceCenter &

The indexed address.


AddServiceCenterL()

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

Description

Appends a service centre address (name and number) to the list.

Parameters

const TDesC &aName

The Service Centre name

const TDesC &aNumber

The Service Centre number.


RemoveServiceCenter()

IMPORT_C void RemoveServiceCenter(TInt aIndex);

Description

Removes the service centre address with index aIndex from the array of service centre addresses that are stored in the object.

Parameters

TInt aIndex

The index of the Service Centre address to remove.


DefaultServiceCenter()

IMPORT_C TInt DefaultServiceCenter() const;

Description

Gets the index of the default service centre address for this service.

Return value

TInt

The index of the default service centre address.


SetDefaultServiceCenter()

IMPORT_C void SetDefaultServiceCenter(TInt aDefaultSC);

Description

Sets the index of the default service centre address for this service.

Parameters

TInt aDefaultSC

An index into the list of the default service centre address.

Panic codes

SMCM

7 The specified index is negative or beyond the maximum index (debug only).


Delivery()

inline TSmsDelivery Delivery() const;

Description

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

Return value

TSmsDelivery

The schedule delivery type.


SetDelivery()

inline void SetDelivery(TSmsDelivery);

Description

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

Parameters

TSmsDelivery

The schedule delivery type.


ReplyQuoted()

inline TBool ReplyQuoted() const;

Description

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

Return value

TBool

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


SetReplyQuoted()

inline void SetReplyQuoted(TBool);

Description

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

Parameters

TBool


CopyL()

IMPORT_C void CopyL(const CSmsSettings &aSmsSettings);

Description

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

Parameters

const CSmsSettings &aSmsSettings

The SMS Settings to be copied.


StatusReportHandling()

inline TSmsReportHandling StatusReportHandling() const;

Description

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.

Return value

TSmsReportHandling

How SMS status reports are handled.

See also:


SetStatusReportHandling()

inline void SetStatusReportHandling(TSmsReportHandling aStatusReportHandling);

Description

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

Parameters

TSmsReportHandling aStatusReportHandling

The SMS status report handling data.

See also:


SpecialMessageHandling()

inline TSmsReportHandling SpecialMessageHandling() const;

Description

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.

Return value

TSmsReportHandling

How special messages are handled.

See also:


SetSpecialMessageHandling()

inline void SetSpecialMessageHandling(TSmsReportHandling aSpecialMessageHandling);

Description

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

Parameters

TSmsReportHandling aSpecialMessageHandling

The special messages handling data.

See also:


SetCommDbAction()

inline void SetCommDbAction(TSmsSettingsCommDbAction aCommDbAction);

Description

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.

Parameters

TSmsSettingsCommDbAction aCommDbAction

The communications database action.

See also:


CommDbAction()

inline TSmsSettingsCommDbAction CommDbAction() const;

Description

Gets the communications database action.

For details, see CSmsSettings::SetCommDbAction().

Return value

TSmsSettingsCommDbAction

The communications database action.

See also:


SetSmsBearerAction()

inline void SetSmsBearerAction(TSmsSettingsCommDbAction aSmsBearerAction);

Description

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.

Parameters

TSmsSettingsCommDbAction aSmsBearerAction

The SMS bearer action.

See also:


ServiceCenterCount()

IMPORT_C TInt ServiceCenterCount() const;

Description

Return value

TInt


SmsBearerAction()

inline TSmsSettingsCommDbAction SmsBearerAction() const;

Description

Gets the SMS bearer action.

For details, see CSmsSettings::SetCommDbAction().

Return value

TSmsSettingsCommDbAction

The SMS bearer action.

See also:


GetServiceCenter()

IMPORT_C CSmsServiceCenter &GetServiceCenter(TInt aIndex) const;

Description

Parameters

TInt aIndex

Return value

CSmsServiceCenter &


AddServiceCenterL()

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

Description

Parameters

const TDesC &aName

const TDesC &aNumber


SetSmsBearer()

inline void SetSmsBearer(TMobileSmsBearer aSmsBearer);

Description

Sets the SMS bearer.

Parameters

TMobileSmsBearer aSmsBearer

The SMS bearer.


RemoveServiceCenter()

IMPORT_C void RemoveServiceCenter(TInt aIndex);

Description

Parameters

TInt aIndex


SmsBearer()

inline TMobileSmsBearer SmsBearer() const;

Description

Gets the SMS bearer.

Return value

TMobileSmsBearer

The SMS bearer.


DefaultServiceCenter()

IMPORT_C TInt DefaultServiceCenter() const;

Description

Return value

TInt


SetDefaultServiceCenter()

IMPORT_C void SetDefaultServiceCenter(TInt aDefaultSC);

Description

Parameters

TInt aDefaultSC


SetClass2Folder()

inline void SetClass2Folder(TMsvId aId);

Description

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

Parameters

TMsvId aId

The folder ID for received class 2 messages.


Delivery()

inline TSmsDelivery Delivery() const;

Description

Return value

TSmsDelivery


Class2Folder()

inline TMsvId Class2Folder() const;

Description

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

Return value

TMsvId

The class 2 folder ID.


SetDelivery()

inline void SetDelivery(TSmsDelivery);

Description

Parameters

TSmsDelivery


SetDescriptionLength()

inline void SetDescriptionLength(TInt aLength);

Description

Sets the maximum length of the message entry description.

The default value is given by KSmsDescriptionLength.

Parameters

TInt aLength

The maximum length.


ReplyQuoted()

inline TBool ReplyQuoted() const;

Description

Return value

TBool


DescriptionLength()

inline TInt DescriptionLength() const;

Description

Gets the maximum length of the message entry description.

Return value

TInt

The maximum length of the message entry description.


SetReplyQuoted()

inline void SetReplyQuoted(TBool);

Description

Parameters

TBool


CopyL()

IMPORT_C void CopyL(const CSmsSettings &aSmsSettings);

Description

Parameters

const CSmsSettings &aSmsSettings


StatusReportHandling()

inline TSmsReportHandling StatusReportHandling() const;

Description

Return value

TSmsReportHandling


SetStatusReportHandling()

inline void SetStatusReportHandling(TSmsReportHandling aStatusReportHandling);

Description

Parameters

TSmsReportHandling aStatusReportHandling


SpecialMessageHandling()

inline TSmsReportHandling SpecialMessageHandling() const;

Description

Return value

TSmsReportHandling


SetSpecialMessageHandling()

inline void SetSpecialMessageHandling(TSmsReportHandling aSpecialMessageHandling);

Description

Parameters

TSmsReportHandling aSpecialMessageHandling


SetCommDbAction()

inline void SetCommDbAction(TSmsSettingsCommDbAction aCommDbAction);

Description

Parameters

TSmsSettingsCommDbAction aCommDbAction


CommDbAction()

inline TSmsSettingsCommDbAction CommDbAction() const;

Description

Return value

TSmsSettingsCommDbAction


SetSmsBearerAction()

inline void SetSmsBearerAction(TSmsSettingsCommDbAction aSmsBearerAction);

Description

Parameters

TSmsSettingsCommDbAction aSmsBearerAction


SmsBearerAction()

inline TSmsSettingsCommDbAction SmsBearerAction() const;

Description

Return value

TSmsSettingsCommDbAction


SetSmsBearer()

inline void SetSmsBearer(TMobileSmsBearer aSmsBearer);

Description

Parameters

TMobileSmsBearer aSmsBearer


SmsBearer()

inline TMobileSmsBearer SmsBearer() const;

Description

Return value

TMobileSmsBearer


SetClass2Folder()

inline void SetClass2Folder(TMsvId aId);

Description

Parameters

TMsvId aId


Class2Folder()

inline TMsvId Class2Folder() const;

Description

Return value

TMsvId


SetDescriptionLength()

inline void SetDescriptionLength(TInt aLength);

Description

Parameters

TInt aLength


DescriptionLength()

inline TInt DescriptionLength() const;

Description

Return value

TInt


ReplyWithOriginalMessage()

IMPORT_C TSmsReplyWithOriginal ReplyWithOriginalMessage() const;

Description

Defines where the original message gets attached at when replying

Return value

TSmsReplyWithOriginal

Location


SetReplyWithOriginalMessage()

IMPORT_C void SetReplyWithOriginalMessage(TSmsReplyWithOriginal aOriginalAddedAt);

Description

Defines where the original message gets attached at when replying

Parameters

TSmsReplyWithOriginal aOriginalAddedAt

Location


DefaultTeleservice()

IMPORT_C tia637::TTeleserviceId DefaultTeleservice() const;

Description

Retrieves the Teleservice used as a default when creating a SendAs messages

Return value

tia637::TTeleserviceId

Teleservice used as a default


SetDefaultTeleservice()

IMPORT_C void SetDefaultTeleservice(tia637::TTeleserviceId aTeleservice);

Description

Defines which Teleservice shall be used as a default when creating a SendAs messages

Parameters

tia637::TTeleserviceId aTeleservice

Teleservice to be used as a default


AlertOnDelivery()

IMPORT_C tia637::TAlertPriority AlertOnDelivery() const;

Description

Returns the alert priority (Alert on delivery).

Return value

tia637::TAlertPriority

Alert priority


SetAlertOnDelivery()

IMPORT_C void SetAlertOnDelivery(tia637::TAlertPriority aPriority);

Description

Sets the alert priority (Alert on delivery).

Parameters

tia637::TAlertPriority aPriority

Alert priority


PreferedLanguageList()

IMPORT_C const CArrayFixFlat< tia637::TLanguageIndicator > &PreferedLanguageList() const;

Description

Returns a non-modifiable reference to the preferred language list.

Return value

const CArrayFixFlat< tia637::TLanguageIndicator > &

Preferred language list


PreferedLanguageList()

IMPORT_C CArrayFixFlat< tia637::TLanguageIndicator > &PreferedLanguageList();

Description

Returns a modifiable reference to the preferred language list.

Return value

CArrayFixFlat< tia637::TLanguageIndicator > &

Preferred language list


MessageDisplayMode()

IMPORT_C tia637::TBdMode MessageDisplayMode() const;

Description

Returns the message display mode.

Return value

tia637::TBdMode

Message display mode


SetMessageDisplayMode()

IMPORT_C void SetMessageDisplayMode(tia637::TBdMode aMode);

Description

Sets the message display mode.

Parameters

tia637::TBdMode aMode

Message display mode


DigitMode()

IMPORT_C TSmsCdmaDigitMode DigitMode() const;

Description

Gets the default encoding for ISDN addresses

Return value

TSmsCdmaDigitMode

Encoding


SetDigitMode()

IMPORT_C void SetDigitMode(TSmsCdmaDigitMode aDigitMode);

Description

Sets default encoding for ISDN addresses

Parameters

TSmsCdmaDigitMode aDigitMode

Encoding for ISDN addresses

[Top]


Member enumerations


Enum TSmsReportHandling

TSmsReportHandling

Description

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

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 TSmsReportHandling

TSmsReportHandling

Description

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

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

TSmsSettingsCommDbAction

Description

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.

ENone

The comms database should not be updated.

EStoreToCommDb

Use the Service settings to update the comms datebase.


Enum TMobileSmsBearer

TMobileSmsBearer

Description

Defines the SMS bearer. Modes: GSM

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 TSmsSettingsCommDbAction

TSmsSettingsCommDbAction

Description

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.

ENone

The comms database should not be updated.

EStoreToCommDb

Use the Service settings to update the comms datebase.


Enum TMobileSmsBearer

TMobileSmsBearer

Description

Defines the SMS bearer.

Modes: GSM

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.