|
1 // Copyright (c) 1999-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 __ASCLISESSION_H__ |
|
17 #define __ASCLISESSION_H__ |
|
18 |
|
19 // System includes |
|
20 #include <e32base.h> |
|
21 |
|
22 // User includes |
|
23 #include <asshddefs.h> |
|
24 |
|
25 // Classes referenced |
|
26 class TASShdAlarm; |
|
27 class TASCliSoundPlayDefinition; |
|
28 |
|
29 |
|
30 class RASCliSession : public RSessionBase |
|
31 /** The client-side interface to the Symbian OS alarm server. |
|
32 @publishedAll |
|
33 @released |
|
34 */ |
|
35 { |
|
36 // |
|
37 public: // CONNECT TO SERVER & VERSIONING |
|
38 // |
|
39 |
|
40 IMPORT_C RASCliSession(); |
|
41 |
|
42 IMPORT_C TInt Connect(); |
|
43 |
|
44 IMPORT_C TVersion Version() const; |
|
45 |
|
46 // |
|
47 public: // ALARM SPECIFIC FUNCTIONALITY |
|
48 // |
|
49 |
|
50 IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm) const; |
|
51 |
|
52 IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const; |
|
53 |
|
54 IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm); |
|
55 |
|
56 IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData); |
|
57 |
|
58 IMPORT_C void AlarmNotificationCancelAndDequeue(TAlarmId aAlarmId) const; |
|
59 |
|
60 IMPORT_C TInt GetAlarmDetails(TAlarmId aAlarmId, TASShdAlarm& aAlarm) const; |
|
61 |
|
62 IMPORT_C TInt AlarmDelete(TAlarmId aAlarmId) const; |
|
63 |
|
64 IMPORT_C TInt GetAlarmCategory(TAlarmId aAlarmId, TAlarmCategory& aCategory) const; |
|
65 |
|
66 IMPORT_C TInt GetAlarmOwner(TAlarmId aAlarmId, TFullName& aThreadName) const; |
|
67 |
|
68 IMPORT_C TInt SetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus aStatus) const; |
|
69 |
|
70 IMPORT_C TInt SetAlarmStatusForCalendarFile(const TDesC& aFileName, TAlarmStatus aStatus) const; |
|
71 |
|
72 IMPORT_C TInt GetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus& aStatus) const; |
|
73 |
|
74 IMPORT_C TInt SetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed aDayOrTimed) const; |
|
75 |
|
76 IMPORT_C TInt GetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed& aDayOrTimed) const; |
|
77 |
|
78 IMPORT_C TInt SetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags aCharacteristics) const; |
|
79 |
|
80 IMPORT_C TInt GetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags& aCharacteristics) const; |
|
81 |
|
82 #ifdef SYMBIAN_SYSTEM_STATE_MANAGEMENT |
|
83 IMPORT_C TInt SetWakeup(TAlarmId aAlarmId, TBool aEnabled) const; |
|
84 #endif |
|
85 |
|
86 IMPORT_C TInt SetClientData(const TASShdAlarm& aAlarm); |
|
87 |
|
88 #ifdef SYMBIAN_ALARM_REPEAT_EXTENSIONS |
|
89 IMPORT_C TInt SetAlarmDays(TAlarmId aAlarmId, TUint8 aAlarmDays) const; |
|
90 IMPORT_C TInt GetAlarmDays(TAlarmId aAlarmId, TUint8& aAlarmDays) const; |
|
91 IMPORT_C TInt SetContinuous(TAlarmId aAlarmId, TBool aContinuous) const; |
|
92 IMPORT_C TInt GetContinuous(TAlarmId aAlarmId, TBool& aContinuous) const; |
|
93 #endif |
|
94 |
|
95 // |
|
96 public: // ALARM DATA FUNCTIONALITY |
|
97 // |
|
98 |
|
99 IMPORT_C TInt AlarmDataAttachL(TAlarmId aAlarmId, const TDesC8& aData) const; |
|
100 |
|
101 IMPORT_C TInt AlarmDataDetach(TAlarmId aAlarmId) const; |
|
102 |
|
103 inline TInt AlarmDataDetatch(TAlarmId aAlarmId) const; |
|
104 |
|
105 IMPORT_C TInt AlarmDataSize(TAlarmId aAlarmId) const; |
|
106 |
|
107 IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, TDes8& aSink) const; |
|
108 |
|
109 IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, HBufC8*& aSink) const; |
|
110 |
|
111 // |
|
112 public: // CATEGORY-SPECIFIC FUNCTIONALITY |
|
113 // |
|
114 |
|
115 IMPORT_C TInt SetAlarmStatusByCategory(TAlarmCategory aCategory, TAlarmStatus aStatus) const; |
|
116 |
|
117 IMPORT_C TInt GetAlarmCountForCategory(TAlarmCategory aCategory) const; |
|
118 |
|
119 IMPORT_C TInt AlarmDeleteAllByCategory(TAlarmCategory aCategory, TBool aDeleteOnlyOrphanedAlarmsInCategory) const; |
|
120 |
|
121 IMPORT_C TInt AlarmDeleteByCategory(TAlarmCategory aCategory, TDeleteType aWhatToDelete) const; |
|
122 |
|
123 IMPORT_C TInt AlarmDeleteByCalendarFile(const TDesC& aFileName, TDeleteType aWhatToDelete) const; |
|
124 |
|
125 IMPORT_C void GetAvailableCategoryListL(RArray<TAlarmCategory>& aCategories) const; |
|
126 |
|
127 IMPORT_C void GetAlarmIdListForCategoryL(TAlarmCategory aCategory, RArray<TAlarmId>& aAlarmIds) const; |
|
128 |
|
129 // |
|
130 public: // MISC FUNCTIONALITY |
|
131 // |
|
132 |
|
133 IMPORT_C TInt AlarmCountByState(TAlarmState aState) const; |
|
134 |
|
135 IMPORT_C void GetAlarmIdListByStateL(TAlarmState aState, RArray<TAlarmId>& aAlarmIds) const; |
|
136 |
|
137 IMPORT_C void GetAlarmIdListL(RArray<TAlarmId>& aAlarmIds) const; |
|
138 |
|
139 IMPORT_C TInt GetNextDueAlarmId(TAlarmId& aAlarmId) const; |
|
140 |
|
141 IMPORT_C TInt NumberOfAlarmsActiveInQueue() const; |
|
142 |
|
143 // |
|
144 public: // SOUND CONTROL |
|
145 // |
|
146 |
|
147 IMPORT_C TInt SetAlarmSoundState(TAlarmGlobalSoundState aState) const; |
|
148 |
|
149 IMPORT_C TInt GetAlarmSoundState(TAlarmGlobalSoundState& aState) const; |
|
150 |
|
151 IMPORT_C TInt SetAlarmSoundsSilentUntil(const TTime& aLocalTime) const; |
|
152 |
|
153 IMPORT_C TInt SetAlarmSoundsSilentFor(TTimeIntervalMinutes aTimeToRemainSilentFor) const; |
|
154 |
|
155 IMPORT_C TInt GetAlarmSoundsSilentUntil(TTime& aLocalTime) const; |
|
156 |
|
157 IMPORT_C TInt CancelAlarmSilence() const; |
|
158 |
|
159 IMPORT_C TBool AlarmSoundsTemporarilySilenced() const; |
|
160 |
|
161 IMPORT_C void SetAlarmPlayIntervalsL(const CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const; |
|
162 |
|
163 IMPORT_C void GetAlarmPlayIntervalsL(CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const; |
|
164 |
|
165 // |
|
166 public: // CHANGE NOTIFICATION |
|
167 // |
|
168 |
|
169 IMPORT_C void NotifyChange(TRequestStatus& aStatus, TAlarmId& aAlarmId); |
|
170 |
|
171 IMPORT_C void NotifyChangeCancel() const; |
|
172 |
|
173 // |
|
174 public: // DEBUG ONLY |
|
175 // |
|
176 |
|
177 IMPORT_C void __DbgShutDownServer() const; |
|
178 |
|
179 IMPORT_C void __DbgFailAlloc(TInt aCount) const; |
|
180 |
|
181 IMPORT_C void __DbgPreventUserNotify(TBool aShouldStop) const; |
|
182 |
|
183 IMPORT_C TInt __DbgSnoozeAlarm(TAlarmId aAlarmId, const TTime& aNewTime) const; |
|
184 |
|
185 IMPORT_C TInt __DbgSetEnvChgHandling(TBool aFlag) const; |
|
186 // |
|
187 private: // MEMBER DATA |
|
188 // |
|
189 |
|
190 void FetchAlarmIdsFromBufferL(RArray<TAlarmId>& aAlarmIds, TInt aBufferSize) const; |
|
191 |
|
192 CBufBase* FetchTransferBufferLC(TInt aBufferSize) const; |
|
193 |
|
194 void DoAlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData); |
|
195 TInt DoAlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const; |
|
196 |
|
197 // |
|
198 private: // MEMBER DATA |
|
199 // |
|
200 |
|
201 TPtr8 iPackage; |
|
202 TPtr8 iAlarmIdPointer; |
|
203 }; |
|
204 |
|
205 // |
|
206 // ----> RASCliSession (inlines) |
|
207 // |
|
208 inline TInt RASCliSession::AlarmDataDetatch(TAlarmId aAlarmId) const |
|
209 /** @deprecated 8.0 |
|
210 |
|
211 RASCliSession::AlarmDataDetach() should be used instead */ |
|
212 { |
|
213 return AlarmDataDetach(aAlarmId); |
|
214 }; |
|
215 |
|
216 #endif |