CMmsAccounts Class Reference

#include <app/cmmsaccounts.h>

Link against: mmsgenericsettings.lib

class CMmsAccounts : public CActive

Inherits from

CMmsAccounts
- CActive
  - CBase

Public Member Functions
virtual	~CMmsAccounts()
IMPORT_C void	AddObserverL(MMmsSettingsObserver &)
IMPORT_C TMmsAccountId	CreateMMSAccountL(const TDesC &, const CMmsSettings &)
IMPORT_C TMmsAccountId	DefaultMMSAccountL()
IMPORT_C void	DeleteMMSAccountL(const TMmsAccountId &)
IMPORT_C void	GetMMSAccountsL(RArray< TMmsAccountId > &)
IMPORT_C void	LoadSettingsL(const TMmsAccountId &, CMmsSettings &)
IMPORT_C TInt	MaxMMSAccounts()
IMPORT_C CMmsAccounts *	NewL()
IMPORT_C CMmsAccounts *	NewLC()
IMPORT_C void	PopulateDefaultSettingsL(CMmsSettings &)
IMPORT_C void	RemoveObserver(MMmsSettingsObserver &)
IMPORT_C void	SaveSettingsL(const TMmsAccountId &, const CMmsSettings &)
IMPORT_C void	SetDefaultMMSAccountL(const TMmsAccountId &)

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Stores MMS settings.

Constructor & Destructor Documentation

~CMmsAccounts ( )

IMPORT_C

~CMmsAccounts

(

)

[virtual]

Destructor.

Member Function Documentation

AddObserverL ( MMmsSettingsObserver & )

IMPORT_C void

AddObserverL

(

MMmsSettingsObserver &

aObserver

)

Registers a new MMS Settings observer.

Parameters
aObserver	A reference to an observer to be registered for events

CreateMMSAccountL ( const TDesC &, const CMmsSettings & )

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

Creates a MMS Account.

Parameters
aAccountName	MMS account Name
aSettings	MMS Settings

Return Value: MMS Account Id

DefaultMMSAccountL ( )

IMPORT_C TMmsAccountId

DefaultMMSAccountL

(

)

const

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: The default account

Leave Codes

DeleteMMSAccountL ( const TMmsAccountId & )

IMPORT_C void

DeleteMMSAccountL

(

const TMmsAccountId &

aAccountId

)

Deletes the specified MMS account.

Parameters
aAccountId	MMS account Id

GetMMSAccountsL ( RArray< TMmsAccountId > & )

IMPORT_C void

GetMMSAccountsL

(

RArray< TMmsAccountId > &

aAccountIds

)

const

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

Any existing entries in the array will be deleted.

Parameters
aAccountIds	A list if MMS account Ids

LoadSettingsL ( const TMmsAccountId &, CMmsSettings & )

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

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

Parameters
aAccountId	MMS account Id
aSettings	MMS settings

MaxMMSAccounts ( )

IMPORT_C TInt

MaxMMSAccounts

(

)

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

Return Value: The maximum number of accounts

NewL ( )

IMPORT_C CMmsAccounts *

NewL

(

)

[static]

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return Value: The newly constructed MMS account object.

NewLC ( )

IMPORT_C CMmsAccounts *

NewLC

(

)

[static]

Allocates and constructs an MMS account object.

Initialises all member data to their default values.

Return Value: The newly constructed MMS account object.

PopulateDefaultSettingsL ( CMmsSettings & )

IMPORT_C void

PopulateDefaultSettingsL

(

CMmsSettings &

aSettings

)

Populates the supplied setting object with default values.

Parameters
aSettings	MMS Setting

RemoveObserver ( MMmsSettingsObserver & )

IMPORT_C void

RemoveObserver

(

MMmsSettingsObserver &

aObserver

)

Deregisters a previously registered observer.

Parameters
aObserver	A reference to an observer to be unregistered for events

SaveSettingsL ( const TMmsAccountId &, const CMmsSettings & )

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

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

Parameters
aAccountId	MMS account Id
aSettings	MMS settings

SetDefaultMMSAccountL ( const TMmsAccountId & )

IMPORT_C void

SetDefaultMMSAccountL

(

const TMmsAccountId &

aAccount

)

Sets the default MMS account.

Parameters
aAccount	Account to be set as default