Class CMmsAccounts

class CMmsAccounts : public CActive;

Description

Stores MMS settings.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CMmsAccounts - Stores MMS settings

Members

Defined in CMmsAccounts:
AddObserverL(), CreateMMSAccountL(), DefaultMMSAccountL(), DeleteMMSAccountL(), DoCancel(), GetMMSAccountsL(), LoadSettingsL(), MaxMMSAccounts(), NewL(), NewLC(), PopulateDefaultSettingsL(), RemoveObserver(), RunL(), SaveSettingsL(), SetDefaultMMSAccountL(), ~CMmsAccounts()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), RunError(), SetActive(), SetPriority(), TPriority, iStatus

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

static IMPORT_C CMmsAccounts *NewL();

Description

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return value

CMmsAccounts * The newly constructed MMS account object.

static IMPORT_C CMmsAccounts *NewLC();

Description

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return value

CMmsAccounts * The newly constructed MMS account object.

virtual IMPORT_C ~CMmsAccounts();

Description

Destructor.

IMPORT_C void AddObserverL(MMmsSettingsObserver &aObserver);

Description

Registers a new MMS Settings observer.

Parameters

MMmsSettingsObserver &aObserver A reference to an observer to be registered for events

IMPORT_C void RemoveObserver(MMmsSettingsObserver &aObserver);

Description

Deregisters a previously registered observer.

Parameters

MMmsSettingsObserver &aObserver A reference to an observer to be unregistered for events

IMPORT_C TMmsAccountId CreateMMSAccountL(const TDesC &aAccountName, const CMmsSettings &aSettings);

Description

Creates a MMS Account.

Parameters

const TDesC &aAccountName MMS account Name const CMmsSettings &aSettings MMS Settings

Return value

TMmsAccountId MMS Account Id

IMPORT_C TInt MaxMMSAccounts();

Description

Maximum number of accounts that can be stored in the Central Repository

Return value

TInt The maximum number of accounts

IMPORT_C void GetMMSAccountsL(RArray< TMmsAccountId > &aAccountIds) const;

Description

Gets a list of MMS account IDs stored in the Central Repository.

Any existing entries in the array will be deleted.

Parameters

RArray< TMmsAccountId > &aAccountIds A list if MMS account Ids

IMPORT_C void DeleteMMSAccountL(const TMmsAccountId &aAccountId);

Description

Deletes the specified MMS account.

Parameters

const TMmsAccountId &aAccountId MMS account Id

IMPORT_C void LoadSettingsL(const TMmsAccountId &aAccountId, CMmsSettings &aSettings);

Description

Loads MMS settings from the Central Repository for the specified account Id.

Parameters

const TMmsAccountId &aAccountId MMS account Id CMmsSettings &aSettings MMS settings

IMPORT_C void PopulateDefaultSettingsL(CMmsSettings &aSettings);

Description

Populates the supplied setting object with default values.

Parameters

CMmsSettings &aSettings MMS Setting

IMPORT_C void SaveSettingsL(const TMmsAccountId &aAccountId, const CMmsSettings &aSettings) const;

Description

Saves MMS settings to the Central Repository for the specified account Id.

Parameters

const TMmsAccountId &aAccountId MMS account Id const CMmsSettings &aSettings MMS settings

IMPORT_C TMmsAccountId DefaultMMSAccountL() const;

Description

Gets the default MMS account.

KErrNotFound If the default account not been set previously or if MMSSettings for the default account does not exist in the Central Repository.

Return value

TMmsAccountId The default account

Leave codes

IMPORT_C void SetDefaultMMSAccountL(const TMmsAccountId &aAccount);

Description

Sets the default MMS account.

Parameters

const TMmsAccountId &aAccount Account to be set as default

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

private: virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.