CMmsAccounts Class Reference

#include <app/cmmsaccounts.h>

Link against: mmsgenericsettings.lib

class CMmsAccounts : public CActive

Inherits from

  • CMmsAccounts
    Public Member Functions
    virtual ~CMmsAccounts()
    IMPORT_C voidAddObserverL(MMmsSettingsObserver &)
    IMPORT_C TMmsAccountIdCreateMMSAccountL(const TDesC &, const CMmsSettings &)
    IMPORT_C TMmsAccountIdDefaultMMSAccountL()
    IMPORT_C voidDeleteMMSAccountL(const TMmsAccountId &)
    IMPORT_C voidGetMMSAccountsL(RArray< TMmsAccountId > &)
    IMPORT_C voidLoadSettingsL(const TMmsAccountId &, CMmsSettings &)
    IMPORT_C TIntMaxMMSAccounts()
    IMPORT_C CMmsAccounts *NewL()
    IMPORT_C CMmsAccounts *NewLC()
    IMPORT_C voidPopulateDefaultSettingsL(CMmsSettings &)
    IMPORT_C voidRemoveObserver(MMmsSettingsObserver &)
    IMPORT_C voidSaveSettingsL(const TMmsAccountId &, const CMmsSettings &)
    IMPORT_C voidSetDefaultMMSAccountL(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 voidAddObserverL(MMmsSettingsObserver &aObserver)

    Registers a new MMS Settings observer.

    ParameterDescription
    aObserverA reference to an observer to be registered for events

    CreateMMSAccountL ( const TDesC &, const CMmsSettings & )

    IMPORT_C TMmsAccountIdCreateMMSAccountL(const TDesC &aAccountName,
    const CMmsSettings &aSettings
    )

    Creates a MMS Account.

    ParameterDescription
    aAccountNameMMS account Name
    aSettingsMMS Settings

    Returns: MMS Account Id

    DefaultMMSAccountL ( )

    IMPORT_C TMmsAccountIdDefaultMMSAccountL()const

    Gets the default MMS account.

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

    Returns: The default account

    DeleteMMSAccountL ( const TMmsAccountId & )

    IMPORT_C voidDeleteMMSAccountL(const TMmsAccountId &aAccountId)

    Deletes the specified MMS account.

    ParameterDescription
    aAccountIdMMS account Id

    GetMMSAccountsL ( RArray< TMmsAccountId > & )

    IMPORT_C voidGetMMSAccountsL(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.

    ParameterDescription
    aAccountIdsA list if MMS account Ids

    LoadSettingsL ( const TMmsAccountId &, CMmsSettings & )

    IMPORT_C voidLoadSettingsL(const TMmsAccountId &aAccountId,
    CMmsSettings &aSettings
    )

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

    ParameterDescription
    aAccountIdMMS account Id
    aSettingsMMS settings

    MaxMMSAccounts ( )

    IMPORT_C TIntMaxMMSAccounts()

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

    Returns: 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.

    Returns: 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.

    Returns: The newly constructed MMS account object.

    PopulateDefaultSettingsL ( CMmsSettings & )

    IMPORT_C voidPopulateDefaultSettingsL(CMmsSettings &aSettings)

    Populates the supplied setting object with default values.

    ParameterDescription
    aSettingsMMS Setting

    RemoveObserver ( MMmsSettingsObserver & )

    IMPORT_C voidRemoveObserver(MMmsSettingsObserver &aObserver)

    Deregisters a previously registered observer.

    ParameterDescription
    aObserverA reference to an observer to be unregistered for events

    SaveSettingsL ( const TMmsAccountId &, const CMmsSettings & )

    IMPORT_C voidSaveSettingsL(const TMmsAccountId &aAccountId,
    const CMmsSettings &aSettings
    )const

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

    ParameterDescription
    aAccountIdMMS account Id
    aSettingsMMS settings

    SetDefaultMMSAccountL ( const TMmsAccountId & )

    IMPORT_C voidSetDefaultMMSAccountL(const TMmsAccountId &aAccount)

    Sets the default MMS account.

    ParameterDescription
    aAccountAccount to be set as default
    © Nokia 2011.