epoc32/include/mw/asclisession.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
     1.1 --- a/epoc32/include/mw/asclisession.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/mw/asclisession.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     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 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -33,9 +33,9 @@
    1.16  @released
    1.17  */
    1.18  	{
    1.19 -///////////////////////////////////////////////////////////////////////////////////////
    1.20 +//
    1.21  public:										// CONNECT TO SERVER & VERSIONING
    1.22 -///////////////////////////////////////////////////////////////////////////////////////
    1.23 +//
    1.24  
    1.25  	IMPORT_C RASCliSession();
    1.26  
    1.27 @@ -43,9 +43,9 @@
    1.28  
    1.29  	IMPORT_C TVersion						Version() const;
    1.30  
    1.31 -///////////////////////////////////////////////////////////////////////////////////////
    1.32 +//
    1.33  public:										// ALARM SPECIFIC FUNCTIONALITY
    1.34 -///////////////////////////////////////////////////////////////////////////////////////
    1.35 +//
    1.36  
    1.37  	IMPORT_C TInt							AlarmAdd(TASShdAlarm& aAlarm) const;
    1.38  
    1.39 @@ -66,6 +66,8 @@
    1.40  	IMPORT_C TInt							GetAlarmOwner(TAlarmId aAlarmId, TFullName& aThreadName) const;
    1.41  
    1.42  	IMPORT_C TInt							SetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus aStatus) const;
    1.43 +	
    1.44 +	IMPORT_C TInt                           SetAlarmStatusForCalendarFile(const TDesC& aFileName, TAlarmStatus aStatus) const;
    1.45  
    1.46  	IMPORT_C TInt							GetAlarmStatus(TAlarmId aAlarmId, TAlarmStatus& aStatus) const;
    1.47  
    1.48 @@ -77,16 +79,22 @@
    1.49  
    1.50  	IMPORT_C TInt							GetAlarmCharacteristics(TAlarmId aAlarmId, TAlarmCharacteristicsFlags& aCharacteristics) const;
    1.51  
    1.52 +#ifdef SYMBIAN_SYSTEM_STATE_MANAGEMENT
    1.53 +	IMPORT_C TInt							SetWakeup(TAlarmId aAlarmId, TBool aEnabled) const;
    1.54 +#endif
    1.55 +
    1.56  	IMPORT_C TInt							SetClientData(const TASShdAlarm& aAlarm);
    1.57  
    1.58 +#ifdef SYMBIAN_ALARM_REPEAT_EXTENSIONS
    1.59  	IMPORT_C TInt							SetAlarmDays(TAlarmId aAlarmId, TUint8 aAlarmDays) const;
    1.60      IMPORT_C TInt							GetAlarmDays(TAlarmId aAlarmId, TUint8& aAlarmDays) const;
    1.61      IMPORT_C TInt							SetContinuous(TAlarmId aAlarmId, TBool aContinuous) const;
    1.62      IMPORT_C TInt							GetContinuous(TAlarmId aAlarmId, TBool& aContinuous) const;
    1.63 +#endif
    1.64  	
    1.65 -///////////////////////////////////////////////////////////////////////////////////////
    1.66 +//
    1.67  public:										// ALARM DATA FUNCTIONALITY
    1.68 -///////////////////////////////////////////////////////////////////////////////////////
    1.69 +//
    1.70  
    1.71  	IMPORT_C TInt							AlarmDataAttachL(TAlarmId aAlarmId, const TDesC8& aData) const;
    1.72  
    1.73 @@ -100,9 +108,9 @@
    1.74  
    1.75  	IMPORT_C TInt							GetAlarmData(TAlarmId aAlarmId, HBufC8*& aSink) const;
    1.76  
    1.77 -///////////////////////////////////////////////////////////////////////////////////////
    1.78 +//
    1.79  public:										// CATEGORY-SPECIFIC FUNCTIONALITY
    1.80 -///////////////////////////////////////////////////////////////////////////////////////
    1.81 +//
    1.82  
    1.83  	IMPORT_C TInt							SetAlarmStatusByCategory(TAlarmCategory aCategory, TAlarmStatus aStatus) const;
    1.84  
    1.85 @@ -112,13 +120,15 @@
    1.86  
    1.87  	IMPORT_C TInt							AlarmDeleteByCategory(TAlarmCategory aCategory, TDeleteType aWhatToDelete) const;
    1.88  
    1.89 +	IMPORT_C TInt                           AlarmDeleteByCalendarFile(const TDesC& aFileName, TDeleteType aWhatToDelete) const;
    1.90 +	
    1.91  	IMPORT_C void							GetAvailableCategoryListL(RArray<TAlarmCategory>& aCategories) const;
    1.92  
    1.93  	IMPORT_C void							GetAlarmIdListForCategoryL(TAlarmCategory aCategory, RArray<TAlarmId>& aAlarmIds) const;
    1.94  
    1.95 -///////////////////////////////////////////////////////////////////////////////////////
    1.96 +//
    1.97  public:										// MISC FUNCTIONALITY
    1.98 -///////////////////////////////////////////////////////////////////////////////////////
    1.99 +//
   1.100  
   1.101  	IMPORT_C TInt							AlarmCountByState(TAlarmState aState) const;
   1.102  
   1.103 @@ -130,9 +140,9 @@
   1.104  
   1.105  	IMPORT_C TInt							NumberOfAlarmsActiveInQueue() const;
   1.106  
   1.107 -///////////////////////////////////////////////////////////////////////////////////////
   1.108 +//
   1.109  public:										// SOUND CONTROL
   1.110 -///////////////////////////////////////////////////////////////////////////////////////
   1.111 +//
   1.112  
   1.113  	IMPORT_C TInt							SetAlarmSoundState(TAlarmGlobalSoundState aState) const;
   1.114  
   1.115 @@ -152,17 +162,17 @@
   1.116  
   1.117  	IMPORT_C void							GetAlarmPlayIntervalsL(CArrayFix<TASCliSoundPlayDefinition>& aIntervals) const;
   1.118  
   1.119 -///////////////////////////////////////////////////////////////////////////////////////
   1.120 +//
   1.121  public:										// CHANGE NOTIFICATION
   1.122 -///////////////////////////////////////////////////////////////////////////////////////
   1.123 +//
   1.124  
   1.125  	IMPORT_C void							NotifyChange(TRequestStatus& aStatus, TAlarmId& aAlarmId);
   1.126  
   1.127  	IMPORT_C void							NotifyChangeCancel() const;
   1.128  
   1.129 -///////////////////////////////////////////////////////////////////////////////////////
   1.130 +//
   1.131  public:										// DEBUG ONLY
   1.132 -///////////////////////////////////////////////////////////////////////////////////////
   1.133 +//
   1.134  
   1.135  	IMPORT_C void							__DbgShutDownServer() const;
   1.136  
   1.137 @@ -173,9 +183,9 @@
   1.138  	IMPORT_C TInt							__DbgSnoozeAlarm(TAlarmId aAlarmId, const TTime& aNewTime) const;
   1.139  	
   1.140  	IMPORT_C TInt 							__DbgSetEnvChgHandling(TBool aFlag) const;
   1.141 -///////////////////////////////////////////////////////////////////////////////////////
   1.142 +//
   1.143  private:									// MEMBER DATA
   1.144 -///////////////////////////////////////////////////////////////////////////////////////
   1.145 +//
   1.146  
   1.147  	void									FetchAlarmIdsFromBufferL(RArray<TAlarmId>& aAlarmIds, TInt aBufferSize) const;
   1.148  
   1.149 @@ -184,17 +194,17 @@
   1.150  	void									DoAlarmAddWithNotification(TRequestStatus& aStatus, TASShdAlarm& aAlarm, const TDesC8& aData);
   1.151  	TInt									DoAlarmAdd(TASShdAlarm& aAlarm, const TDesC8& aData) const;
   1.152  
   1.153 -///////////////////////////////////////////////////////////////////////////////////////
   1.154 +//
   1.155  private:									// MEMBER DATA
   1.156 -///////////////////////////////////////////////////////////////////////////////////////
   1.157 +//
   1.158  
   1.159  	TPtr8									iPackage;
   1.160  	TPtr8									iAlarmIdPointer;
   1.161  	};
   1.162  
   1.163 -///////////////////////////////////////////////////////////////////////////////////////
   1.164 +//
   1.165  // ----> RASCliSession (inlines)
   1.166 -///////////////////////////////////////////////////////////////////////////////////////
   1.167 +//
   1.168  inline TInt RASCliSession::AlarmDataDetatch(TAlarmId aAlarmId) const
   1.169  /** @deprecated 8.0
   1.170