1 /* |
|
2 * Copyright (c) 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: Class that capsulates im sub service data members |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __CVIMPSTENGINEIMSUBSERVICE_H |
|
19 #define __CVIMPSTENGINEIMSUBSERVICE_H |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32base.h> |
|
23 #include "tvimpstenums.h" |
|
24 |
|
25 //base |
|
26 #include <mimcacheeventhandler.h> |
|
27 #include "mvimpstenginecchhandlerobserver.h" |
|
28 #include "mvimpstenginesubservice.h" |
|
29 #include "mvimpstengineimsubservice.h" |
|
30 |
|
31 |
|
32 // FORWARD DECLARATIONS |
|
33 class CVIMPSTEngineServiceTableFetcher; |
|
34 class CIMCacheFactory; |
|
35 class MIMCacheAccessor; |
|
36 class MVIMPSTEngineIMSubServiceEventObserver; |
|
37 class CVIMPSTEngineCchHandler; |
|
38 class MVIMPSTEngineServiceConnectionEventObserver; |
|
39 |
|
40 |
|
41 |
|
42 //CLASS DECLARATION |
|
43 |
|
44 /** |
|
45 * class handling im sub service |
|
46 * @lib vimpstengine.lib |
|
47 * @since S60 5.0 |
|
48 */ |
|
49 |
|
50 NONSHARABLE_CLASS( CVIMPSTEngineIMSubService ) : public CBase, |
|
51 // public MVIMPSTEngineSubService, |
|
52 public MVIMPSTEngineIMSubService, |
|
53 public MIMCacheEventHandler, |
|
54 public MVIMPSTEngineCchHandlerObserver |
|
55 { |
|
56 //for testcases |
|
57 friend class T_VimpstEngineImSubService; |
|
58 |
|
59 public: // Two-phased constructors and destructor |
|
60 |
|
61 /** |
|
62 * NewLC two phase constructor. |
|
63 * @param aServiceId - Service Id |
|
64 * @param aCchHandler - reference to cchhandler |
|
65 * @param aTableFetcher - Handler to SPSettings |
|
66 * @param aServiceStateListener - Handler to the ServiceStateListener |
|
67 * return @ptr to CVIMPSTEngineIMSubService |
|
68 */ |
|
69 static CVIMPSTEngineIMSubService* NewLC( TUint aServiceId, |
|
70 CVIMPSTEngineCchHandler& aCchHandler, |
|
71 CVIMPSTEngineServiceTableFetcher& aTableFetcher, |
|
72 MVIMPSTEngineServiceConnectionEventObserver& aObserver ); |
|
73 |
|
74 |
|
75 /** |
|
76 * NewL two phase constructor. |
|
77 * @param aServiceId - Service Id |
|
78 * @param aCchHandler - reference to cchhandler |
|
79 * @param aTableFetcher - Handler to SPSettings |
|
80 * @param aServiceStateListener - Handler to the ServiceStateListener |
|
81 * return @ptr to CVIMPSTEngineIMSubService |
|
82 */ |
|
83 static CVIMPSTEngineIMSubService* NewL( TUint aServiceId, |
|
84 CVIMPSTEngineCchHandler& aCchHandler, |
|
85 CVIMPSTEngineServiceTableFetcher& aTableFetcher, |
|
86 MVIMPSTEngineServiceConnectionEventObserver& aObserver); |
|
87 |
|
88 /** |
|
89 * C++ default destructor |
|
90 */ |
|
91 virtual ~CVIMPSTEngineIMSubService(); |
|
92 |
|
93 |
|
94 public: //From MVIMPSTEngineSubService |
|
95 |
|
96 /** |
|
97 * @see MVIMPSTEngineSubService |
|
98 */ |
|
99 TVIMPSTEnums::TVIMPSTRegistrationState SubServiceState() const; |
|
100 |
|
101 /** |
|
102 * @see MVIMPSTEngineSubService |
|
103 */ |
|
104 TVIMPSTEnums::SubServiceType Type() const; |
|
105 |
|
106 |
|
107 |
|
108 public: //From MVIMPSTIMSubService |
|
109 |
|
110 /** |
|
111 * @see MVIMPSTIMSubService |
|
112 */ |
|
113 void RegisterChatObserver(MVIMPSTEngineIMSubServiceEventObserver* aObserver); |
|
114 |
|
115 /** |
|
116 * @see MVIMPSTIMSubService |
|
117 */ |
|
118 void UnRegisterChatObserver(MVIMPSTEngineIMSubServiceEventObserver* aObserver); |
|
119 |
|
120 /** |
|
121 * @see MVIMPSTIMSubService |
|
122 */ |
|
123 TInt GetUnreadCountL(const TDesC& aSender); |
|
124 |
|
125 |
|
126 /** |
|
127 * @see MVIMPSTIMSubService |
|
128 */ |
|
129 TBool IsConversationExistL(const TDesC& aRecipientId) const ; |
|
130 |
|
131 /** |
|
132 * @see MVIMPSTIMSubService |
|
133 */ |
|
134 void CloseConversationL( const TDesC& aContactId ); |
|
135 |
|
136 /** |
|
137 * @see MVIMPSTIMSubService |
|
138 */ |
|
139 |
|
140 RArray<SIMCacheChatItem> GetOpenChatListL(); |
|
141 |
|
142 |
|
143 |
|
144 public: // From MIMCacheEventHandler |
|
145 |
|
146 /** |
|
147 * @see MIMCacheEventHandler |
|
148 */ |
|
149 void HandleIMCacheEventL(TIMCacheEventType aEventType, TAny* aChatMessage = NULL ); |
|
150 |
|
151 |
|
152 private: //From MVIMPSTEngineCchHandlerObserver |
|
153 |
|
154 /** |
|
155 * See MVIMPSTEngineCchHandlerObserver |
|
156 */ |
|
157 void CchEventOccuredL( |
|
158 TUint aServiceId, |
|
159 TCCHSubserviceState aState, |
|
160 TInt aServiceError ); |
|
161 |
|
162 |
|
163 private: |
|
164 |
|
165 /** |
|
166 * Symbian second phase constructor |
|
167 */ |
|
168 void ConstructL(); |
|
169 |
|
170 /** |
|
171 * C++ default constructor. |
|
172 * @param aServiceId - Service Id |
|
173 * @param aCchHandler - reference to cchhandler |
|
174 * @param aTableFetcher - Handler to SPSettings |
|
175 * @param aServiceStateListener - Handler to the ServiceStateListener |
|
176 */ |
|
177 CVIMPSTEngineIMSubService( TUint aServiceId, |
|
178 CVIMPSTEngineCchHandler& aCchHandler, |
|
179 CVIMPSTEngineServiceTableFetcher& aTableFetcher, |
|
180 MVIMPSTEngineServiceConnectionEventObserver& aObserver ); |
|
181 |
|
182 |
|
183 /** |
|
184 * Resolves the CCH service state to Service Tab understandable state |
|
185 * @param aServiceId - Service Id |
|
186 * @param aCchErr - returns the last CCH Error |
|
187 * @return TVIMPSTRegistrationState the Registration State |
|
188 */ |
|
189 TVIMPSTEnums::TVIMPSTRegistrationState ResolveServiceStateL( TCCHSubserviceState aState, |
|
190 TInt aServiceError ); |
|
191 |
|
192 /** |
|
193 * Handler for the CCH Errors |
|
194 * @param aServiceError |
|
195 */ |
|
196 void DoHandleCchErrorL( TInt aServiceError ); |
|
197 |
|
198 /** |
|
199 * Create IM Cache Accessor |
|
200 * |
|
201 */ |
|
202 void CreateIMCacheAccessorL(); |
|
203 |
|
204 /** |
|
205 * Release IM Cache Accessor |
|
206 * |
|
207 */ |
|
208 void ReleaseIMCacheAccessor(); |
|
209 |
|
210 /** |
|
211 * Notify the list of Observers registered for the IM Event |
|
212 * @param aBuddyId, Buddy Id for which the Event is received |
|
213 */ |
|
214 void NotifyObserversL(TVIMPSTEnums::TIMEventType aEventType ,const TDesC& aBuddyId ); |
|
215 |
|
216 |
|
217 private : |
|
218 |
|
219 // Service Id |
|
220 TUint iServiceId; |
|
221 |
|
222 //doesnot own. |
|
223 CVIMPSTEngineCchHandler& iCchHandler; |
|
224 |
|
225 //doesnt own - handler to the SP Settings |
|
226 CVIMPSTEngineServiceTableFetcher& iTableFetcher; |
|
227 |
|
228 //Doesnt Own - Handler to the ServiceStateListener |
|
229 MVIMPSTEngineServiceConnectionEventObserver& iObserver; |
|
230 |
|
231 // Stores the Type of SubService |
|
232 TVIMPSTEnums::SubServiceType iType; |
|
233 |
|
234 // owned, access to accesss/update interface |
|
235 // call realease of factory |
|
236 CIMCacheFactory* iIMCacheFactory; |
|
237 |
|
238 // owned, access/update to imcache |
|
239 // call realease of factory |
|
240 MIMCacheAccessor* iIMCacheAccessor; |
|
241 |
|
242 //Doesnt Own |
|
243 RPointerArray <MVIMPSTEngineIMSubServiceEventObserver> iChatObserver; |
|
244 |
|
245 // Stores sub services current state |
|
246 TVIMPSTEnums::TVIMPSTRegistrationState iServiceState; |
|
247 |
|
248 }; |
|
249 |
|
250 #endif //__CVIMPSTENGINEIMSUBSERVICE_H |
|
251 |
|
252 // End of File |
|
253 |
|
254 |
|