Symbian^3 Application Developer Library >

CMmsApplicationAdapter Class Reference

class CMmsApplicationAdapter : public CBase
mmsappadapter.lib
Since
3.0

Inherits from

Public Member Functions
~CMmsApplicationAdapter ()
IMPORT_C TPtrC16 ApplicationIdL ( TMsvId )
IMPORT_C TInt DeleteL ( TMsvId )
IMPORT_C TMsvId FolderIdL (const TDesC &)
IMPORT_C TInt MmscUrlL ( HBufC *&)
IMPORT_C CMmsApplicationAdapter * NewL ()
IMPORT_C TInt RegisterL (const TDesC &, TMsvId &)
IMPORT_C TInt RegisterWithNameL (const TDesC &, const TDesC &, TMsvId &)
IMPORT_C const CDesCArray & RegisteredApplicationList ()
IMPORT_C TBool RegisteredL (const TDesC &)
IMPORT_C TPtrC16 ReplyToApplicationIdL ( TMsvId )
IMPORT_C void SetApplicationIdL ( TMsvId , const TDesC &)
IMPORT_C void SetReplyToApplicationIdL ( TMsvId , const TDesC &)
IMPORT_C TInt UnregisterL (const TDesC &)
IMPORT_C TPtrC UserFriendlyName (const TDesC &)
Protected Member Functions
void HandleSessionEventL (TMsvSessionEvent, TAny *, TAny *, TAny *)
Private Member Functions
CMmsApplicationAdapter ()
void ConstructL ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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()
Private Attributes
CMsvEntry * iClientEntry
CMmsHeaders * iMmsHeaders
CMmsSettings * iMmsSettings
CMmsRegisteredApplications * iRegAppIds
CMsvSession * iSession

Constructor & Destructor Documentation

CMmsApplicationAdapter()

CMmsApplicationAdapter ( ) [private]
C++ default constructor. C++ default constructor can NOT contain any code, that might leave.
Since
3.0

~CMmsApplicationAdapter()

~CMmsApplicationAdapter ( ) [virtual]

Destructor.

Member Functions Documentation

ApplicationIdL(TMsvId)

IMPORT_C TPtrC16 ApplicationIdL ( TMsvId aMmId )

Application ID

Since
3.0

Parameters

TMsvId aMmId Index to the multimedia message

ConstructL()

void ConstructL ( ) [private]
By default Symbian 2nd phase constructor is private.
Since
3.0

DeleteL(TMsvId)

IMPORT_C TInt DeleteL ( TMsvId aMmId )

Delete the specified MM.

Since
3.0

Parameters

TMsvId aMmId Index to the MM, which will be deleted.

FolderIdL(const TDesC &)

IMPORT_C TMsvId FolderIdL ( const TDesC & aApplicationId )

Folder Entry ID

Since
3.0

Parameters

const TDesC & aApplicationId application id

HandleSessionEventL(TMsvSessionEvent, TAny *, TAny *, TAny *)

void HandleSessionEventL ( TMsvSessionEvent aEvent,
TAny * aArg1,
TAny * aArg2,
TAny * aArg3
) [protected, virtual]
From MMsvSessionObserver .
Since
3.0

Parameters

TMsvSessionEvent aEvent the caller of the method sets the value.
TAny * aArg1 depends on the aEvent value
TAny * aArg2 depends on the aEvent value
TAny * aArg3 depends on the aEvent value

MmscUrlL(HBufC *&)

IMPORT_C TInt MmscUrlL ( HBufC *& aServerUri )

MmscUrlL

Since
3.0
Usage: aServerUri should not be allocated by the caller of this method. The buffer is pushed onto CleanupStack temporarily. The caller is responsible for destroying the buffer when the buffer is no longer needed.

Note that if the uri is not defined, KErrNone is returned.

Parameters

HBufC *& aServerUri

NewL()

IMPORT_C CMmsApplicationAdapter * NewL ( ) [static]

Two-phased constructor.

RegisterL(const TDesC &, TMsvId &)

IMPORT_C TInt RegisterL ( const TDesC & aApplicationId,
TMsvId & aFolderId
)

Register application.

Since
3.0

Parameters

const TDesC & aApplicationId application id
TMsvId & aFolderId folder id for this application id.

RegisterWithNameL(const TDesC &, const TDesC &, TMsvId &)

IMPORT_C TInt RegisterWithNameL ( const TDesC & aApplicationId,
const TDesC & aUserFriendlyName,
TMsvId & aFolderId
)

Register application.

Since
3.2

Parameters

const TDesC & aApplicationId application id
const TDesC & aUserFriendlyName user friendly name for the application
TMsvId & aFolderId folder id for this application id (return value).

RegisteredApplicationList()

IMPORT_C const CDesCArray & RegisteredApplicationList ( ) const

Return a list of registered applications

Since
3.1

RegisteredL(const TDesC &)

IMPORT_C TBool RegisteredL ( const TDesC & aApplicationId )

RegisteredL

checks if the application id is registered or not
Since
3.0

Parameters

const TDesC & aApplicationId application id

ReplyToApplicationIdL(TMsvId)

IMPORT_C TPtrC16 ReplyToApplicationIdL ( TMsvId aMmId )

Reply to Application ID

Since
3.0

Parameters

TMsvId aMmId Index to the multimedia message

SetApplicationIdL(TMsvId, const TDesC &)

IMPORT_C void SetApplicationIdL ( TMsvId aMmId,
const TDesC & aApplicationId
)

Set application ID

Since
3.0

Parameters

TMsvId aMmId Index to the multimedia message
const TDesC & aApplicationId application id

SetReplyToApplicationIdL(TMsvId, const TDesC &)

IMPORT_C void SetReplyToApplicationIdL ( TMsvId aMmId,
const TDesC & aReplyToApplicationId
)

Set reply to application ID

Since
3.0

Parameters

TMsvId aMmId Index to the multimedia message
const TDesC & aReplyToApplicationId reply to application id

UnregisterL(const TDesC &)

IMPORT_C TInt UnregisterL ( const TDesC & aApplicationId )

Unregister application The function destroys the corresponding folder and its content.

Since
3.0

Parameters

const TDesC & aApplicationId application id

UserFriendlyName(const TDesC &)

IMPORT_C TPtrC UserFriendlyName ( const TDesC & aApplicationId )

Get User Friendly Name for an application

Since
3.2

Parameters

const TDesC & aApplicationId application id

Member Data Documentation

CMsvEntry * iClientEntry

CMsvEntry * iClientEntry [private]

CMmsHeaders * iMmsHeaders

CMmsHeaders * iMmsHeaders [private]

CMmsSettings * iMmsSettings

CMmsSettings * iMmsSettings [private]

CMmsRegisteredApplications * iRegAppIds

CMmsRegisteredApplications * iRegAppIds [private]

CMsvSession * iSession

CMsvSession * iSession [private]

Functions from CMmsBaseOperation

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.