Symbian^3 Application Developer Library >

CFSMailRequestHandler Class Reference

class CFSMailRequestHandler : public CBase

email framework asynchronous request handler

FSFWCommonLib
Since
S60 v3.1

Inherits from

Public Member Functions
~CFSMailRequestHandler ()
IMPORT_C void AddPluginL ( TUid , CFSMailPlugin *)
IMPORT_C void CancelAllRequestsL ()
IMPORT_C void CancelRequestL ( TInt )
IMPORT_C void CleanTempDirL ()
IMPORT_C void CompleteRequest ( TInt )
IMPORT_C CFSMailPlugin * GetPluginByUid ( TFSMailMsgId )
IMPORT_C TDesC & GetTempDirL ()
RFile GetTempFileL ( TFSMailMsgId , TFileName )
IMPORT_C TFSPendingRequest InitAsyncRequestL ( TUid , MFSMailRequestObserver &)
IMPORT_C CFSMailRequestHandler * NewL ( RPointerArray < CImplementationInformation > &, RPointerArray < CFSMailPlugin > &)
IMPORT_C CFSMailRequestHandler * NewLC ( RPointerArray < CImplementationInformation > &, RPointerArray < CFSMailPlugin > &)
Protected Member Functions
CFSMailRequestHandler ()
void ConstructL ( RPointerArray < CImplementationInformation >, RPointerArray < CFSMailPlugin >)
Private Member Functions
void RemoveAllRequests ()
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()
Protected Attributes
RPointerArray < CFSMailPluginData > iPluginList
Private Attributes
RFs iFs
RArray < TFSPendingRequest > iPendingRequests
TUint iRequestId
HBufC * iTempDirName

Constructor & Destructor Documentation

CFSMailRequestHandler()

IMPORT_C CFSMailRequestHandler ( ) [protected]

C++ default constructor.

~CFSMailRequestHandler()

IMPORT_C ~CFSMailRequestHandler ( ) [virtual]

destructor.

Member Functions Documentation

AddPluginL(TUid, CFSMailPlugin *)

IMPORT_C void AddPluginL ( TUid aPluginId,
CFSMailPlugin * aPlugin
)

adds new plugin to plugin list

Parameters

TUid aPluginId uid of the new plugin
CFSMailPlugin * aPlugin plugin instance

CancelAllRequestsL()

IMPORT_C void CancelAllRequestsL ( )

cancels all pending asynchronous requests

CancelRequestL(TInt)

IMPORT_C void CancelRequestL ( TInt aRequestId )

cancels pending asynchronous request

Parameters

TInt aRequestId id of the request to be cancelled

CleanTempDirL()

IMPORT_C void CleanTempDirL ( )

cleans temp dir

CompleteRequest(TInt)

IMPORT_C void CompleteRequest ( TInt aRequestId )

completes asynchronous request

Parameters

TInt aRequestId id of the request to be completed

ConstructL(RPointerArray< CImplementationInformation >, RPointerArray< CFSMailPlugin >)

void ConstructL ( RPointerArray < CImplementationInformation > aPluginInfo,
RPointerArray < CFSMailPlugin > aPlugins
) [protected]

two based constructor

Parameters

RPointerArray < CImplementationInformation > aPluginInfo
RPointerArray < CFSMailPlugin > aPlugins

GetPluginByUid(TFSMailMsgId)

IMPORT_C CFSMailPlugin * GetPluginByUid ( TFSMailMsgId aPluginId ) [virtual]

returns plugin pointer related to plugin id

Parameters

TFSMailMsgId aPluginId plugin id

GetTempDirL()

IMPORT_C TDesC & GetTempDirL ( )

returns temp dir path

GetTempFileL(TFSMailMsgId, TFileName)

RFile GetTempFileL ( TFSMailMsgId aContentId,
TFileName aFileName
)

opens or creates file

Parameters

TFSMailMsgId aContentId
TFileName aFileName file name

InitAsyncRequestL(TUid, MFSMailRequestObserver &)

IMPORT_C TFSPendingRequest InitAsyncRequestL ( TUid aPluginId,
MFSMailRequestObserver & aOperationObserver
)

starts asynchronous request

Parameters

TUid aPluginId id of the target plugin request is accessed to
MFSMailRequestObserver & aOperationObserver observer to forward request progress events to user from plugin

NewL(RPointerArray< CImplementationInformation > &, RPointerArray< CFSMailPlugin > &)

IMPORT_C CFSMailRequestHandler * NewL ( RPointerArray < CImplementationInformation > & aPluginInfo,
RPointerArray < CFSMailPlugin > & aPlugins
) [static]

two based constructor

Parameters

RPointerArray < CImplementationInformation > & aPluginInfo plugin information table
RPointerArray < CFSMailPlugin > & aPlugins plugin instances table

NewLC(RPointerArray< CImplementationInformation > &, RPointerArray< CFSMailPlugin > &)

IMPORT_C CFSMailRequestHandler * NewLC ( RPointerArray < CImplementationInformation > & aPluginInfo,
RPointerArray < CFSMailPlugin > & aPlugins
) [static]

two based constructor

Parameters

RPointerArray < CImplementationInformation > & aPluginInfo plugin information table
RPointerArray < CFSMailPlugin > & aPlugins plugin instances table

RemoveAllRequests()

void RemoveAllRequests ( ) [private]

removes all asynchronous requests

Member Data Documentation

RFs iFs

RFs iFs [private]

temp directory files handling

RArray< TFSPendingRequest > iPendingRequests

RArray < TFSPendingRequest > iPendingRequests [private]

list of pending requests

RPointerArray< CFSMailPluginData > iPluginList

RPointerArray < CFSMailPluginData > iPluginList [protected]

list of loaded plugins

TUint iRequestId

TUint iRequestId [private]

request id counter

HBufC * iTempDirName

HBufC * iTempDirName [private]

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.