1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/asclisession.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,206 @@
1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __ASCLISESSION_H__
1.20 +#define __ASCLISESSION_H__
1.21 +
1.22 +// System includes
1.23 +#include <e32base.h>
1.24 +
1.25 +// User includes
1.26 +#include <asshddefs.h>
1.27 +
1.28 +// Classes referenced
1.29 +class TASShdAlarm;
1.30 +class TASCliSoundPlayDefinition;
1.31 +
1.32 +
1.33 +class RASCliSession : public RSessionBase
1.34 +/** The client-side interface to the Symbian OS alarm server.
1.35 +@publishedAll
1.36 +@released
1.37 +*/
1.38 + {
1.39 +///////////////////////////////////////////////////////////////////////////////////////
1.40 +public: // CONNECT TO SERVER & VERSIONING
1.41 +///////////////////////////////////////////////////////////////////////////////////////
1.42 +
1.43 + IMPORT_C RASCliSession();
1.44 +
1.45 + IMPORT_C TInt Connect();
1.46 +
1.47 + IMPORT_C TVersion Version() const;
1.48 +
1.49 +///////////////////////////////////////////////////////////////////////////////////////
1.50 +public: // ALARM SPECIFIC FUNCTIONALITY
1.51 +///////////////////////////////////////////////////////////////////////////////////////
1.52 +
1.53 + IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm) const;
1.54 +
1.55 + IMPORT_C TInt AlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const;
1.56 +
1.57 + IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm);
1.58 +
1.59 + IMPORT_C void AlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData);
1.60 +
1.61 + IMPORT_C void AlarmNotificationCancelAndDequeue(TAlarmId aAlarmId) const;
1.62 +
1.63 + IMPORT_C TInt GetAlarmDetails(TAlarmId aAlarmId, TASShdAlarm& aAlarm) const;
1.64 +
1.65 + IMPORT_C TInt AlarmDelete(TAlarmId aAlarmId) const;
1.66 +
1.67 + IMPORT_C TInt GetAlarmCategory(TAlarmId aAlarmId, TAlarmCategory& aCategory) const;
1.68 +
1.69 + IMPORT_C TInt GetAlarmOwner(TAlarmId aAlarmId, TFullName& aThreadName) const;
1.70 +
1.71 + IMPORT_C TInt SetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus aStatus) const;
1.72 +
1.73 + IMPORT_C TInt GetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus& aStatus) const;
1.74 +
1.75 + IMPORT_C TInt SetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed aDayOrTimed) const;
1.76 +
1.77 + IMPORT_C TInt GetAlarmDayOrTimed(TAlarmId aAlarmId, TAlarmDayOrTimed& aDayOrTimed) const;
1.78 +
1.79 + IMPORT_C TInt SetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags aCharacteristics) const;
1.80 +
1.81 + IMPORT_C TInt GetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags& aCharacteristics) const;
1.82 +
1.83 + IMPORT_C TInt SetClientData(const TASShdAlarm& aAlarm);
1.84 +
1.85 + IMPORT_C TInt SetAlarmDays(TAlarmId aAlarmId, TUint8 aAlarmDays) const;
1.86 + IMPORT_C TInt GetAlarmDays(TAlarmId aAlarmId, TUint8& aAlarmDays) const;
1.87 + IMPORT_C TInt SetContinuous(TAlarmId aAlarmId, TBool aContinuous) const;
1.88 + IMPORT_C TInt GetContinuous(TAlarmId aAlarmId, TBool& aContinuous) const;
1.89 +
1.90 +///////////////////////////////////////////////////////////////////////////////////////
1.91 +public: // ALARM DATA FUNCTIONALITY
1.92 +///////////////////////////////////////////////////////////////////////////////////////
1.93 +
1.94 + IMPORT_C TInt AlarmDataAttachL(TAlarmId aAlarmId, const TDesC8& aData) const;
1.95 +
1.96 + IMPORT_C TInt AlarmDataDetach(TAlarmId aAlarmId) const;
1.97 +
1.98 + inline TInt AlarmDataDetatch(TAlarmId aAlarmId) const;
1.99 +
1.100 + IMPORT_C TInt AlarmDataSize(TAlarmId aAlarmId) const;
1.101 +
1.102 + IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, TDes8& aSink) const;
1.103 +
1.104 + IMPORT_C TInt GetAlarmData(TAlarmId aAlarmId, HBufC8*& aSink) const;
1.105 +
1.106 +///////////////////////////////////////////////////////////////////////////////////////
1.107 +public: // CATEGORY-SPECIFIC FUNCTIONALITY
1.108 +///////////////////////////////////////////////////////////////////////////////////////
1.109 +
1.110 + IMPORT_C TInt SetAlarmStatusByCategory(TAlarmCategory aCategory, TAlarmStatus aStatus) const;
1.111 +
1.112 + IMPORT_C TInt GetAlarmCountForCategory(TAlarmCategory aCategory) const;
1.113 +
1.114 + IMPORT_C TInt AlarmDeleteAllByCategory(TAlarmCategory aCategory, TBool aDeleteOnlyOrphanedAlarmsInCategory) const;
1.115 +
1.116 + IMPORT_C TInt AlarmDeleteByCategory(TAlarmCategory aCategory, TDeleteType aWhatToDelete) const;
1.117 +
1.118 + IMPORT_C void GetAvailableCategoryListL(RArray<TAlarmCategory>& aCategories) const;
1.119 +
1.120 + IMPORT_C void GetAlarmIdListForCategoryL(TAlarmCategory aCategory, RArray<TAlarmId>& aAlarmIds) const;
1.121 +
1.122 +///////////////////////////////////////////////////////////////////////////////////////
1.123 +public: // MISC FUNCTIONALITY
1.124 +///////////////////////////////////////////////////////////////////////////////////////
1.125 +
1.126 + IMPORT_C TInt AlarmCountByState(TAlarmState aState) const;
1.127 +
1.128 + IMPORT_C void GetAlarmIdListByStateL(TAlarmState aState, RArray<TAlarmId>& aAlarmIds) const;
1.129 +
1.130 + IMPORT_C void GetAlarmIdListL(RArray<TAlarmId>& aAlarmIds) const;
1.131 +
1.132 + IMPORT_C TInt GetNextDueAlarmId(TAlarmId& aAlarmId) const;
1.133 +
1.134 + IMPORT_C TInt NumberOfAlarmsActiveInQueue() const;
1.135 +
1.136 +///////////////////////////////////////////////////////////////////////////////////////
1.137 +public: // SOUND CONTROL
1.138 +///////////////////////////////////////////////////////////////////////////////////////
1.139 +
1.140 + IMPORT_C TInt SetAlarmSoundState(TAlarmGlobalSoundState aState) const;
1.141 +
1.142 + IMPORT_C TInt GetAlarmSoundState(TAlarmGlobalSoundState& aState) const;
1.143 +
1.144 + IMPORT_C TInt SetAlarmSoundsSilentUntil(const TTime& aLocalTime) const;
1.145 +
1.146 + IMPORT_C TInt SetAlarmSoundsSilentFor(TTimeIntervalMinutes aTimeToRemainSilentFor) const;
1.147 +
1.148 + IMPORT_C TInt GetAlarmSoundsSilentUntil(TTime& aLocalTime) const;
1.149 +
1.150 + IMPORT_C TInt CancelAlarmSilence() const;
1.151 +
1.152 + IMPORT_C TBool AlarmSoundsTemporarilySilenced() const;
1.153 +
1.154 + IMPORT_C void SetAlarmPlayIntervalsL(const CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const;
1.155 +
1.156 + IMPORT_C void GetAlarmPlayIntervalsL(CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const;
1.157 +
1.158 +///////////////////////////////////////////////////////////////////////////////////////
1.159 +public: // CHANGE NOTIFICATION
1.160 +///////////////////////////////////////////////////////////////////////////////////////
1.161 +
1.162 + IMPORT_C void NotifyChange(TRequestStatus& aStatus, TAlarmId& aAlarmId);
1.163 +
1.164 + IMPORT_C void NotifyChangeCancel() const;
1.165 +
1.166 +///////////////////////////////////////////////////////////////////////////////////////
1.167 +public: // DEBUG ONLY
1.168 +///////////////////////////////////////////////////////////////////////////////////////
1.169 +
1.170 + IMPORT_C void __DbgShutDownServer() const;
1.171 +
1.172 + IMPORT_C void __DbgFailAlloc(TInt aCount) const;
1.173 +
1.174 + IMPORT_C void __DbgPreventUserNotify(TBool aShouldStop) const;
1.175 +
1.176 + IMPORT_C TInt __DbgSnoozeAlarm(TAlarmId aAlarmId, const TTime& aNewTime) const;
1.177 +
1.178 + IMPORT_C TInt __DbgSetEnvChgHandling(TBool aFlag) const;
1.179 +///////////////////////////////////////////////////////////////////////////////////////
1.180 +private: // MEMBER DATA
1.181 +///////////////////////////////////////////////////////////////////////////////////////
1.182 +
1.183 + void FetchAlarmIdsFromBufferL(RArray<TAlarmId>& aAlarmIds, TInt aBufferSize) const;
1.184 +
1.185 + CBufBase* FetchTransferBufferLC(TInt aBufferSize) const;
1.186 +
1.187 + void DoAlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData);
1.188 + TInt DoAlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const;
1.189 +
1.190 +///////////////////////////////////////////////////////////////////////////////////////
1.191 +private: // MEMBER DATA
1.192 +///////////////////////////////////////////////////////////////////////////////////////
1.193 +
1.194 + TPtr8 iPackage;
1.195 + TPtr8 iAlarmIdPointer;
1.196 + };
1.197 +
1.198 +///////////////////////////////////////////////////////////////////////////////////////
1.199 +// ----> RASCliSession (inlines)
1.200 +///////////////////////////////////////////////////////////////////////////////////////
1.201 +inline TInt RASCliSession::AlarmDataDetatch(TAlarmId aAlarmId) const
1.202 +/** @deprecated 8.0
1.203 +
1.204 +RASCliSession::AlarmDataDetach() should be used instead */
1.205 + {
1.206 + return AlarmDataDetach(aAlarmId);
1.207 + };
1.208 +
1.209 +#endif