1 /* |
|
2 * Copyright (c) 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: Partial declaration of the notifier API. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef SYNCMLNOTIFIERPARAMS_H |
|
21 #define SYNCMLNOTIFIERPARAMS_H |
|
22 |
|
23 #include <centralrepository.h> |
|
24 #include <schinfo.h> |
|
25 |
|
26 // INCLUDES |
|
27 |
|
28 // CONSTANTS |
|
29 const TUint KSyncMLMaxServerMsgLength = 200; |
|
30 const TUint KSyncMLMaxProfileNameLength = 50; |
|
31 const TUint KSyncMLMaxDefaultResponseMsgLength = 300; |
|
32 const TUint KSyncMLMaxAlertResultLength = 150; |
|
33 const TUint KSyncMLChoiceItemsLengthBuffer = 400; |
|
34 const TUint KSyncMLMaxChoiceItemLength = 100; |
|
35 const TUint KSyncMLChunknameLength = 25; |
|
36 |
|
37 // MACROS |
|
38 |
|
39 // FORWARD DECLARATIONS |
|
40 class TSyncMLAppLaunchNotifParams; |
|
41 class TSyncMLDlgNotifParams; |
|
42 class TSyncMLAppLaunchNotifRetVal; |
|
43 class TSyncMLDlgNotifRetVal; |
|
44 class TSyncMLFwUpdNotifParams; |
|
45 class TSyncMLFwUpdNotifRetVal; |
|
46 class TSyncMLDlgNotifReturnParams; |
|
47 |
|
48 |
|
49 // DATA TYPES |
|
50 typedef TPckgBuf<TSyncMLAppLaunchNotifParams> TSyncMLAppLaunchNotifParamsPckg; |
|
51 typedef TPckgBuf<TSyncMLDlgNotifParams> TSyncMLDlgNotifParamsPckg; |
|
52 typedef TPckgBuf<TSyncMLFwUpdNotifParams> TSyncMLFwUpdNotifParamsPckg; |
|
53 typedef TPckgBuf<TSyncMLAppLaunchNotifRetVal> TSyncMLAppLaunchNotifRetValPckg; |
|
54 typedef TPckgBuf<TSyncMLDlgNotifRetVal> TSyncMLDlgNotifRetValPckg; |
|
55 typedef TPckgBuf<TSyncMLFwUpdNotifRetVal> TSyncMLFwUpdNotifRetValPckg; |
|
56 typedef TPckgBuf<TSyncMLDlgNotifReturnParams> TSyncMLDlgNotifReturnParamsPckg; |
|
57 |
|
58 |
|
59 enum TSyncMLSessionTypes |
|
60 { |
|
61 ESyncMLUnknownSession, |
|
62 ESyncMLSyncSession, |
|
63 ESyncMLMgmtSession, |
|
64 }; |
|
65 |
|
66 enum TSyncMLDlgNoteTypes |
|
67 { |
|
68 ESyncMLInfoNote, |
|
69 ESyncMLErrorNote, |
|
70 ESyncMLOkQuery, |
|
71 ESyncMLYesNoQuery, |
|
72 ESyncMLQueryNote, // Deprecated. Use ESyncMLOkQuery or ESyncMLYesNoQuery instead |
|
73 ESyncMLInputQuery, //For 1102 User Input alert |
|
74 ESyncMLSingleChoiceQuery, //1103 |
|
75 ESyncMLMultiChoiceQuery //1104 |
|
76 }; |
|
77 |
|
78 enum TSyncMLFwUpdNoteTypes |
|
79 { |
|
80 ESyncMLFwUpdUnknown, |
|
81 ESyncMLFwUpdErrorNote, |
|
82 ESyncMLFwUpdResultNote, |
|
83 ESyncMLFwUpdStartQuery, |
|
84 ESyncMLFwUpdRebootNote, |
|
85 ESyncMLFwUpdNoReminder, //Enum for No Reminder & Install Later note |
|
86 ESyncMLFwUpdLargeNotEnoughMemory, //Enum for large object No Enough memory situation |
|
87 ESyncMLFwUpdOmaDLNotEnoughMemory, //Enum for Oma Download No Enough memory situation |
|
88 ESyncMLFwUpdOmaDLUserCancel, //Enum for Oma Download User cancel situation |
|
89 ESyncMLFwUpdOmaDLPostponed, //Enum for Oma Download postponed |
|
90 ESyncMLFwUpdOmaDLCancelled, //Enum for Oma Download cancelled |
|
91 ESyncMLFwUpdOmaDLResume, //Enum for Oma Download Resume |
|
92 ESyncMLFwUpdStartQueryEnc, //Enum for starting installation on encrypted memory |
|
93 ESyncMLFwUpdForceQuery, // Forcing the update when the retry count for postponing the update expires. |
|
94 ESyncMLFwUpdPostponeNote, // The note that is to be shown when user postpones the udpate |
|
95 ESyncMLFwUpdPostponeLimitQuery |
|
96 |
|
97 }; |
|
98 |
|
99 |
|
100 enum TSyncMLFwUpdNoteInfo |
|
101 { |
|
102 KErrCommsLineFail2, //Enum for Oma Download connection failure with resume supported |
|
103 KErrGeneralResume, //Enum for Oma Download general error with resume supported |
|
104 KErrGeneralNoResume, //Enum for Oma Download general error without resume supported |
|
105 KErrBadUsbPower, //Enum for low battery error when USB charging is supported |
|
106 KErrBadPowerForEnc, //Enum for low battery error during encryption |
|
107 KErrDeviceMemoryBusy //Enum to show drive busy error when encryption or decryption is in progress |
|
108 }; |
|
109 |
|
110 |
|
111 enum TSyncMLSANSupport |
|
112 { |
|
113 ESANNotSpecified, |
|
114 ESANSilent, |
|
115 ESANUserInformative, |
|
116 ESANUserInteractive |
|
117 }; |
|
118 |
|
119 enum TSyncMLUserInputTypes |
|
120 { |
|
121 ESyncMLInputTypeAlphaNumeric, |
|
122 ESyncMLInputTypeNumeric, |
|
123 ESyncMLInputTypeDate, |
|
124 ESyncMLInputTypeTime, |
|
125 ESyncMLInputTypePhoneNumber, |
|
126 ESyncMLInputTypeIPAddress |
|
127 }; |
|
128 |
|
129 enum TSyncMLUserInputEchoTypes |
|
130 { |
|
131 ESyncMLEchoTypeText, |
|
132 ESyncMLEchoTypePassword |
|
133 }; |
|
134 |
|
135 |
|
136 // CLASS DECLARATION |
|
137 |
|
138 /** |
|
139 * Struct to allow the sending of parameters to SyncML application |
|
140 * starter notifier plugin. |
|
141 * |
|
142 * @lib SyncMLNotifier |
|
143 * @since Series 60 3.0 |
|
144 */ |
|
145 class TSyncMLAppLaunchNotifParams |
|
146 { |
|
147 public: |
|
148 // Type of the SyncML session to be initiated. |
|
149 TSyncMLSessionTypes iSessionType; |
|
150 // Identifier of the job requested. |
|
151 TInt iJobId; |
|
152 // Identifier of the profile used |
|
153 TInt iProfileId; |
|
154 // Server alert Ui mode |
|
155 TInt iUimode; |
|
156 }; |
|
157 |
|
158 /** |
|
159 * Struct to allow the delivery of return values from SyncML application |
|
160 * starter notifier plugin. |
|
161 * |
|
162 * @lib SyncMLNotifier |
|
163 * @since Series 60 3.0 |
|
164 */ |
|
165 class TSyncMLAppLaunchNotifRetVal |
|
166 { |
|
167 public: |
|
168 // Identifier of the session requested. |
|
169 TUid iSecureId; |
|
170 }; |
|
171 |
|
172 |
|
173 /** |
|
174 * Struct to allow the sending of parameters to SyncML server |
|
175 * dialog notifier plugin. |
|
176 * |
|
177 * @lib SyncMLNotifier |
|
178 * @since Series 60 3.0 |
|
179 */ |
|
180 class TSyncMLDlgNotifParams |
|
181 { |
|
182 public: |
|
183 // Type of the query or note to be shown. |
|
184 TSyncMLDlgNoteTypes iNoteType; |
|
185 // Message to be shown on the screen. |
|
186 TBufC<KSyncMLMaxServerMsgLength> iServerMsg; |
|
187 // Timeout of the note (in seconds). 0 = No timeout. |
|
188 TInt iMaxTime; |
|
189 //Response message in case of 1102 alert |
|
190 TBuf<KSyncMLMaxDefaultResponseMsgLength> iDR; |
|
191 //Input type |
|
192 TInt iIT; |
|
193 //Echo type |
|
194 TInt iET; |
|
195 //Max length |
|
196 TInt iMaxLength; |
|
197 //For choice alerts |
|
198 TBufC<KSyncMLChoiceItemsLengthBuffer> iItemLength; |
|
199 TBufC<KSyncMLChunknameLength> iChunkName; |
|
200 //Number of choice items |
|
201 TInt iNumberOfItems; |
|
202 }; |
|
203 |
|
204 |
|
205 |
|
206 //For 1102 server alert |
|
207 class TSyncMLDlgNotifReturnParams |
|
208 { |
|
209 public: |
|
210 TInt iretval; //which stores the yes/no/end key pressed |
|
211 TBuf<KSyncMLMaxAlertResultLength> irettext; |
|
212 }; |
|
213 |
|
214 |
|
215 /** |
|
216 * Struct to allow the delivery of return values from SyncML server |
|
217 * dialog notifier plugin. |
|
218 * |
|
219 * @lib SyncMLNotifier |
|
220 * @since Series 60 3.0 |
|
221 */ |
|
222 class TSyncMLDlgNotifRetVal |
|
223 { |
|
224 // Included for future use. |
|
225 }; |
|
226 |
|
227 /** |
|
228 * Struct to allow the sending of parameters to SyncML firmware |
|
229 * update notifier plugin. |
|
230 * |
|
231 * @lib SyncMLNotifier |
|
232 * @since Series 60 3.1 |
|
233 */ |
|
234 class TSyncMLFwUpdNotifParams |
|
235 { |
|
236 public: |
|
237 // Type of the SyncML session to be initiated. |
|
238 TSyncMLFwUpdNoteTypes iNoteType; |
|
239 |
|
240 // Generic integer parameter. |
|
241 // Usage: |
|
242 // ESyncMLFwUpdErrorNote: Symbian error code. |
|
243 // ESyncMLFwUpdResultNote: Symbian error code. |
|
244 // ESyncMLFwUpdStartQuery: Firmware update profile identifier. |
|
245 TInt iIntParam; |
|
246 TInt iMemoryNeeded;// Parameter to hold how much memory is to be |
|
247 // freed for downloading the package. |
|
248 TBool iEncryptReq; //To tell if encrypt query should be shown to user. |
|
249 TInt iFotaUserPostponeCount; // To determine the number of times user has postponed the update. |
|
250 TInt iFotaMaxPostponeCount; // The maximum number of times the update can be postponed. |
|
251 TBuf<KSyncMLMaxServerMsgLength> iSelectedReminder; // The option selected by the user to postpone the update. |
|
252 TIntervalType iIntervalType; |
|
253 TInt iInterval; |
|
254 |
|
255 }; |
|
256 |
|
257 /** |
|
258 * Struct to allow the delivery of return values from SyncML firmware |
|
259 * update notifier plugin. |
|
260 * |
|
261 * @lib SyncMLNotifier |
|
262 * @since Series 60 3.1 |
|
263 */ |
|
264 class TSyncMLFwUpdNotifRetVal |
|
265 { |
|
266 // Included for future use. |
|
267 }; |
|
268 |
|
269 #endif // SYNCMLNOTIFIERPARAMS_H |
|
270 |
|
271 // End of File |
|