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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
16 #ifndef __ASCLISESSION_H__
17 #define __ASCLISESSION_H__
23 #include <asshddefs.h>
27 class TASCliSoundPlayDefinition;
30 class RASCliSession : public RSessionBase
31 /** The client-side interface to the Symbian OS alarm server.
36 ///////////////////////////////////////////////////////////////////////////////////////
37 public: // CONNECT TO SERVER & VERSIONING
38 ///////////////////////////////////////////////////////////////////////////////////////
40 IMPORT_C RASCliSession();
42 IMPORT_C TInt Connect();
44 IMPORT_C TVersion Version() const;
46 ///////////////////////////////////////////////////////////////////////////////////////
47 public: // ALARM SPECIFIC FUNCTIONALITY
48 ///////////////////////////////////////////////////////////////////////////////////////
50 IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm) const;
52 IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const;
54 IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm);
56 IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData);
58 IMPORT_C void AlarmNotificationCancelAndDequeue(TAlarmId aAlarmId) const;
60 IMPORT_C TInt GetAlarmDetails(TAlarmId aAlarmId, TASShdAlarm& aAlarm) const;
62 IMPORT_C TInt AlarmDelete(TAlarmId aAlarmId) const;
64 IMPORT_C TInt GetAlarmCategory(TAlarmId aAlarmId, TAlarmCategory& aCategory) const;
66 IMPORT_C TInt GetAlarmOwner(TAlarmId aAlarmId, TFullName& aThreadName) const;
68 IMPORT_C TInt SetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus aStatus) const;
70 IMPORT_C TInt GetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus& aStatus) const;
72 IMPORT_C TInt SetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed aDayOrTimed) const;
74 IMPORT_C TInt GetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed& aDayOrTimed) const;
76 IMPORT_C TInt SetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags aCharacteristics) const;
78 IMPORT_C TInt GetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags& aCharacteristics) const;
80 IMPORT_C TInt SetClientData(const TASShdAlarm& aAlarm);
82 IMPORT_C TInt SetAlarmDays(TAlarmId aAlarmId, TUint8 aAlarmDays) const;
83 IMPORT_C TInt GetAlarmDays(TAlarmId aAlarmId, TUint8& aAlarmDays) const;
84 IMPORT_C TInt SetContinuous(TAlarmId aAlarmId, TBool aContinuous) const;
85 IMPORT_C TInt GetContinuous(TAlarmId aAlarmId, TBool& aContinuous) const;
87 ///////////////////////////////////////////////////////////////////////////////////////
88 public: // ALARM DATA FUNCTIONALITY
89 ///////////////////////////////////////////////////////////////////////////////////////
91 IMPORT_C TInt AlarmDataAttachL(TAlarmId aAlarmId, const TDesC8& aData) const;
93 IMPORT_C TInt AlarmDataDetach(TAlarmId aAlarmId) const;
95 inline TInt AlarmDataDetatch(TAlarmId aAlarmId) const;
97 IMPORT_C TInt AlarmDataSize(TAlarmId aAlarmId) const;
99 IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, TDes8& aSink) const;
101 IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, HBufC8*& aSink) const;
103 ///////////////////////////////////////////////////////////////////////////////////////
104 public: // CATEGORY-SPECIFIC FUNCTIONALITY
105 ///////////////////////////////////////////////////////////////////////////////////////
107 IMPORT_C TInt SetAlarmStatusByCategory(TAlarmCategory aCategory, TAlarmStatus aStatus) const;
109 IMPORT_C TInt GetAlarmCountForCategory(TAlarmCategory aCategory) const;
111 IMPORT_C TInt AlarmDeleteAllByCategory(TAlarmCategory aCategory, TBool aDeleteOnlyOrphanedAlarmsInCategory) const;
113 IMPORT_C TInt AlarmDeleteByCategory(TAlarmCategory aCategory, TDeleteType aWhatToDelete) const;
115 IMPORT_C void GetAvailableCategoryListL(RArray<TAlarmCategory>& aCategories) const;
117 IMPORT_C void GetAlarmIdListForCategoryL(TAlarmCategory aCategory, RArray<TAlarmId>& aAlarmIds) const;
119 ///////////////////////////////////////////////////////////////////////////////////////
120 public: // MISC FUNCTIONALITY
121 ///////////////////////////////////////////////////////////////////////////////////////
123 IMPORT_C TInt AlarmCountByState(TAlarmState aState) const;
125 IMPORT_C void GetAlarmIdListByStateL(TAlarmState aState, RArray<TAlarmId>& aAlarmIds) const;
127 IMPORT_C void GetAlarmIdListL(RArray<TAlarmId>& aAlarmIds) const;
129 IMPORT_C TInt GetNextDueAlarmId(TAlarmId& aAlarmId) const;
131 IMPORT_C TInt NumberOfAlarmsActiveInQueue() const;
133 ///////////////////////////////////////////////////////////////////////////////////////
134 public: // SOUND CONTROL
135 ///////////////////////////////////////////////////////////////////////////////////////
137 IMPORT_C TInt SetAlarmSoundState(TAlarmGlobalSoundState aState) const;
139 IMPORT_C TInt GetAlarmSoundState(TAlarmGlobalSoundState& aState) const;
141 IMPORT_C TInt SetAlarmSoundsSilentUntil(const TTime& aLocalTime) const;
143 IMPORT_C TInt SetAlarmSoundsSilentFor(TTimeIntervalMinutes aTimeToRemainSilentFor) const;
145 IMPORT_C TInt GetAlarmSoundsSilentUntil(TTime& aLocalTime) const;
147 IMPORT_C TInt CancelAlarmSilence() const;
149 IMPORT_C TBool AlarmSoundsTemporarilySilenced() const;
151 IMPORT_C void SetAlarmPlayIntervalsL(const CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const;
153 IMPORT_C void GetAlarmPlayIntervalsL(CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const;
155 ///////////////////////////////////////////////////////////////////////////////////////
156 public: // CHANGE NOTIFICATION
157 ///////////////////////////////////////////////////////////////////////////////////////
159 IMPORT_C void NotifyChange(TRequestStatus& aStatus, TAlarmId& aAlarmId);
161 IMPORT_C void NotifyChangeCancel() const;
163 ///////////////////////////////////////////////////////////////////////////////////////
164 public: // DEBUG ONLY
165 ///////////////////////////////////////////////////////////////////////////////////////
167 IMPORT_C void __DbgShutDownServer() const;
169 IMPORT_C void __DbgFailAlloc(TInt aCount) const;
171 IMPORT_C void __DbgPreventUserNotify(TBool aShouldStop) const;
173 IMPORT_C TInt __DbgSnoozeAlarm(TAlarmId aAlarmId, const TTime& aNewTime) const;
175 IMPORT_C TInt __DbgSetEnvChgHandling(TBool aFlag) const;
176 ///////////////////////////////////////////////////////////////////////////////////////
177 private: // MEMBER DATA
178 ///////////////////////////////////////////////////////////////////////////////////////
180 void FetchAlarmIdsFromBufferL(RArray<TAlarmId>& aAlarmIds, TInt aBufferSize) const;
182 CBufBase* FetchTransferBufferLC(TInt aBufferSize) const;
184 void DoAlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData);
185 TInt DoAlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const;
187 ///////////////////////////////////////////////////////////////////////////////////////
188 private: // MEMBER DATA
189 ///////////////////////////////////////////////////////////////////////////////////////
192 TPtr8 iAlarmIdPointer;
195 ///////////////////////////////////////////////////////////////////////////////////////
196 // ----> RASCliSession (inlines)
197 ///////////////////////////////////////////////////////////////////////////////////////
198 inline TInt RASCliSession::AlarmDataDetatch(TAlarmId aAlarmId) const
201 RASCliSession::AlarmDataDetach() should be used instead */
203 return AlarmDataDetach(aAlarmId);