1 /* |
|
2 * Copyright (c) 2002-2007 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: Interface for USat API. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MSATAPI_H |
|
21 #define MSATAPI_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include <etelsat.h> |
|
26 |
|
27 // CLASS DECLARATION |
|
28 |
|
29 /** |
|
30 * Interface for USat api. |
|
31 * |
|
32 * @lib SatEngine.lib |
|
33 * @since Series 60 3.0 |
|
34 */ |
|
35 class MSatApi |
|
36 { |
|
37 protected: // Constructors and destructor |
|
38 |
|
39 /** |
|
40 * C++ default constructor. |
|
41 */ |
|
42 MSatApi() {}; |
|
43 |
|
44 /** |
|
45 * Destructor. |
|
46 */ |
|
47 virtual ~MSatApi() {}; |
|
48 |
|
49 public: // New functions |
|
50 |
|
51 /** |
|
52 * Issues SetUpMenu request. |
|
53 * @param aStatus Request status. |
|
54 * @param aPCmd Command identifier and other relevant information |
|
55 */ |
|
56 virtual void NotifySetUpMenu( |
|
57 TRequestStatus& aStatus, |
|
58 TDes8& aPCmd ) = 0; |
|
59 |
|
60 /** |
|
61 * Cancels the setupmenu request. |
|
62 */ |
|
63 virtual void NotifySetUpMenuCancel() = 0; |
|
64 |
|
65 /** |
|
66 * Issues SetUpCall request |
|
67 * @param aStatus Request status. |
|
68 * @param aPCmd Command identifier and other relevant information |
|
69 */ |
|
70 virtual void NotifySetUpCall( |
|
71 TRequestStatus& aStatus, |
|
72 TDes8& aPCmd ) = 0; |
|
73 |
|
74 /** |
|
75 * Cancels the SetUpCall request |
|
76 */ |
|
77 virtual void NotifySetUpCallCancel() = 0; |
|
78 |
|
79 /** |
|
80 * Issues LangNotify request |
|
81 * @param aStatus Request status. |
|
82 * @param aPCmd Command identifier and other relevant information |
|
83 */ |
|
84 virtual void NotifyLanguageNotification( |
|
85 TRequestStatus& aStatus, |
|
86 TDes8& aPCmd ) = 0; |
|
87 |
|
88 /** |
|
89 * Cancels the LangNotify request |
|
90 */ |
|
91 virtual void NotifyLanguageNotificationCancel() = 0; |
|
92 |
|
93 /** |
|
94 * Issues the SelectItem request. |
|
95 * @param aStatus Request status. |
|
96 * @param aPCmd Command identifier and other relevant information |
|
97 */ |
|
98 virtual void NotifySelectItem( |
|
99 TRequestStatus& aStatus, |
|
100 TDes8& aPCmd ) = 0; |
|
101 |
|
102 /** |
|
103 * Cancels the SelectItem request |
|
104 */ |
|
105 virtual void NotifySelectItemCancel() = 0; |
|
106 |
|
107 /** |
|
108 * Issues the SendSm request. |
|
109 * @param aStatus Request status. |
|
110 * @param aPCmd Command identifier and other relevant information |
|
111 */ |
|
112 virtual void NotifySendSm( |
|
113 TRequestStatus& aStatus, |
|
114 TDes8& aPCmd ) = 0; |
|
115 |
|
116 /** |
|
117 * Cancels the SendSm request. |
|
118 */ |
|
119 virtual void NotifySendSmCancel() = 0; |
|
120 |
|
121 /** |
|
122 * Sends sm message. |
|
123 * @param aStatus Request status |
|
124 * @aData Data to be sent |
|
125 * @aMsgReference Message reference. |
|
126 */ |
|
127 virtual void SendMessageNoLogging( |
|
128 TRequestStatus& aStatus, |
|
129 TDes8& aData, |
|
130 TUint16& aMsgReference ) = 0; |
|
131 |
|
132 /** |
|
133 * Cancels the send sm request. |
|
134 */ |
|
135 virtual void SendMessageNoLoggingCancel() = 0; |
|
136 |
|
137 /** |
|
138 * Issues the request |
|
139 * @param aStatus Request status. |
|
140 * @param aPCmd Command identifier and other relevant information |
|
141 */ |
|
142 virtual void NotifyLaunchBrowser( |
|
143 TRequestStatus& aStatus, |
|
144 TDes8& aPCmd ) = 0; |
|
145 |
|
146 /** |
|
147 * Cancels the request |
|
148 */ |
|
149 virtual void NotifyLaunchBrowserCancel() = 0; |
|
150 |
|
151 /** |
|
152 * Issues the request |
|
153 * @param aStatus Request status. |
|
154 * @param aPCmd Command identifier and other relevant information |
|
155 */ |
|
156 virtual void NotifyDisplayText( |
|
157 TRequestStatus& aStatus, |
|
158 TDes8& aPCmd ) = 0; |
|
159 |
|
160 /** |
|
161 * Cancels the request |
|
162 */ |
|
163 virtual void NotifyDisplayTextCancel() = 0; |
|
164 |
|
165 /** |
|
166 * Issues the request |
|
167 * @param aStatus Request status. |
|
168 * @param aPCmd Command identifier and other relevant information |
|
169 */ |
|
170 virtual void NotifyGetInput( |
|
171 TRequestStatus& aStatus, |
|
172 TDes8& aPCmd ) = 0; |
|
173 |
|
174 /** |
|
175 * Cancels the request |
|
176 */ |
|
177 virtual void NotifyGetInputCancel() = 0; |
|
178 |
|
179 /** |
|
180 * Issues the request |
|
181 * @param aStatus Request status. |
|
182 * @param aPCmd Command identifier and other relevant information |
|
183 */ |
|
184 virtual void NotifyGetInkey( |
|
185 TRequestStatus& aStatus, |
|
186 TDes8& aPCmd ) = 0; |
|
187 |
|
188 /** |
|
189 * Cancels the request |
|
190 */ |
|
191 virtual void NotifyGetInkeyCancel() = 0; |
|
192 |
|
193 /** |
|
194 * Issues the request |
|
195 * @param aStatus Request status. |
|
196 * @param aPCmd Command identifier and other relevant information |
|
197 */ |
|
198 virtual void NotifyCallControl( |
|
199 TRequestStatus& aStatus, |
|
200 TDes8& aPCmd ) = 0; |
|
201 |
|
202 /** |
|
203 * Cancels the request |
|
204 */ |
|
205 virtual void NotifyCallControlCancel() = 0; |
|
206 |
|
207 /** |
|
208 * Issues the request |
|
209 * @param aStatus Request status. |
|
210 * @param aPCmd Command identifier and other relevant information |
|
211 */ |
|
212 virtual void NotifyMoSmControl( |
|
213 TRequestStatus& aStatus, |
|
214 TDes8& aPCmd ) = 0; |
|
215 |
|
216 /** |
|
217 * Cancels the request |
|
218 */ |
|
219 virtual void NotifyMoSmControlCancel() = 0; |
|
220 |
|
221 /** |
|
222 * Issues the request |
|
223 * @param aStatus Request status. |
|
224 * @param aPCmd Command identifier and other relevant information |
|
225 */ |
|
226 virtual void NotifySetUpEventList( |
|
227 TRequestStatus& aStatus, |
|
228 TDes8& aPCmd ) = 0; |
|
229 |
|
230 /** |
|
231 * Cancels the request |
|
232 */ |
|
233 virtual void NotifySetUpEventListCancel() = 0; |
|
234 |
|
235 /** |
|
236 * Issues the request |
|
237 * @param aStatus Request status. |
|
238 * @param aPCmd Command identifier and other relevant information |
|
239 */ |
|
240 virtual void NotifySetUpIdleModeText( |
|
241 TRequestStatus& aStatus, |
|
242 TDes8& aPCmd ) = 0; |
|
243 |
|
244 /** |
|
245 * Cancels the request |
|
246 */ |
|
247 virtual void NotifySetUpIdleModeTextCancel() = 0; |
|
248 |
|
249 /** |
|
250 * Issues the request |
|
251 * @param aStatus Request status. |
|
252 * @param aPCmd Command identifier and other relevant information |
|
253 */ |
|
254 virtual void NotifySendDtmf( |
|
255 TRequestStatus& aStatus, |
|
256 TDes8& aPCmd ) = 0; |
|
257 |
|
258 /** |
|
259 * Cancels the request |
|
260 */ |
|
261 virtual void NotifySendDtmfCancel() = 0; |
|
262 |
|
263 /** |
|
264 * Issues the request |
|
265 * @param aStatus Request status. |
|
266 * @param aPCmd Command identifier and other relevant information |
|
267 */ |
|
268 virtual void NotifySendSs( |
|
269 TRequestStatus& aStatus, |
|
270 TDes8& aPCmd ) = 0; |
|
271 |
|
272 /** |
|
273 * Cancels the request |
|
274 */ |
|
275 virtual void NotifySendSsCancel() = 0; |
|
276 |
|
277 /** |
|
278 * Issues the request |
|
279 * @param aStatus Request status. |
|
280 * @param aPCmd Command identifier and other relevant information |
|
281 */ |
|
282 virtual void NotifySendUssd( |
|
283 TRequestStatus& aStatus, |
|
284 TDes8& aPCmd ) = 0; |
|
285 |
|
286 /** |
|
287 * Cancels the request |
|
288 */ |
|
289 virtual void NotifySendUssdCancel() = 0; |
|
290 |
|
291 /** |
|
292 * Issues the request |
|
293 * @param aStatus Request status. |
|
294 * @param aPCmd Command identifier and other relevant information |
|
295 */ |
|
296 virtual void NotifyPlayTone( |
|
297 TRequestStatus& aStatus, |
|
298 TDes8& aPCmd ) = 0; |
|
299 |
|
300 /** |
|
301 * Cancels the request |
|
302 */ |
|
303 virtual void NotifyPlayToneCancel() = 0; |
|
304 |
|
305 /** |
|
306 * Issues the request |
|
307 * @param aStatus Request status. |
|
308 * @param aPCmd Command identifier and other relevant information |
|
309 */ |
|
310 virtual void NotifyRefreshRequired( |
|
311 TRequestStatus& aStatus , |
|
312 TDes8& aPCmd ) = 0; |
|
313 |
|
314 /** |
|
315 * Cancels the request |
|
316 */ |
|
317 virtual void NotifyRefreshRequiredCancel() = 0; |
|
318 |
|
319 /** |
|
320 * Respond to NotifyRefreshRequired. Replaces Terminal Rsp here. |
|
321 * @param aPCkg Refresh required response package |
|
322 */ |
|
323 virtual void RefreshAllowed( const TDesC8& aPCkg ) = 0; |
|
324 |
|
325 /** |
|
326 * Issues the request |
|
327 * @param aStatus Request status. |
|
328 * @param aPCmd Command identifier and other relevant information |
|
329 */ |
|
330 virtual void NotifyRefresh( |
|
331 TRequestStatus& aStatus, |
|
332 TDes8& aPCmd ) = 0; |
|
333 |
|
334 /** |
|
335 * Cancels the request |
|
336 */ |
|
337 virtual void NotifyRefreshCancel() = 0; |
|
338 |
|
339 /** |
|
340 * Issues the request |
|
341 * @param aStatus Request status. |
|
342 */ |
|
343 virtual void NotifySimSessionEnd( TRequestStatus& aStatus ) = 0; |
|
344 |
|
345 /** |
|
346 * Cancels the SimSessionEnd request |
|
347 */ |
|
348 virtual void NotifySimSessionEndCancel() = 0; |
|
349 |
|
350 /** |
|
351 * Issues the request |
|
352 * @param aStatus Request status. |
|
353 * @param aPCmd Command identifier and other relevant information |
|
354 */ |
|
355 virtual void NotifyLocalInfo( |
|
356 TRequestStatus& aStatus, |
|
357 TDes8& aPCmd ) = 0; |
|
358 |
|
359 /** |
|
360 * Cancels the request |
|
361 */ |
|
362 virtual void NotifyLocalInfoCancel() = 0; |
|
363 |
|
364 /** |
|
365 * Issues the request |
|
366 * @param aStatus Request status. |
|
367 * @param aPCmd Command identifier and other relevant information |
|
368 */ |
|
369 virtual void NotifyOpenChannel( |
|
370 TRequestStatus& aStatus, |
|
371 TDes8& aPCmd ) = 0; |
|
372 |
|
373 /** |
|
374 * Cancels the request |
|
375 */ |
|
376 virtual void NotifyOpenChannelCancel() = 0; |
|
377 |
|
378 /** |
|
379 * Issues the request |
|
380 * @param aStatus Request status. |
|
381 * @param aPCmd Command identifier and other relevant information |
|
382 */ |
|
383 virtual void NotifyCloseChannel( |
|
384 TRequestStatus& aStatus, |
|
385 TDes8& aPCmd ) = 0; |
|
386 |
|
387 /** |
|
388 * Cancels the request |
|
389 */ |
|
390 virtual void NotifyCloseChannelCancel() = 0; |
|
391 |
|
392 /** |
|
393 * Issues the request |
|
394 * @param aStatus Request status. |
|
395 * @param aPCmd Command identifier and other relevant information |
|
396 */ |
|
397 virtual void NotifyGetChannelStatus( |
|
398 TRequestStatus& aStatus, |
|
399 TDes8& aPCmd ) = 0; |
|
400 |
|
401 /** |
|
402 * Cancels the request |
|
403 */ |
|
404 virtual void NotifyGetChannelStatusCancel() = 0; |
|
405 |
|
406 /** |
|
407 * Issues the request |
|
408 * @param aStatus Request status. |
|
409 * @param aPCmd Command identifier and other relevant information |
|
410 */ |
|
411 virtual void NotifySendData( |
|
412 TRequestStatus& aStatus, |
|
413 TDes8& aPCmd ) = 0; |
|
414 |
|
415 /** |
|
416 * Cancels the request |
|
417 */ |
|
418 virtual void NotifySendDataCancel() = 0; |
|
419 |
|
420 /** |
|
421 * Issues the request |
|
422 * @param aStatus Request status. |
|
423 * @param aPCmd Command identifier and other relevant information |
|
424 */ |
|
425 virtual void NotifyReceiveData( |
|
426 TRequestStatus& aStatus, |
|
427 TDes8& aPCmd ) = 0; |
|
428 |
|
429 /** |
|
430 * Cancels the request |
|
431 */ |
|
432 virtual void NotifyReceiveDataCancel() = 0; |
|
433 |
|
434 /** |
|
435 * Sends menu selection to SIM. |
|
436 * @param aMenuSelection Selected menu item |
|
437 */ |
|
438 virtual void SendMenuSelection( const TDes8& aMenuSelection ) = 0; |
|
439 |
|
440 /** |
|
441 * Sends terminal response to SIM. |
|
442 * @param aPCmd Proactive command, which is sending the Terminal Rsp. |
|
443 * @param aPckg Packed data of terminal rsp. |
|
444 */ |
|
445 virtual void TerminalRsp( |
|
446 RSat::TPCmd aPCmd, |
|
447 const TDesC8& aPckg ) = 0; |
|
448 |
|
449 /** |
|
450 * Gets the icon info from SIM. |
|
451 * @param aReqStatus Request status. |
|
452 * @param aRecordNumber Specifies the EF_IMG in SIM. |
|
453 * @param aIconEf Contains the icon informations from SIM in returning |
|
454 * of the method. |
|
455 */ |
|
456 virtual void GetIcon( |
|
457 TRequestStatus& aReqStatus, |
|
458 TUint8 aRecordNumber, |
|
459 RSat::TIcon& aIconEf ) = 0; |
|
460 |
|
461 /** |
|
462 * Gets the icon image. |
|
463 * @param aReqStatus Request status. |
|
464 * @param aInstanceInfo Informatio of the icon, which data is |
|
465 * fetched from SIM. |
|
466 * @param aInstance Contains the icon data from SIM in returning of the |
|
467 * method. |
|
468 */ |
|
469 virtual void GetImageInstance( |
|
470 TRequestStatus& aReqStatus, |
|
471 const TDesC8& aInstanceInfo, |
|
472 TDes8& aInstance ) = 0; |
|
473 |
|
474 /** |
|
475 * Gets color lookup table of the icon. |
|
476 * @param aReqStatus Request status. |
|
477 * @param aInstanceNumber Image instance number. |
|
478 * @param aOffset Offset of the clut. |
|
479 * @param aClut Contains the Clut of the icon in returning of the |
|
480 * method. |
|
481 */ |
|
482 virtual void GetClut( |
|
483 TRequestStatus& aReqStatus, |
|
484 TUint aInstanceNumber, |
|
485 TUint aOffset, |
|
486 TDes8& aClut ) = 0; |
|
487 |
|
488 /** |
|
489 * Sends notify to SIM about some event using EventDownload. |
|
490 * @param aReqStatus Request status. |
|
491 * @param aSingleEvent Single event reported to SIM. |
|
492 * @param aEventInfo Contains information of an event. |
|
493 */ |
|
494 virtual void EventDownload( |
|
495 TRequestStatus& aReqStatus, |
|
496 RSat::TEventList aSingleEvent, |
|
497 const TDesC8& aEventInfo ) = 0; |
|
498 |
|
499 /** |
|
500 * Indicates is RSat connected |
|
501 * @return ETrue if RSat is connected |
|
502 */ |
|
503 virtual TBool IsRSatConnected() const = 0; |
|
504 |
|
505 /** |
|
506 * Called when all the supported notifies are sent to TSY |
|
507 * @return TInt from RSat |
|
508 */ |
|
509 virtual TInt UsatClientReadyIndication() = 0; |
|
510 |
|
511 private: |
|
512 |
|
513 // Prohibit copy constructor if not deriving from CBase. |
|
514 MSatApi( const MSatApi& ); |
|
515 |
|
516 // Prohibit assigment operator if not deriving from CBase. |
|
517 MSatApi& operator=( const MSatApi& ); |
|
518 |
|
519 }; |
|
520 |
|
521 #endif // MSATAPI_H |
|
522 |
|
523 // End of File |
|