Symbian^3 Product Developer Library >

CFSMailRequestHandler Class Reference

class CFSMailRequestHandler : public CBase

email framework asynchronous request handler

FSFWCommonLib
Since
S60 v3.1

Inherits from

  • CFSMailRequestHandler
Public Member Functions
~CFSMailRequestHandler()
IMPORT_C voidAddPluginL(TUid, CFSMailPlugin *)
IMPORT_C voidCancelAllRequestsL()
IMPORT_C voidCancelRequestL(TInt)
IMPORT_C voidCleanTempDirL()
IMPORT_C voidCompleteRequest(TInt)
IMPORT_C CFSMailPlugin *GetPluginByUid(TFSMailMsgId)
IMPORT_C TDesC &GetTempDirL()
RFile GetTempFileL(TFSMailMsgId, TFileName)
IMPORT_C TFSPendingRequestInitAsyncRequestL(TUid, MFSMailRequestObserver &)
IMPORT_C CFSMailRequestHandler *NewL(RPointerArray< CImplementationInformation > &, RPointerArray< CFSMailPlugin > &)
IMPORT_C CFSMailRequestHandler *NewLC(RPointerArray< CImplementationInformation > &, RPointerArray< CFSMailPlugin > &)
Protected Member Functions
CFSMailRequestHandler()
voidConstructL(RPointerArray< CImplementationInformation >, RPointerArray< CFSMailPlugin >)
Private Member Functions
voidRemoveAllRequests()
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_CCFSMailRequestHandler()[protected]

C++ default constructor.

~CFSMailRequestHandler()

IMPORT_C~CFSMailRequestHandler()[virtual]

destructor.

Member Functions Documentation

AddPluginL(TUid, CFSMailPlugin *)

IMPORT_C voidAddPluginL(TUidaPluginId,
CFSMailPlugin *aPlugin
)

adds new plugin to plugin list

Parameters

TUid aPluginIduid of the new plugin
CFSMailPlugin * aPluginplugin instance

CancelAllRequestsL()

IMPORT_C voidCancelAllRequestsL()

cancels all pending asynchronous requests

CancelRequestL(TInt)

IMPORT_C voidCancelRequestL(TIntaRequestId)

cancels pending asynchronous request

Parameters

TInt aRequestIdid of the request to be cancelled

CleanTempDirL()

IMPORT_C voidCleanTempDirL()

cleans temp dir

CompleteRequest(TInt)

IMPORT_C voidCompleteRequest(TIntaRequestId)

completes asynchronous request

Parameters

TInt aRequestIdid of the request to be completed

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

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

two based constructor

Parameters

RPointerArray< CImplementationInformation > aPluginInfo
RPointerArray< CFSMailPlugin > aPlugins

GetPluginByUid(TFSMailMsgId)

IMPORT_C CFSMailPlugin *GetPluginByUid(TFSMailMsgIdaPluginId)[virtual]

returns plugin pointer related to plugin id

Parameters

TFSMailMsgId aPluginIdplugin id

GetTempDirL()

IMPORT_C TDesC &GetTempDirL()

returns temp dir path

GetTempFileL(TFSMailMsgId, TFileName)

RFile GetTempFileL(TFSMailMsgIdaContentId,
TFileNameaFileName
)

opens or creates file

Parameters

TFSMailMsgId aContentId
TFileName aFileNamefile name

InitAsyncRequestL(TUid, MFSMailRequestObserver &)

IMPORT_C TFSPendingRequestInitAsyncRequestL(TUidaPluginId,
MFSMailRequestObserver &aOperationObserver
)

starts asynchronous request

Parameters

TUid aPluginIdid of the target plugin request is accessed to
MFSMailRequestObserver & aOperationObserverobserver 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 > & aPluginInfoplugin information table
RPointerArray< CFSMailPlugin > & aPluginsplugin instances table

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

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

two based constructor

Parameters

RPointerArray< CImplementationInformation > & aPluginInfoplugin information table
RPointerArray< CFSMailPlugin > & aPluginsplugin instances table

RemoveAllRequests()

voidRemoveAllRequests()[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.