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(MMmsSettingsObserver &)Registers a new MMS Settings observer.
• CreateMMSAccountL(const TDesC &,const CMmsSettings &)Creates a MMS Account.
• DefaultMMSAccountL()constGets the default MMS account.
• DeleteMMSAccountL(const TMmsAccountId &)Deletes the specified MMS account.
• DoCancel()Implements cancellation of an outstanding request.
• GetMMSAccountsL(RArray< TMmsAccountId > &)constGets a list of MMS account IDs stored in the Central Repository.
• LoadSettingsL(const TMmsAccountId &,CMmsSettings &)Loads MMS settings from the Central Repository for the specified account Id.
• MaxMMSAccounts()Maximum number of accounts that can be stored in the Central Repository
• NewL()Allocates and constructs an MMS account object.
• NewLC()Allocates and constructs an MMS account object.
• PopulateDefaultSettingsL(CMmsSettings &)Populates the supplied setting object with default values.
• RemoveObserver(MMmsSettingsObserver &)Deregisters a previously registered observer.
• RunL()Handles an active object's request completion event.
• SaveSettingsL(const TMmsAccountId &,const CMmsSettings &)constSaves MMS settings to the Central Repository for the specified account Id.
• SetDefaultMMSAccountL(const TMmsAccountId &)Sets the default MMS account.
• ~CMmsAccounts()Destructor.

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CMmsAccounts* NewL();

Description

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return value

IMPORT_C static CMmsAccounts* NewLC();

Description

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return value

IMPORT_C virtual ~CMmsAccounts();

Description

Destructor.

IMPORT_C void AddObserverL(MMmsSettingsObserver &aObserver);

Description

Registers a new MMS Settings observer.

Parameters

IMPORT_C void RemoveObserver(MMmsSettingsObserver &aObserver);

Description

Deregisters a previously registered observer.

Parameters

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

Description

Creates a MMS Account.

Parameters

Return value

IMPORT_C TInt MaxMMSAccounts();

Description

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

Return value

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

IMPORT_C void DeleteMMSAccountL(const TMmsAccountId &aAccountId);

Description

Deletes the specified MMS account.

Parameters

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

Description

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

Parameters

IMPORT_C void PopulateDefaultSettingsL(CMmsSettings &aSettings);

Description

Populates the supplied setting object with default values.

Parameters

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

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

Leave codes

IMPORT_C void SetDefaultMMSAccountL(const TMmsAccountId &aAccount);

Description

Sets the default MMS account.

Parameters

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::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.

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

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.

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 CMmsAccounts::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)

CMmsAccounts::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CActive::RunError(TInt) 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 CMmsAccounts::RunL() or CActive::RunError(TInt) functions.

See also:

• CActiveScheduler::Start()Starts a new wait loop under the control of the current active scheduler.
• CActiveScheduler::Error(TInt)constHandles the result of a leave occurring in an active object’s RunL() function.
• CActiveScheduler::WaitForAnyRequest()Wait for an asynchronous request to complete.