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