|
1 /* |
|
2 * Copyright (c) 2002 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: Abstract interface for RImpsClient. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MCAIMPSCLIENT_H |
|
21 #define MCAIMPSCLIENT_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <ImpsClient.h> |
|
25 |
|
26 // CLASS DECLARATION |
|
27 |
|
28 /** |
|
29 * Abstract base class. |
|
30 * Same interface as RImpsClient |
|
31 * |
|
32 * @lib CAAdapter.lib |
|
33 * @since 1.2 |
|
34 */ |
|
35 class MCAImpsClient |
|
36 { |
|
37 public: // New functions |
|
38 |
|
39 // INITILIZATION AND CONNECT |
|
40 |
|
41 /** |
|
42 * Registers the service status change observer. |
|
43 * Ignored if API has already registered an observer |
|
44 * This can be called after the actual registeration of the |
|
45 * particular client has been made (RegisterL). |
|
46 * @since 3.0 |
|
47 * @param aObs status observer implementation. Ownership NOT transferred. |
|
48 */ |
|
49 virtual void RegisterStatusObserverL( MImpsStatusHandler2* aObs ) = 0; |
|
50 |
|
51 /** |
|
52 * Unregisters the service status change observer. |
|
53 * Ignored if API does not have registered observer. |
|
54 * This method is not necessary if unregister of the particular |
|
55 * client type has been executed (Unregister). |
|
56 * @since 1.2 |
|
57 */ |
|
58 virtual void UnregisterStatusObserverL( ) = 0; |
|
59 |
|
60 /** |
|
61 * Available services accessor |
|
62 * Notice that there are no services in NOT_LOGGED state, i.e. |
|
63 * before login has been executed successfully from any client. |
|
64 * @since 1.2 |
|
65 * @param aServices Service tree having |
|
66 * all supported features and functions. |
|
67 */ |
|
68 virtual void GetServicesL( TImpsServices& aServices ) = 0; |
|
69 |
|
70 /** |
|
71 * Register an advanced error observer. |
|
72 * If this is not registered then normal observers are called in |
|
73 * derived client interfaces, but they do not provide other |
|
74 * information then status code. This detailed error |
|
75 * message observer provides also textual descriton and |
|
76 * detailed error list in case of partial success. |
|
77 * @since 3.0 |
|
78 * @param aObs error event observer implementation. Ownership NOT transferred. |
|
79 */ |
|
80 virtual void RegisterErrorObserverL( MImpsErrorHandler2& aObs ) = 0; |
|
81 |
|
82 /** |
|
83 * Unregisters an advanced error observer. |
|
84 * Ignored if API does not have error observer. |
|
85 * This method is not necessary if unregister of the particular |
|
86 * client type has been executed (Unregister). |
|
87 * @since 1.2 |
|
88 */ |
|
89 virtual void UnregisterErrorObserverL( ) = 0; |
|
90 |
|
91 |
|
92 /** |
|
93 * Internal use only. |
|
94 * Error observer accessor |
|
95 * @since 1.2 |
|
96 * @return error observer pointer. Ownership NOT transferred. |
|
97 */ |
|
98 virtual MImpsErrorHandler2* ErrorHandler() const = 0; |
|
99 |
|
100 /** |
|
101 * Internal use only. |
|
102 * Status observer accessor. This is missing from WV Engine. Introduced for consistency. |
|
103 * @since 1.2 |
|
104 * @return Status observer pointer. Ownership NOT transferred. |
|
105 */ |
|
106 virtual MImpsStatusHandler2* StatusHandler() const = 0; |
|
107 |
|
108 protected: // New functions |
|
109 |
|
110 /** |
|
111 * Destructor. |
|
112 */ |
|
113 virtual ~MCAImpsClient() { }; |
|
114 }; |
|
115 |
|
116 #endif // MCAIMPSCLIENT_H |
|
117 |
|
118 // End of File |