|
1 /* |
|
2 * Copyright (c) 2006-2009 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: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef CMMPHONEEXTINTERFACE_H |
|
21 #define CMMPHONEEXTINTERFACE_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 #include <etelmm.h> |
|
26 #include <mmretrieve.h> |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class CMmPhoneTsy; |
|
30 class TDataPackage; |
|
31 class CMmDataPackage; |
|
32 |
|
33 // CLASS DECLARATION |
|
34 |
|
35 /** |
|
36 * CMmPhoneExtInterface is used to provide an extension interface for system |
|
37 * specific phone object extensions. |
|
38 */ |
|
39 class CMmPhoneExtInterface |
|
40 : public CBase |
|
41 { |
|
42 public: |
|
43 |
|
44 /** |
|
45 * Get static extension mode |
|
46 * |
|
47 * |
|
48 * @param aMode: pointer to mode |
|
49 * @return return value decided by the extension |
|
50 */ |
|
51 virtual TInt GetStaticExtensionMode( |
|
52 RMobilePhone::TMobilePhoneNetworkMode* aMode ) = 0; |
|
53 |
|
54 /** |
|
55 * Default implementation of trapped Initialisation method |
|
56 * |
|
57 * |
|
58 * @return error value |
|
59 */ |
|
60 virtual TInt InitSimL( )= 0; |
|
61 |
|
62 /** |
|
63 * Default implementation of GetFdnStatusL-method |
|
64 * |
|
65 * |
|
66 * @return error value |
|
67 */ |
|
68 virtual TInt GetFdnStatusL()= 0; |
|
69 |
|
70 /** |
|
71 * Default implementation of SetFdnSetting-method |
|
72 * |
|
73 * |
|
74 * @param TMobilePhoneFdnSetting* aFdnSetting |
|
75 * @return error value |
|
76 */ |
|
77 virtual TInt SetFdnSetting( |
|
78 RMobilePhone::TMobilePhoneFdnSetting* aFdnSetting)= 0; |
|
79 |
|
80 //NET related methods |
|
81 |
|
82 /** |
|
83 * Default implementation of GetNITZInfo-method. |
|
84 * |
|
85 * @param aNwtTimeInfo |
|
86 * @return error value |
|
87 */ |
|
88 virtual TInt GetNITZInfo( |
|
89 RMobilePhone::TMobilePhoneNITZ* aNwtTimeInfo )= 0; |
|
90 |
|
91 /** |
|
92 * Update Nitz information. |
|
93 * |
|
94 * |
|
95 * @param aNITZInfo NITZ info |
|
96 */ |
|
97 virtual void ReceivedNITZInfo( |
|
98 RMobilePhone::TMobilePhoneNITZ& aNITZInfo )= 0; |
|
99 |
|
100 /** |
|
101 * Implementation of GetCurrentNetwork version 1 information |
|
102 * |
|
103 * |
|
104 * @param aNetInfo network information version 1 |
|
105 * @param aArea Location area |
|
106 * @return error value |
|
107 */ |
|
108 virtual TInt GetCurrentNetworkV1( |
|
109 RMobilePhone::TMobilePhoneNetworkInfoV1* aNetInfo, |
|
110 RMobilePhone::TMobilePhoneLocationAreaV1* aArea )= 0; |
|
111 |
|
112 /** |
|
113 * Implementation of GetCurrentNetwork version 2 information |
|
114 * |
|
115 * @param aNetInfo network information version 2 |
|
116 * @param aArea Location area |
|
117 * @return error value |
|
118 */ |
|
119 virtual TInt GetCurrentNetworkV2( |
|
120 RMobilePhone::TMobilePhoneNetworkInfoV2* aNetInfo, |
|
121 RMobilePhone::TMobilePhoneLocationAreaV1* aArea )= 0; |
|
122 |
|
123 /** |
|
124 * Implementation of GetCurrentNetwork version 5 information |
|
125 * |
|
126 * |
|
127 * @param aNetInfo network information version 5 |
|
128 * @param aArea Location area |
|
129 * @return error value |
|
130 */ |
|
131 virtual TInt GetCurrentNetworkV5( |
|
132 RMobilePhone::TMobilePhoneNetworkInfoV5* aNetInfo, |
|
133 RMobilePhone::TMobilePhoneLocationAreaV1* aArea )= 0; |
|
134 |
|
135 /** |
|
136 * Default implementation of GetCurrentNetwork (version 8) |
|
137 * |
|
138 * |
|
139 * @param aNetInfo network information version 8 |
|
140 * @param aArea Location area |
|
141 * @return error value |
|
142 */ |
|
143 virtual TInt GetCurrentNetwork( |
|
144 RMobilePhone::TMobilePhoneNetworkInfoV8* aNetInfo, |
|
145 RMobilePhone::TMobilePhoneLocationAreaV1* aArea )= 0; |
|
146 |
|
147 /** |
|
148 * Version 1 implementation of GetCurrentNetworkNoLocation |
|
149 * |
|
150 * @param aNetInfo network information version 1 |
|
151 * @return error value |
|
152 */ |
|
153 virtual TInt GetCurrentNetworkNoLocationV1( |
|
154 RMobilePhone::TMobilePhoneNetworkInfoV1* aNetInfo )= 0; |
|
155 |
|
156 /** |
|
157 * Version 2 information implementation of GetCurrentNetworkNoLocation |
|
158 * |
|
159 * @param aNetInfo network information version 2 |
|
160 * @return error value |
|
161 */ |
|
162 virtual TInt GetCurrentNetworkNoLocationV2( |
|
163 RMobilePhone::TMobilePhoneNetworkInfoV2* aNetInfo )= 0; |
|
164 |
|
165 /** |
|
166 * Version 5 information implementation of GetCurrentNetworkNoLocation |
|
167 * |
|
168 * |
|
169 * @param aNetInfo network information version 5 |
|
170 * @return error value |
|
171 */ |
|
172 virtual TInt GetCurrentNetworkNoLocationV5( |
|
173 RMobilePhone::TMobilePhoneNetworkInfoV5* aNetInfo )= 0; |
|
174 |
|
175 /** |
|
176 * Default implementation of GetCurrentNetworkNoLocation (version 8) |
|
177 * |
|
178 * |
|
179 * @param aNetInfo network information version 8 |
|
180 * @return error value |
|
181 */ |
|
182 virtual TInt GetCurrentNetworkNoLocation( |
|
183 RMobilePhone::TMobilePhoneNetworkInfoV8* aNetInfo )= 0; |
|
184 |
|
185 /** |
|
186 * Default implementation of SetCurrentNetwork |
|
187 * |
|
188 * @param aNetInfo network information version 8 |
|
189 * @param aArea Location area |
|
190 * @return error value |
|
191 */ |
|
192 virtual TInt SetCurrentNetwork( |
|
193 const RMobilePhone::TMobilePhoneNetworkInfoV8& aNetInfo, |
|
194 const RMobilePhone::TMobilePhoneLocationAreaV1& area )= 0; |
|
195 |
|
196 /** |
|
197 * Get the Cell Information. |
|
198 * |
|
199 * @return error value |
|
200 */ |
|
201 virtual TInt GetCellInfoL()= 0; |
|
202 |
|
203 /** |
|
204 * Request notifications of cell information changes. |
|
205 * |
|
206 * @return error value |
|
207 */ |
|
208 virtual TInt NotifyCellInfoChangeL()= 0; |
|
209 |
|
210 /** |
|
211 * Version 1 implementation of get home network information. |
|
212 * |
|
213 * @param aNetInfo network information version 1 |
|
214 * @return error value |
|
215 */ |
|
216 virtual TInt GetHomeNetworkV1( |
|
217 RMobilePhone::TMobilePhoneNetworkInfoV1* aNetInfo )= 0; |
|
218 |
|
219 /** |
|
220 * Version 2 implementation of get home network information. |
|
221 * |
|
222 * @param aNetInfo network information version 2 |
|
223 * @return error value |
|
224 */ |
|
225 virtual TInt GetHomeNetworkV2( |
|
226 RMobilePhone::TMobilePhoneNetworkInfoV2* aNetInfo )= 0; |
|
227 |
|
228 /** |
|
229 * Version 5 implementation of get home network information. |
|
230 * |
|
231 * |
|
232 * @param aNetInfo network information version 5 |
|
233 * @return error value |
|
234 */ |
|
235 virtual TInt GetHomeNetworkV5( |
|
236 RMobilePhone::TMobilePhoneNetworkInfoV5* aNetInfo )= 0; |
|
237 |
|
238 /** |
|
239 * Default implementation of get home network information (version 8) |
|
240 * |
|
241 * |
|
242 * @param aNetInfo network information version 8 |
|
243 * @return error value |
|
244 */ |
|
245 virtual TInt GetHomeNetwork( |
|
246 RMobilePhone::TMobilePhoneNetworkInfoV8* aNetInfo )= 0; |
|
247 |
|
248 /** |
|
249 * Default implementation of GetNetworkCaps-method. |
|
250 * |
|
251 * |
|
252 * @param aCaps |
|
253 * @return error value |
|
254 */ |
|
255 virtual TInt GetNetworkCaps( TUint32* aCaps )= 0; |
|
256 |
|
257 /** |
|
258 * Default implementation of GetSecurityCaps. |
|
259 * |
|
260 * |
|
261 * @param aCaps |
|
262 * @return error value |
|
263 */ |
|
264 virtual TInt GetSecurityCaps( TUint32* aCaps )= 0; |
|
265 |
|
266 /** |
|
267 * Default implementation of ChangeSecurityCodeL. |
|
268 * |
|
269 * |
|
270 * @param aPackage |
|
271 * @return error value |
|
272 */ |
|
273 virtual TInt ChangeSecurityCodeL( const TDataPackage& aPackage )= 0; |
|
274 |
|
275 /** |
|
276 * Sets new setting for a lock |
|
277 * |
|
278 * |
|
279 * @param aDataPackage |
|
280 * @return error value |
|
281 */ |
|
282 virtual TInt SetLockSettingL( CMmDataPackage* aPackage )= 0; |
|
283 |
|
284 /** |
|
285 * Default implementation of VerifySecurityCodeL. |
|
286 * |
|
287 * |
|
288 * @param aPackage |
|
289 * @return error value |
|
290 */ |
|
291 virtual TInt VerifySecurityCodeL( |
|
292 const TDataPackage& aPackage )= 0; |
|
293 |
|
294 /** |
|
295 * Default implementation of AbortSecurityCodeL. |
|
296 * |
|
297 * |
|
298 * @param aPackage |
|
299 * @return error value |
|
300 */ |
|
301 virtual TInt AbortSecurityCodeL( |
|
302 const TDataPackage& aPackage )= 0; |
|
303 |
|
304 /** |
|
305 * Default implementation of UpdateSecurityCaps. |
|
306 * |
|
307 * |
|
308 * @param aEvent |
|
309 * @return error value |
|
310 */ |
|
311 virtual TInt UpdateSecurityCaps( |
|
312 RMobilePhone::TMobilePhoneSecurityEvent aEvent )= 0; |
|
313 |
|
314 /** |
|
315 * Default implementation of DeliverCode. |
|
316 * |
|
317 * |
|
318 * @param aCodes |
|
319 * @return error value |
|
320 */ |
|
321 virtual TInt DeliverCode( |
|
322 RMobilePhone::TCodeAndUnblockCode aCodes )= 0; |
|
323 |
|
324 /** |
|
325 * Checks the state of the currently active PIN code. |
|
326 * |
|
327 * |
|
328 * @param None |
|
329 */ |
|
330 virtual TInt SimActivePinState()= 0; |
|
331 |
|
332 /** |
|
333 * Default implementation of get service provider name |
|
334 * |
|
335 * |
|
336 * @param None |
|
337 * @return error value |
|
338 */ |
|
339 virtual TInt GetServiceProviderNameL()= 0; |
|
340 |
|
341 /** |
|
342 * Default implementation of GetDetectedNetworksPhase1L |
|
343 * |
|
344 * |
|
345 * @param None |
|
346 * @return status KErrNotSupported |
|
347 */ |
|
348 virtual TInt GetDetectedNetworksPhase1L()= 0; |
|
349 |
|
350 /** |
|
351 * Default implementation of SelectNetworkL |
|
352 * |
|
353 * |
|
354 * @param aDataPackage |
|
355 * @return status KErrNotSupported |
|
356 */ |
|
357 virtual TInt SelectNetworkL( |
|
358 const TDataPackage& aDataPackage )= 0; |
|
359 |
|
360 /** |
|
361 * Default implementation of SelectNetworkCancelL |
|
362 * |
|
363 * |
|
364 * @return status KErrNotSupported |
|
365 */ |
|
366 virtual TInt SelectNetworkCancelL()= 0; |
|
367 |
|
368 /** |
|
369 * Default implementation of GetDetectedNetworksCancelL |
|
370 * |
|
371 * |
|
372 * @return status KErrNotSupported |
|
373 */ |
|
374 virtual TInt GetDetectedNetworksCancelL()= 0; |
|
375 |
|
376 /** |
|
377 * Completes a network registration status changed in this extension |
|
378 * |
|
379 * |
|
380 * @param aRegistrationStatus new registration status |
|
381 */ |
|
382 virtual void CompleteNotifyNetworkRegistrationStatusChange( |
|
383 RMobilePhone::TMobilePhoneRegistrationStatus aRegistrationStatus |
|
384 )= 0; |
|
385 |
|
386 /** |
|
387 * Gets the ICC access capabilites |
|
388 * |
|
389 * |
|
390 * @param aCaps Pointer to return the capabilites value |
|
391 * @return status KErrNotSupported |
|
392 */ |
|
393 virtual TInt GetIccAccessCaps ( TUint32* aCaps )= 0; |
|
394 |
|
395 /** |
|
396 * Sets the network selection setting |
|
397 * |
|
398 * |
|
399 * @param aDataPackage |
|
400 * @return status KErrNotSupported |
|
401 */ |
|
402 virtual TInt SetNetworkSelectionSettingL( |
|
403 const TDataPackage& aDataPackage )= 0; |
|
404 |
|
405 /** |
|
406 * Gets the network registration status |
|
407 * |
|
408 * |
|
409 * @param aTransactionId transaction Id |
|
410 * @return status KErrNotSupported |
|
411 */ |
|
412 virtual TInt GetNetworkRegistrationStatusL()= 0; |
|
413 |
|
414 /** |
|
415 * Copletes GetHomeNetwork request |
|
416 * |
|
417 * |
|
418 * @param aDataPackage package |
|
419 */ |
|
420 virtual void CompleteGetHomeNetwork( |
|
421 CMmDataPackage* aDataPackage )= 0; |
|
422 |
|
423 /** |
|
424 * Gets network security level |
|
425 * |
|
426 * |
|
427 * @param aNetworkSecurity |
|
428 * @return Error value |
|
429 */ |
|
430 virtual TInt GetNetworkSecurityLevel ( |
|
431 RMobilePhone::TMobilePhoneNetworkSecurity& aNetworkSecurity |
|
432 ) const = 0; |
|
433 |
|
434 /** |
|
435 * Sets network security level |
|
436 * |
|
437 * |
|
438 * @param aNetworkSecurity |
|
439 * @return Error value |
|
440 */ |
|
441 virtual TInt SetNetworkSecurityLevel ( |
|
442 RMobilePhone::TMobilePhoneNetworkSecurity& aNetworkSecurity )= 0; |
|
443 |
|
444 /** |
|
445 * Gets ciphering indicator status |
|
446 * |
|
447 * |
|
448 * @param aDataPackage |
|
449 * @return Error value |
|
450 */ |
|
451 virtual TInt GetCipheringIndicatorStatusL( |
|
452 const TDataPackage* aDataPackage )= 0; |
|
453 |
|
454 /** |
|
455 * Sets a network mode into iCurrentNwInfo.iMode variable |
|
456 * |
|
457 * |
|
458 * @param aMode Network Mode |
|
459 */ |
|
460 virtual void SetNetworkModeInExtensionPhone( |
|
461 RMobilePhone::TMobilePhoneNetworkMode aMode ) = 0; |
|
462 |
|
463 /** |
|
464 * Makes the SIM status request to SIM server |
|
465 * |
|
466 * |
|
467 * @return request error status |
|
468 */ |
|
469 virtual TInt NotifySimStatusReadyL() = 0; |
|
470 |
|
471 /** |
|
472 * Makes the MTC status request to SIM server |
|
473 * |
|
474 * |
|
475 * @return request error status |
|
476 */ |
|
477 virtual TInt MtcStateQueryL()= 0; |
|
478 |
|
479 /** |
|
480 * Gets the status and setting of a given lock |
|
481 * |
|
482 * |
|
483 * @param aPackage |
|
484 * @return request error status |
|
485 */ |
|
486 virtual TInt GetLockInfoL( const TDataPackage& aPackage ) = 0; |
|
487 |
|
488 /** |
|
489 * Gets the status and setting of a given lock |
|
490 * |
|
491 * |
|
492 * @param aStatus |
|
493 * @param aSetting |
|
494 * @param aLock |
|
495 * @return request error status |
|
496 */ |
|
497 virtual TInt UpdateLockInfo( |
|
498 RMobilePhone::TMobilePhoneLockStatus aStatus, |
|
499 RMobilePhone::TMobilePhoneLockSetting aSetting, |
|
500 RMobilePhone::TMobilePhoneLock aLock ) = 0; |
|
501 |
|
502 /** |
|
503 * Gets the type of the ICC |
|
504 * |
|
505 * |
|
506 * @param None |
|
507 * @return request error status |
|
508 */ |
|
509 virtual TInt GetICCTypeL() = 0; |
|
510 |
|
511 /** |
|
512 * Completes a GetICCType request |
|
513 * |
|
514 * |
|
515 * @param aDataPackage |
|
516 * @return request error status |
|
517 */ |
|
518 virtual void CompleteGetICCType ( CMmDataPackage* aDataPackage ) = 0; |
|
519 |
|
520 /** |
|
521 * Returns the current ICCType |
|
522 * |
|
523 * @param None |
|
524 * @return error value |
|
525 */ |
|
526 virtual TInt CurrentICCType() = 0; |
|
527 |
|
528 }; |
|
529 |
|
530 #endif // CMMPHONEEXTINTERFACE_H |
|
531 |
|
532 // End of file |