Class CSmsAccount

class CSmsAccount : public CBase, public MMsvSessionObserver;

Description

Stores SMS service and Schedule Send settings to Central Repository.

Derivation

• MMsvSessionObserver - Provides the interface for notification of events from a Message Server session
• CBase - Base class for all classes to be instantiated on the heap

• CSmsAccount - Stores SMS service and Schedule Send settings to Central Repository

Members

Defined in CSmsAccount:
HandleSessionEventL(), HandleSessionEventL(), InitialiseDefaultSettingsL(), InitialiseDefaultSettingsL(), InitialiseDefaultSettingsL(), InitialiseDefaultSettingsL(), LoadSettingsL(), LoadSettingsL(), LoadSettingsL(), LoadSettingsL(), NewL(), NewL(), NewLC(), NewLC(), SaveSettingsL(), SaveSettingsL(), SaveSettingsL(), SaveSettingsL(), ~CSmsAccount(), ~CSmsAccount()

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

Inherited from MMsvSessionObserver:
EMsvCloseSession, EMsvCorruptedIndexRebuilding, EMsvCorruptedIndexRebuilt, EMsvEntriesChanged, EMsvEntriesCreated, EMsvEntriesDeleted, EMsvEntriesMoved, EMsvGeneralError, EMsvMediaAvailable, EMsvMediaChanged, EMsvMediaIncorrect, EMsvMediaUnavailable, EMsvMtmGroupDeInstalled, EMsvMtmGroupInstalled, EMsvServerFailedToStart, EMsvServerReady, EMsvServerTerminated, TMsvSessionEvent

static IMPORT_C CSmsAccount *NewL();

Description

Allocates and constructs an SMS account object.

Initialises all member data to their default values.

Return value

CSmsAccount * The newly constructed SMS account object.

static IMPORT_C CSmsAccount *NewL();

Description

Return value

CSmsAccount *

static IMPORT_C CSmsAccount *NewLC();

Description

Allocates and constructs an SMS account object.

Initialises all member data to their default values.

Return value

CSmsAccount * The newly constructed SMS account object.

static IMPORT_C CSmsAccount *NewLC();

Description

Return value

CSmsAccount *

virtual IMPORT_C ~CSmsAccount();

Description

Destructor.

virtual IMPORT_C ~CSmsAccount();

Description

IMPORT_C void InitialiseDefaultSettingsL(CSmsSettings &aSmsSettings);

Description

Initialises the SMS settings in CenRep:

1. Creates a SMS service entry in the message store

2. Resets the settings in CenRep to their default values

3. Populates aSmsSettings with default settings

Parameters

CSmsSettings &aSmsSettings SMS service settings

IMPORT_C void InitialiseDefaultSettingsL(CSmsSettings &aSmsSettings);

Description

Parameters

CSmsSettings &aSmsSettings

IMPORT_C void InitialiseDefaultSettingsL(CMsvScheduleSettings &aScheduleSettings, CMsvOffPeakTimes &aOffPeakTimes, CMsvSendErrorActions &aErrorActions, CMsvSysAgentActions &aSysAgentActions);

Description

Initialises the SMS settings in CenRep:

1. Creates a SMS service entry in the message store

2. Resets the settings in CenRep to their default values

3. Populates the supplied objects with default settings

Parameters

CMsvScheduleSettings &aScheduleSettings Schedule settings CMsvOffPeakTimes &aOffPeakTimes Off Peak Times CMsvSendErrorActions &aErrorActions Send Error Actions CMsvSysAgentActions &aSysAgentActions System Agent Actions

IMPORT_C void InitialiseDefaultSettingsL(CMsvScheduleSettings &aScheduleSettings, CMsvOffPeakTimes &aOffPeakTimes, CMsvSendErrorActions &aErrorActions, CMsvSysAgentActions &aSysAgentActions);

Description

Parameters

