64
|
1 |
/*
|
|
2 |
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: plugin request handler
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef CFSMAILREQUESTHANDLER_H
|
|
20 |
#define CFSMAILREQUESTHANDLER_H
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include "cfsmailplugin.h"
|
|
24 |
#include "cfsmailplugindata.h"
|
|
25 |
|
|
26 |
// FORWARD DECLARATIONS
|
|
27 |
class CFSMailRequestObserver;
|
|
28 |
|
|
29 |
/**
|
|
30 |
* asynchronous request progress indicator
|
|
31 |
*
|
|
32 |
* @lib FSFWCommonLib
|
|
33 |
* @since S60 v3.1
|
|
34 |
*/
|
|
35 |
class TFSPendingRequest
|
|
36 |
{
|
|
37 |
|
|
38 |
public:
|
|
39 |
|
|
40 |
/** request status */
|
|
41 |
enum TFSRequestStatus
|
|
42 |
{
|
|
43 |
EFSRequestPending = 1,
|
|
44 |
EFSRequestComplete,
|
|
45 |
EFSRequestCancelled,
|
|
46 |
};
|
|
47 |
|
|
48 |
public: // data
|
|
49 |
|
|
50 |
/** request id */
|
|
51 |
TInt iRequestId;
|
|
52 |
|
|
53 |
/** plugin uid */
|
|
54 |
TUid iPluginId;
|
|
55 |
|
|
56 |
/** request status */
|
|
57 |
TFSRequestStatus iRequestStatus;
|
|
58 |
|
|
59 |
/** request observer */
|
|
60 |
CFSMailRequestObserver* iObserver;
|
|
61 |
};
|
|
62 |
|
|
63 |
/**
|
|
64 |
* email framework asynchronous request handler
|
|
65 |
*
|
|
66 |
* @lib FSFWCommonLib
|
|
67 |
* @since S60 v3.1
|
|
68 |
*/
|
|
69 |
class CFSMailRequestHandler : public CBase
|
|
70 |
{
|
|
71 |
|
|
72 |
public:
|
|
73 |
|
|
74 |
/**
|
|
75 |
* destructor.
|
|
76 |
*/
|
|
77 |
IMPORT_C virtual ~CFSMailRequestHandler();
|
|
78 |
|
|
79 |
/**
|
|
80 |
* two based constructor
|
|
81 |
*
|
|
82 |
* @param aPluginInfo plugin information table
|
|
83 |
* @param aPlugins plugin instances table
|
|
84 |
*/
|
|
85 |
IMPORT_C static CFSMailRequestHandler* NewL( RPointerArray<CImplementationInformation>& aPluginInfo,
|
|
86 |
RPointerArray<CFSMailPlugin>& aPlugins );
|
|
87 |
/**
|
|
88 |
* two based constructor
|
|
89 |
*
|
|
90 |
* @param aPluginInfo plugin information table
|
|
91 |
* @param aPlugins plugin instances table
|
|
92 |
*/
|
|
93 |
IMPORT_C static CFSMailRequestHandler* NewLC( RPointerArray<CImplementationInformation>& aPluginInfo,
|
|
94 |
RPointerArray<CFSMailPlugin>& aPlugins );
|
|
95 |
/**
|
|
96 |
* starts asynchronous request
|
|
97 |
*
|
|
98 |
* @param aPluginId id of the target plugin request is accessed to
|
|
99 |
* @param aOperationObserver observer to forward request progress events
|
|
100 |
* to user from plugin
|
|
101 |
*
|
|
102 |
* @return request data
|
|
103 |
*/
|
|
104 |
IMPORT_C TFSPendingRequest InitAsyncRequestL( TUid aPluginId,
|
|
105 |
MFSMailRequestObserver& aOperationObserver);
|
|
106 |
|
|
107 |
/**
|
|
108 |
* completes asynchronous request
|
|
109 |
*
|
|
110 |
* @param aRequestId id of the request to be completed
|
|
111 |
*/
|
|
112 |
IMPORT_C void CompleteRequest( TInt aRequestId );
|
|
113 |
|
|
114 |
/**
|
|
115 |
* cancels pending asynchronous request
|
|
116 |
*
|
|
117 |
* @param aRequestId id of the request to be cancelled
|
|
118 |
*/
|
|
119 |
IMPORT_C void CancelRequestL( TInt aRequestId );
|
|
120 |
|
|
121 |
/**
|
|
122 |
* cancels all pending asynchronous requests
|
|
123 |
*
|
|
124 |
*/
|
|
125 |
IMPORT_C void CancelAllRequestsL( );
|
|
126 |
|
|
127 |
/**
|
|
128 |
* returns plugin pointer related to plugin id
|
|
129 |
*
|
|
130 |
* @param aPluginId plugin id
|
|
131 |
* @return plugin pointer
|
|
132 |
*/
|
|
133 |
IMPORT_C virtual CFSMailPlugin* GetPluginByUid(TFSMailMsgId aPluginId);
|
|
134 |
|
|
135 |
/**
|
|
136 |
* adds new plugin to plugin list
|
|
137 |
*
|
|
138 |
* @param aPluginId uid of the new plugin
|
|
139 |
* @param aPlugin plugin instance
|
|
140 |
*/
|
|
141 |
IMPORT_C void AddPluginL( TUid aPluginId, CFSMailPlugin* aPlugin );
|
|
142 |
|
|
143 |
/**
|
|
144 |
* cleans temp dir
|
|
145 |
*
|
|
146 |
*/
|
|
147 |
IMPORT_C void CleanTempDirL( );
|
|
148 |
|
|
149 |
/**
|
|
150 |
* returns temp dir path
|
|
151 |
*
|
|
152 |
*/
|
|
153 |
IMPORT_C TDesC& GetTempDirL( );
|
|
154 |
|
|
155 |
/**
|
|
156 |
* opens or creates file
|
|
157 |
*
|
|
158 |
* @param aFileName file name
|
|
159 |
*/
|
|
160 |
RFile GetTempFileL(TFSMailMsgId aContentId,TFileName aFileName);
|
|
161 |
|
|
162 |
protected:
|
|
163 |
|
|
164 |
/**
|
|
165 |
* C++ default constructor.
|
|
166 |
*/
|
|
167 |
IMPORT_C CFSMailRequestHandler();
|
|
168 |
|
|
169 |
/**
|
|
170 |
* two based constructor
|
|
171 |
*/
|
|
172 |
void ConstructL( RPointerArray<CImplementationInformation> aPluginInfo,
|
|
173 |
RPointerArray<CFSMailPlugin> aPlugins );
|
|
174 |
|
|
175 |
protected: // data
|
|
176 |
|
|
177 |
/** list of loaded plugins */
|
|
178 |
RPointerArray<CFSMailPluginData> iPluginList;
|
|
179 |
|
|
180 |
private:
|
|
181 |
|
|
182 |
/** removes all asynchronous requests */
|
|
183 |
void RemoveAllRequests();
|
|
184 |
|
|
185 |
private: // data
|
|
186 |
|
|
187 |
/** list of pending requests */
|
|
188 |
RArray<TFSPendingRequest> iPendingRequests;
|
|
189 |
|
|
190 |
/** request id counter */
|
|
191 |
TUint iRequestId;
|
|
192 |
|
|
193 |
/** temp directory files handling */
|
|
194 |
RFs iFs;
|
|
195 |
HBufC *iTempDirName;
|
|
196 |
};
|
|
197 |
|
|
198 |
#endif
|
|
199 |
|
|
200 |
// End of File
|