1 /* |
|
2 * Copyright (c) 2004-2005 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: API for CallUiEngine usage. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef CAUIENG_H |
|
20 #define CAUIENG_H |
|
21 |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 #include <spdefinitions.h> //RIdArray |
|
26 #include "caui.hrh" |
|
27 |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class MCaUiReconnectQueryObserver; |
|
31 class MDesC16Array; |
|
32 class MCaUiDialResultObserver; |
|
33 class CPhCntMatcher; |
|
34 |
|
35 |
|
36 // CLASS DECLARATION |
|
37 |
|
38 /** |
|
39 * The API for CallUIEngine usage. |
|
40 * |
|
41 * @lib CaUiEngine.lib |
|
42 * @since 2.6 |
|
43 */ |
|
44 class CCaUiEngApi |
|
45 : public CBase |
|
46 { |
|
47 public: // Data types |
|
48 |
|
49 /** |
|
50 * Enumerate all supported resource types. |
|
51 * |
|
52 * ECaUiResVoice - Pure voice call resources. |
|
53 * ECaUiResVoiceAndVideo - Voice and video call resources. |
|
54 * ECaUiResVoiceInternetAndVideo - All Internet, voice and video call resources. |
|
55 * ECaUiResOnlyInternet - Only Internet call resources. |
|
56 */ |
|
57 enum TCaUiEngResource |
|
58 { |
|
59 ECaUiResVoice = 0, |
|
60 ECaUiResVoiceAndVideo = 1, |
|
61 ECaUiResVoiceInternetAndVideo = 2, |
|
62 ECaUiResOnlyInternet = 3 |
|
63 }; |
|
64 |
|
65 |
|
66 /** |
|
67 * Enumerate all supported localized text. |
|
68 * |
|
69 * ECallMenuItemText - Menu item text for call. |
|
70 * EVoiceCallMenuItemText - Menu item text for voice call. |
|
71 * EVideoCallMenuItemText - Menu item text for video call. |
|
72 * EInternetCallMenuItemText - Menu item text for internet call. |
|
73 */ |
|
74 enum TCaUiEngText |
|
75 { |
|
76 ECallMenuItemText = 0, |
|
77 EVoiceCallMenuItemText = 1, |
|
78 EVideoCallMenuItemText = 2, |
|
79 EInternetCallMenuItemText = 3 |
|
80 }; |
|
81 |
|
82 public: // New functions |
|
83 |
|
84 /** |
|
85 * Make the dial operation. |
|
86 * |
|
87 * @param aObserver The observer to handle dial result. |
|
88 * @param aDialData The TCallUIDialDataV1 dial data information in |
|
89 * packaged format. |
|
90 * @param aCallType If not equal to ECaUiCallTypeUnknown, then |
|
91 * overwrites the call type in aDialData. |
|
92 */ |
|
93 virtual void DialL( |
|
94 MCaUiDialResultObserver& aObserver, |
|
95 const TDesC8& aDialData, |
|
96 const TCaUiCallType aCallType ) = 0; |
|
97 |
|
98 /** |
|
99 * Launch the qtn.tel.no.video.network information note. |
|
100 * |
|
101 */ |
|
102 virtual void LaunchNoNetSupNoteL() = 0; |
|
103 |
|
104 |
|
105 /** |
|
106 * Launch the reconnect confirmation query shown to user. |
|
107 * |
|
108 * @param aObserver The observer to handle query result. |
|
109 * @param aPhCntMatcher The Phone Contact Matcher. |
|
110 * Ownership not transferred. If NULL, then matcher is created |
|
111 * inside CaUIEngine. |
|
112 * @param aPhoneNumber Pointer to the number where dial was tried. |
|
113 * @param aIncludeVideoCallOption If set to ETrue, video call option is |
|
114 * included to query, otherwise it is left out. |
|
115 */ |
|
116 virtual void LaunchReconConfQueryL( |
|
117 MCaUiReconnectQueryObserver& aObserver, |
|
118 CPhCntMatcher* aPhCntMatcher, |
|
119 const TPtrC aPhoneNumber, |
|
120 const TBool aIncludeVideoCallOption ) = 0; |
|
121 |
|
122 |
|
123 /** |
|
124 * Cancel reconnect query launched with LaunchReconConfQueryL. |
|
125 * |
|
126 */ |
|
127 virtual void CancelReconConfQuery() = 0; |
|
128 |
|
129 |
|
130 /** |
|
131 * Launch note and reconnect confirmation query in sequence. |
|
132 * |
|
133 * @param aObserver The observer to handle query result. |
|
134 * @param aPhCntMatcher The Phone Contact Matcher. |
|
135 * Ownership not transferred. If NULL, then matcher is created |
|
136 * inside CaUIEngine. |
|
137 * @param aPhoneNumber Pointer to the number where dial was tried. |
|
138 * @param aIncludeVideoCallOption If set to ETrue, video call option is |
|
139 * included to query, otherwise it is left out. |
|
140 * @param aNoteText The text shown in information note. If empty, then |
|
141 * qtn.tel.no.video.network text is shown. |
|
142 */ |
|
143 virtual void LaunchNoteAndReconConfQueryL( |
|
144 MCaUiReconnectQueryObserver& aObserver, |
|
145 CPhCntMatcher* aPhCntMatcher, |
|
146 const TPtrC aPhoneNumber, |
|
147 const TBool aIncludeVideoCallOption, |
|
148 const TPtrC aNoteText ) = 0; |
|
149 |
|
150 /** |
|
151 * Cancel note and reconnection query launched with |
|
152 * LaunchNoteAndReconConfQueryL. |
|
153 * |
|
154 */ |
|
155 virtual void CancelNoteAndReconConfQuery() = 0; |
|
156 |
|
157 /** |
|
158 * Launch address selection. If contact contains default number or |
|
159 * only one number, number will be returned directly. |
|
160 * Otherwise address selection list displayed. |
|
161 * @since 3.0 |
|
162 * |
|
163 * @param aTelNum Contains selected number after execution. |
|
164 * @param aContactId The contact id from PhoneBook. |
|
165 * @param aVoIPAddressSelect If ETrue VoIP address select is used. |
|
166 * @return TBool, ETrue if number selected, |
|
167 * EFalse otherwice (E.g. list canceled). |
|
168 */ |
|
169 virtual TBool LaunchAddressSelectL( |
|
170 TDes& aTelNum, |
|
171 const TInt aContactId, |
|
172 const TBool aVoIPAddressSelect ) = 0; |
|
173 |
|
174 /** |
|
175 * Cancel address selection launched with LaunchAddressSelectL. |
|
176 * |
|
177 */ |
|
178 virtual void CancelAddressSelect() = 0; |
|
179 |
|
180 /** |
|
181 * Get VoIP services |
|
182 * @param aVoipServiceIds On return, contains the list of VoIP services |
|
183 */ |
|
184 virtual void GetVoIPServiceIdsL( RIdArray& aVoipServiceIds ) const = 0; |
|
185 |
|
186 /** |
|
187 * Get the service provider name |
|
188 * @param aServiceId The service, whose name is requested |
|
189 * @param aServiceName On return, contains the service name |
|
190 */ |
|
191 virtual void GetVoipServiceNameL( TServiceId aServiceId, TDes& aServiceName ) const = 0; |
|
192 }; |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 /** |
|
198 * Interface for CaUiEngine creation. |
|
199 * |
|
200 * @lib |
|
201 * @since 2.6 |
|
202 */ |
|
203 class CCaUiEngFactory : public CBase |
|
204 { |
|
205 public: |
|
206 |
|
207 /** |
|
208 * Creates CallUIEngine. |
|
209 * CCaUiEngFactory instance is deleted even in leave case. |
|
210 * |
|
211 * @return CCaUiEngApi implementation. NULL if not supported. |
|
212 * Ownership transferred. |
|
213 */ |
|
214 virtual CCaUiEngApi* CCaUiEngApiLD() = 0; |
|
215 |
|
216 }; |
|
217 |
|
218 /** |
|
219 * Only exported function. This is in index 1 in the lookup table. |
|
220 * Call this function to create CCaUiEngFactory instance. |
|
221 * |
|
222 * IMPORT_C CCaUiEngFactory* CreateCaUiEngFactoryL(); |
|
223 */ |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 #endif // CAUIENG_H |
|
229 |
|
230 // End of File |
|