CMsvScheduleSettings &aScheduleSettings CMsvOffPeakTimes &aOffPeakTimes CMsvSendErrorActions &aErrorActions CMsvSysAgentActions &aSysAgentActions

IMPORT_C void LoadSettingsL(CSmsSettings &aSmsSettings);

Description

Loads SMS Service settings from CenRep:

Parameters

CSmsSettings &aSmsSettings Sms service settings

IMPORT_C void LoadSettingsL(CSmsSettings &aSmsSettings);

Description

Parameters

CSmsSettings &aSmsSettings

IMPORT_C void LoadSettingsL(CMsvScheduleSettings &aScheduleSettings, CMsvOffPeakTimes &aOffPeakTimes, CMsvSendErrorActions &aErrorActions, CMsvSysAgentActions &aSysAgentActions);

Description

Loads Schedule Send settings from CenRep:

Parameters

CMsvScheduleSettings &aScheduleSettings Schedule settings CMsvOffPeakTimes &aOffPeakTimes Off Peak Times CMsvSendErrorActions &aErrorActions Send Error Actions CMsvSysAgentActions &aSysAgentActions System Agent Actions

IMPORT_C void LoadSettingsL(CMsvScheduleSettings &aScheduleSettings, CMsvOffPeakTimes &aOffPeakTimes, CMsvSendErrorActions &aErrorActions, CMsvSysAgentActions &aSysAgentActions);

Description

Parameters

CMsvScheduleSettings &aScheduleSettings CMsvOffPeakTimes &aOffPeakTimes CMsvSendErrorActions &aErrorActions CMsvSysAgentActions &aSysAgentActions

IMPORT_C void SaveSettingsL(const CSmsSettings &aSmsSettings) const;

Description

Saves SMS Service settings to CenRep:

Parameters

const CSmsSettings &aSmsSettings Sms service settings

IMPORT_C void SaveSettingsL(const CSmsSettings &aSmsSettings) const;

Description

Parameters

const CSmsSettings &aSmsSettings

IMPORT_C void SaveSettingsL(const CMsvScheduleSettings &aScheduleSettings, const CMsvOffPeakTimes &aOffPeakTimes, const CMsvSendErrorActions &aErrorActions, const CMsvSysAgentActions &aSysAgentActions) const;

Description

Saves Schedule Send settings to CenRep:

Parameters

const CMsvScheduleSettings &aScheduleSettings Schedule settings const CMsvOffPeakTimes &aOffPeakTimes Off Peak Times const CMsvSendErrorActions &aErrorActions Send Error Actions const CMsvSysAgentActions &aSysAgentActions System Agent Actions

IMPORT_C void SaveSettingsL(const CMsvScheduleSettings &aScheduleSettings, const CMsvOffPeakTimes &aOffPeakTimes, const CMsvSendErrorActions &aErrorActions, const CMsvSysAgentActions &aSysAgentActions) const;

Description

Parameters

const CMsvScheduleSettings &aScheduleSettings const CMsvOffPeakTimes &aOffPeakTimes const CMsvSendErrorActions &aErrorActions const CMsvSysAgentActions &aSysAgentActions

private: virtual void HandleSessionEventL(TMsvSessionEvent, TAny *, TAny *, TAny *);

Description

Indicates an event has occurred.

The type of event is indicated by the value of aEvent. The interpretation of the TAny arguments depends on this type.

For most event types, the action that is taken, for example, updating the display, is client-specific. All clients though should respond to EMsvCloseSession and EMsvServerTerminated events.

Parameters

TMsvSessionEvent Indicates the event type. TAny * TAny * TAny *

private: virtual void HandleSessionEventL(TMsvSessionEvent, TAny *, TAny *, TAny *);

Description

Indicates an event has occurred.

The type of event is indicated by the value of aEvent. The interpretation of the TAny arguments depends on this type.

For most event types, the action that is taken, for example, updating the display, is client-specific. All clients though should respond to EMsvCloseSession and EMsvServerTerminated events.

Parameters

TMsvSessionEvent TAny * TAny * TAny *