|
1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #ifndef __SSMADAPTATION_H__ |
|
17 #define __SSMADAPTATION_H__ |
|
18 |
|
19 #include <e32base.h> |
|
20 |
|
21 #include <ssm/ssmstate.h> |
|
22 #include <ssm/ssmadaptation.hrh> |
|
23 |
|
24 /** |
|
25 The UID2 value for SSM State Adaptation DLLs. |
|
26 @publishedPartner |
|
27 @released |
|
28 */ |
|
29 const TInt KStateAdaptationDllTypeUidValue=0x2000D76A; |
|
30 |
|
31 /** |
|
32 The UID2 for SSM State Adaptation DLLs. |
|
33 @publishedPartner |
|
34 @released |
|
35 */ |
|
36 const TUid KStateAdaptationDllTypeUid={KStateAdaptationDllTypeUidValue}; |
|
37 |
|
38 /** |
|
39 @publishedPartner |
|
40 @released |
|
41 */ |
|
42 class MStateAdaptation |
|
43 { |
|
44 public: |
|
45 /** |
|
46 Request a Cooperating System to change system state. |
|
47 @param aState contains the new System State |
|
48 @param aStatus to complete when the operation has finished |
|
49 @see TSsmState |
|
50 @see TRequestStatus |
|
51 */ |
|
52 virtual void RequestCoopSysStateChange(TSsmState aState, TRequestStatus& aStatus) = 0; |
|
53 |
|
54 /** |
|
55 Request the Cooperating System to perform a self test. |
|
56 @param aStatus to complete when the operation has finished |
|
57 @see TRequestStatus |
|
58 */ |
|
59 virtual void RequestCoopSysSelfTest(TRequestStatus& aStatus) = 0; |
|
60 |
|
61 /** |
|
62 Request the Cooperating System to perform any required restart actions, since a device restart is about to be performed. |
|
63 @param aReason reason used by Cooperating System |
|
64 @param aStatus to complete when the operation has finished |
|
65 @see TRequestStatus |
|
66 */ |
|
67 virtual void RequestCoopSysPerformRestartActions(TInt aReason, TRequestStatus& aStatus) = 0; |
|
68 |
|
69 /** |
|
70 Request the Cooperating System to perform any required shutdown actions, since a device shutdown is about to be performed. |
|
71 @param aReason reason used by Cooperating System |
|
72 @param aStatus to complete when the operation has finished |
|
73 @see TRequestStatus |
|
74 */ |
|
75 virtual void RequestCoopSysPerformShutdownActions(TInt aReason, TRequestStatus& aStatus) = 0; |
|
76 |
|
77 /** |
|
78 Request the Cooperating System to Restore Factory Settings. |
|
79 @param aRfsType type of factory settings to be restored |
|
80 @param aStatus to complete when the operation has finished |
|
81 @see TSsmRfsType |
|
82 @see TRequestStatus |
|
83 */ |
|
84 virtual void RequestCoopSysPerformRfsActions(TSsmRfsType aRfsType, TRequestStatus& aStatus) = 0; |
|
85 |
|
86 /** |
|
87 This cancels a previous request from one of the other five Request methods in this class. |
|
88 Only one request is allowed to be outstanding on each connection session. |
|
89 */ |
|
90 virtual void RequestCancel() = 0; |
|
91 |
|
92 /** |
|
93 Requests notification from the Cooperating system of any events that occur. |
|
94 @param aEvent one of TSsmCoopSysEventType event's for which notification is requested, packaged in a descriptor |
|
95 @param aStatus to complete when the notification request has occurred |
|
96 @see TSsmCoopSysEventType |
|
97 @see TRequestStatus |
|
98 */ |
|
99 virtual void NotifyCoopSysEvent(TDes8& aEvent, TRequestStatus& aStatus) = 0; |
|
100 |
|
101 /** |
|
102 This cancels the outstanding request for notification of events. |
|
103 Only one request for notification of fatal events is allowed for each connected session. |
|
104 */ |
|
105 virtual void NotifyCancel() = 0; |
|
106 |
|
107 /** |
|
108 It is expected that Release will usually just call "delete this" on the object, |
|
109 but this will depend on the implementation of each policy. |
|
110 */ |
|
111 virtual void Release() = 0; |
|
112 }; |
|
113 |
|
114 /** |
|
115 The UID2 value for SSM RTC Adaptation DLLs. |
|
116 @publishedPartner |
|
117 @released |
|
118 */ |
|
119 const TInt KRtcAdaptationDllTypeUidValue=0x2000D76C; |
|
120 |
|
121 /** |
|
122 The UID2 for SSM RTC Adaptation DLLs. |
|
123 @publishedPartner |
|
124 @released |
|
125 */ |
|
126 const TUid KRtcAdaptationDllTypeUid={KRtcAdaptationDllTypeUidValue}; |
|
127 |
|
128 /** |
|
129 @publishedPartner |
|
130 @released |
|
131 */ |
|
132 class MRtcAdaptation |
|
133 { |
|
134 public: |
|
135 /** |
|
136 Check that the RTC is valid. |
|
137 @param aValidityPckg on return contains the status of the validity of the RTC as a boolean value |
|
138 @param aStatus to complete when the operation has finished |
|
139 @see TRequestStatus |
|
140 */ |
|
141 virtual void ValidateRtc(TDes8& aValidityPckg, TRequestStatus& aStatus) = 0; |
|
142 |
|
143 /** |
|
144 Set a device wake-up alarm time, in UTC (coordinated universal time), in the RTC. |
|
145 @param aAlarmTimePckg requested wake up time |
|
146 @param aStatus to complete when the operation has finished |
|
147 @see TRequestStatus |
|
148 */ |
|
149 |
|
150 virtual void SetWakeupAlarm(TDesC8& aAlarmTimePckg, TRequestStatus& aStatus) = 0; |
|
151 |
|
152 /** |
|
153 Delete the current device wake-up alarm time in the RTC. |
|
154 @param aStatus to complete when the operation has finished |
|
155 @see TRequestStatus |
|
156 */ |
|
157 virtual void UnsetWakeupAlarm(TRequestStatus& aStatus) = 0; |
|
158 |
|
159 /** |
|
160 This cancels a previous request from one of the other three methods in this class. |
|
161 Only one request is allowed to be outstanding on each connection session. |
|
162 */ |
|
163 virtual void Cancel() = 0; |
|
164 |
|
165 /** |
|
166 It is expected that Release will usually just call "delete this" on the object, |
|
167 but this will depend on the implementation of each policy. |
|
168 */ |
|
169 virtual void Release() = 0; |
|
170 }; |
|
171 |
|
172 /** |
|
173 The UID2 value for SSM SIM Adaptation DLLs. |
|
174 @publishedPartner |
|
175 @released |
|
176 */ |
|
177 const TInt KSimAdaptationDllTypeUidValue=0x2000D76B; |
|
178 |
|
179 /** |
|
180 The UID2 for SSM RTC Adaptation DLLs. |
|
181 @publishedPartner |
|
182 @released |
|
183 */ |
|
184 const TUid KSimAdaptationDllTypeUid={KSimAdaptationDllTypeUidValue}; |
|
185 |
|
186 /** |
|
187 @publishedPartner |
|
188 @released |
|
189 */ |
|
190 class MSimAdaptation |
|
191 { |
|
192 public: |
|
193 /** |
|
194 Check if the current SIM is among the group of recently used (i.e. Owned) SIM cards. |
|
195 @param aOwnedPckg SIM details |
|
196 @param aStatus to complete when the operation has finished |
|
197 @see TRequestStatus |
|
198 */ |
|
199 virtual void GetSimOwned(TDes8& aOwnedPckg, TRequestStatus& aStatus) = 0; |
|
200 |
|
201 /** |
|
202 This cancels the previous get request for SIM information. |
|
203 Only one request for SIM information (either owned or changed) can be outstanding on each connected session. |
|
204 */ |
|
205 virtual void GetCancel() = 0; |
|
206 |
|
207 /** |
|
208 Requests notification of SIM events. |
|
209 @param aTypePckg contains the SIM event on notification completion |
|
210 @param aStatus to complete when the operation has finished |
|
211 @see TSsmSimEventType |
|
212 @see TRequestStatus |
|
213 */ |
|
214 virtual void NotifySimEvent(TDes8& aTypePckg, TRequestStatus& aStatus) = 0; |
|
215 |
|
216 /** |
|
217 This cancels the previous request for notification of SIM events. |
|
218 Only one request for SIM events can be outstanding on each connected session. |
|
219 */ |
|
220 virtual void NotifyCancel() = 0; |
|
221 |
|
222 /** |
|
223 It is expected that Release will usually just call "delete this" on the object, |
|
224 but this will depend on the implementation of each policy. |
|
225 */ |
|
226 virtual void Release() = 0; |
|
227 }; |
|
228 |
|
229 /** |
|
230 The UID2 value for SSM Emergency Call Rf Adaptation DLLs. |
|
231 @publishedPartner |
|
232 @released |
|
233 */ |
|
234 const TInt KEmergencyCallRfAdaptationDllTypeUidValue=0x2000E657; |
|
235 |
|
236 /** |
|
237 The UID2 for SSM Emergency Call Rf Adaptation DLLs. |
|
238 @publishedPartner |
|
239 @released |
|
240 */ |
|
241 const TUid KEmergencyCallRfAdaptationDllTypeUid={KEmergencyCallRfAdaptationDllTypeUidValue}; |
|
242 |
|
243 /** |
|
244 @publishedPartner |
|
245 @released |
|
246 */ |
|
247 class MEmergencyCallRfAdaptation |
|
248 { |
|
249 public: |
|
250 /** |
|
251 Request RF activation so that an emergency call can be made. |
|
252 @param aStatus to complete when the operation has finished |
|
253 @see TRequestStatus |
|
254 */ |
|
255 virtual void ActivateRfForEmergencyCall(TRequestStatus& aStatus) = 0; |
|
256 |
|
257 /** |
|
258 Request RF deactivation after an emergency call have been made. |
|
259 @param aStatus to complete when the operation has finished |
|
260 @see TRequestStatus |
|
261 */ |
|
262 virtual void DeactivateRfForEmergencyCall(TRequestStatus& aStatus) = 0; |
|
263 |
|
264 /** |
|
265 This cancels the previous outstanding request made for Activation/De-activation of emergency calls. |
|
266 Only one request is allowed to be outstanding for each connected session. |
|
267 */ |
|
268 virtual void Cancel() = 0; |
|
269 |
|
270 /** |
|
271 It is expected that Release will usually just call "delete this" on the object, |
|
272 but this will depend on the implementation of each policy. |
|
273 */ |
|
274 virtual void Release() = 0; |
|
275 }; |
|
276 |
|
277 /** |
|
278 The UID2 value for SSM Miscellaneous Adaptation DLLs. |
|
279 @publishedPartner |
|
280 @released |
|
281 */ |
|
282 const TInt KMiscAdaptationDllTypeUidValue=0x2000E658; |
|
283 |
|
284 /** |
|
285 The UID2 for SSM Miscellaneous Adaptation DLLs. |
|
286 @publishedPartner |
|
287 @released |
|
288 */ |
|
289 const TUid KMiscAdaptationDllTypeUid={KMiscAdaptationDllTypeUidValue}; |
|
290 |
|
291 /** |
|
292 @publishedPartner |
|
293 @released |
|
294 */ |
|
295 class MMiscAdaptation |
|
296 { |
|
297 public: |
|
298 /** |
|
299 Request the next security state. |
|
300 @param aState next security state |
|
301 @param aResponsePckg response to state change request on completion |
|
302 @param aStatus to complete when the operation has finished |
|
303 @see TRequestStatus |
|
304 */ |
|
305 virtual void SecurityStateChange(TInt aState, TDes8& aResponsePckg, TRequestStatus& aStatus) = 0; |
|
306 |
|
307 /** |
|
308 Get the start-up mode from the Cooperating System. |
|
309 @param aModePckg should contain start-up of the Cooperating System on completion |
|
310 @param aStatus to complete when the operation has finished |
|
311 @see TRequestStatus |
|
312 */ |
|
313 virtual void GetGlobalStartupMode(TDes8& aModePckg, TRequestStatus& aStatus) = 0; |
|
314 |
|
315 /** |
|
316 Prepare language codes stored in the SIM in preferred language lists. |
|
317 The next call should be GetSimLanguagesL() |
|
318 @param aPriority priority for which the language lists need to be prepared |
|
319 @param aSizePckg on return contains the size of the buffer, which a client should allocate and pass as the one of the parameters (CBufBase* aBuf, TInt aCount) to GetSimLanguagesL() |
|
320 @param aStatus to complete when the operation has finished |
|
321 @see TSsmLanguageListPriority |
|
322 @see TRequestStatus |
|
323 @see GetSimLanguagesL |
|
324 */ |
|
325 virtual void PrepareSimLanguages(TSsmLanguageListPriority aPriority, TDes8& aSizePckg, TRequestStatus& aStatus) = 0; |
|
326 |
|
327 /** |
|
328 Get language codes stored in the SIM in preferred language lists. |
|
329 PrepareSimLanguages() call should precede this call |
|
330 @param aBuf should contain the language lists on completion |
|
331 @param aCount to contain the count of the languages |
|
332 @see PrepareSimLanguages |
|
333 */ |
|
334 virtual void GetSimLanguagesL(CBufBase* aBuf, TInt aCount) = 0; |
|
335 |
|
336 /** |
|
337 This cancels the previous request from any of the other four methods in this class. |
|
338 Only one request is allowed to be outstanding for each connected session. |
|
339 */ |
|
340 virtual void Cancel() = 0; |
|
341 |
|
342 /** |
|
343 It is expected that Release will usually just call "delete this" on the object, |
|
344 but this will depend on the implementation of each policy. |
|
345 */ |
|
346 virtual void Release() = 0; |
|
347 |
|
348 /** |
|
349 Retrieve information about Hidden reset. |
|
350 @param aHiddenResetPckg Result package (ETrue or EFalse) |
|
351 @param aStatus to complete when the operation has finished |
|
352 @see TRequestStatus |
|
353 */ |
|
354 virtual void GetHiddenReset(TDes8& aHiddenResetPckg, TRequestStatus& aStatus) = 0; |
|
355 }; |
|
356 |
|
357 #endif // __SSMADAPTATION_H__ |