RASCliSession Class Reference

class RASCliSession : public RSessionBase

The client-side interface to the Symbian OS alarm server.

Inherits from

Public Member Functions
RASCliSession()
IMPORT_C TIntAlarmAdd(TASShdAlarm &)
IMPORT_C TIntAlarmAdd(TASShdAlarm &, const TDesC8 &)
IMPORT_C voidAlarmAddWithNotification(TRequestStatus &, TASShdAlarm &)
IMPORT_C voidAlarmAddWithNotification(TRequestStatus &, TASShdAlarm &, const TDesC8 &)
IMPORT_C TIntAlarmCountByState(TAlarmState)
IMPORT_C TIntAlarmDataAttachL(TAlarmId, const TDesC8 &)
IMPORT_C TIntAlarmDataDetach(TAlarmId)
TInt AlarmDataDetatch(TAlarmId)
IMPORT_C TIntAlarmDataSize(TAlarmId)
IMPORT_C TIntAlarmDelete(TAlarmId)
IMPORT_C TIntAlarmDeleteAllByCategory(TAlarmCategory, TBool)
IMPORT_C TIntAlarmDeleteByCalendarFile(const TDesC &, TDeleteType)
IMPORT_C TIntAlarmDeleteByCategory(TAlarmCategory, TDeleteType)
IMPORT_C voidAlarmNotificationCancelAndDequeue(TAlarmId)
IMPORT_C TBoolAlarmSoundsTemporarilySilenced()
IMPORT_C TIntCancelAlarmSilence()
IMPORT_C TIntConnect()
IMPORT_C TIntGetAlarmCategory(TAlarmId, TAlarmCategory &)
IMPORT_C TIntGetAlarmCharacteristics(TAlarmId, TAlarmCharacteristicsFlags &)
IMPORT_C TIntGetAlarmCountForCategory(TAlarmCategory)
IMPORT_C TIntGetAlarmData(TAlarmId, TDes8 &)
IMPORT_C TIntGetAlarmData(TAlarmId, HBufC8 *&)
IMPORT_C TIntGetAlarmDayOrTimed(TAlarmId, TAlarmDayOrTimed &)
IMPORT_C TIntGetAlarmDetails(TAlarmId, TASShdAlarm &)
IMPORT_C voidGetAlarmIdListByStateL(TAlarmState, RArray< TAlarmId > &)
IMPORT_C voidGetAlarmIdListForCategoryL(TAlarmCategory, RArray< TAlarmId > &)
IMPORT_C voidGetAlarmIdListL(RArray< TAlarmId > &)
IMPORT_C TIntGetAlarmOwner(TAlarmId, TFullName &)
IMPORT_C voidGetAlarmPlayIntervalsL(CArrayFix< TASCliSoundPlayDefinition > &)
IMPORT_C TIntGetAlarmSoundState(TAlarmGlobalSoundState &)
IMPORT_C TIntGetAlarmSoundsSilentUntil(TTime &)
IMPORT_C TIntGetAlarmStatus(TAlarmId, TAlarmStatus &)
IMPORT_C voidGetAvailableCategoryListL(RArray< TAlarmCategory > &)
IMPORT_C TIntGetNextDueAlarmId(TAlarmId &)
IMPORT_C voidNotifyChange(TRequestStatus &, TAlarmId &)
IMPORT_C voidNotifyChangeCancel()
IMPORT_C TIntNumberOfAlarmsActiveInQueue()
IMPORT_C TIntSetAlarmCharacteristics(TAlarmId, TAlarmCharacteristicsFlags)
IMPORT_C TIntSetAlarmDayOrTimed(TAlarmId, TAlarmDayOrTimed)
IMPORT_C voidSetAlarmPlayIntervalsL(const CArrayFix< TASCliSoundPlayDefinition > &)
IMPORT_C TIntSetAlarmSoundState(TAlarmGlobalSoundState)
IMPORT_C TIntSetAlarmSoundsSilentFor(TTimeIntervalMinutes)
IMPORT_C TIntSetAlarmSoundsSilentUntil(const TTime &)
IMPORT_C TIntSetAlarmStatus(TAlarmId, TAlarmStatus)
IMPORT_C TIntSetAlarmStatusByCategory(TAlarmCategory, TAlarmStatus)
IMPORT_C TIntSetAlarmStatusForCalendarFile(const TDesC &, TAlarmStatus)
IMPORT_C TIntSetClientData(const TASShdAlarm &)
IMPORT_C TVersionVersion()
IMPORT_C void__DbgFailAlloc(TInt)
IMPORT_C void__DbgPreventUserNotify(TBool)
IMPORT_C TInt__DbgSetEnvChgHandling(TBool)
IMPORT_C void__DbgShutDownServer()
IMPORT_C TInt__DbgSnoozeAlarm(TAlarmId, const TTime &)
Private Member Functions
TInt DoAlarmAdd(TASShdAlarm &, const TDesC8 &)
voidDoAlarmAddWithNotification(TRequestStatus &, TASShdAlarm &, const TDesC8 &)
voidFetchAlarmIdsFromBufferL(RArray< TAlarmId > &, TInt)
CBufBase *FetchTransferBufferLC(TInt)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TPtr8 iAlarmIdPointer
TPtr8 iPackage
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RASCliSession()

IMPORT_CRASCliSession()

Member Functions Documentation

AlarmAdd(TASShdAlarm &)

IMPORT_C TIntAlarmAdd(TASShdAlarm &aAlarm)const

Parameters

TASShdAlarm & aAlarm

AlarmAdd(TASShdAlarm &, const TDesC8 &)

IMPORT_C TIntAlarmAdd(TASShdAlarm &aAlarm,
const TDesC8 &aData
)const

Parameters

TASShdAlarm & aAlarm
const TDesC8 & aData

AlarmAddWithNotification(TRequestStatus &, TASShdAlarm &)

IMPORT_C voidAlarmAddWithNotification(TRequestStatus &aStatus,
TASShdAlarm &aAlarm
)

Parameters

TRequestStatus & aStatus
TASShdAlarm & aAlarm

AlarmAddWithNotification(TRequestStatus &, TASShdAlarm &, const TDesC8 &)

IMPORT_C voidAlarmAddWithNotification(TRequestStatus &aStatus,
TASShdAlarm &aAlarm,
const TDesC8 &aData
)

Parameters

TRequestStatus & aStatus
TASShdAlarm & aAlarm
const TDesC8 & aData

AlarmCountByState(TAlarmState)

IMPORT_C TIntAlarmCountByState(TAlarmStateaState)const

Parameters

TAlarmState aState

AlarmDataAttachL(TAlarmId, const TDesC8 &)

IMPORT_C TIntAlarmDataAttachL(TAlarmIdaAlarmId,
const TDesC8 &aData
)const

Parameters

TAlarmId aAlarmId
const TDesC8 & aData

AlarmDataDetach(TAlarmId)

IMPORT_C TIntAlarmDataDetach(TAlarmIdaAlarmId)const

Parameters

TAlarmId aAlarmId

AlarmDataDetatch(TAlarmId)

TInt AlarmDataDetatch(TAlarmIdaAlarmId)const [inline]

8.0

RASCliSession::AlarmDataDetach()

should be used instead

Parameters

TAlarmId aAlarmId

AlarmDataSize(TAlarmId)

IMPORT_C TIntAlarmDataSize(TAlarmIdaAlarmId)const

Parameters

TAlarmId aAlarmId

AlarmDelete(TAlarmId)

IMPORT_C TIntAlarmDelete(TAlarmIdaAlarmId)const

Parameters

TAlarmId aAlarmId

AlarmDeleteAllByCategory(TAlarmCategory, TBool)

IMPORT_C TIntAlarmDeleteAllByCategory(TAlarmCategoryaCategory,
TBoolaDeleteOnlyOrphanedAlarmsInCategory
)const

Parameters

TAlarmCategory aCategory
TBool aDeleteOnlyOrphanedAlarmsInCategory

AlarmDeleteByCalendarFile(const TDesC &, TDeleteType)

IMPORT_C TIntAlarmDeleteByCalendarFile(const TDesC &aFileName,
TDeleteTypeaWhatToDelete
)const

Parameters

const TDesC & aFileName
TDeleteType aWhatToDelete

AlarmDeleteByCategory(TAlarmCategory, TDeleteType)

IMPORT_C TIntAlarmDeleteByCategory(TAlarmCategoryaCategory,
TDeleteTypeaWhatToDelete
)const

Parameters

TAlarmCategory aCategory
TDeleteType aWhatToDelete

AlarmNotificationCancelAndDequeue(TAlarmId)

IMPORT_C voidAlarmNotificationCancelAndDequeue(TAlarmIdaAlarmId)const

Parameters

TAlarmId aAlarmId

AlarmSoundsTemporarilySilenced()

IMPORT_C TBoolAlarmSoundsTemporarilySilenced()const

CancelAlarmSilence()

IMPORT_C TIntCancelAlarmSilence()const

Connect()

IMPORT_C TIntConnect()

DoAlarmAdd(TASShdAlarm &, const TDesC8 &)

TInt DoAlarmAdd(TASShdAlarm &aAlarm,
const TDesC8 &aData
)const [private]

Parameters

TASShdAlarm & aAlarm
const TDesC8 & aData

DoAlarmAddWithNotification(TRequestStatus &, TASShdAlarm &, const TDesC8 &)

voidDoAlarmAddWithNotification(TRequestStatus &aStatus,
TASShdAlarm &aAlarm,
const TDesC8 &aData
)[private]

Parameters

TRequestStatus & aStatus
TASShdAlarm & aAlarm
const TDesC8 & aData

FetchAlarmIdsFromBufferL(RArray< TAlarmId > &, TInt)

voidFetchAlarmIdsFromBufferL(RArray< TAlarmId > &aAlarmIds,
TIntaBufferSize
)const [private]

Parameters

RArray< TAlarmId > & aAlarmIds
TInt aBufferSize

FetchTransferBufferLC(TInt)

CBufBase *FetchTransferBufferLC(TIntaBufferSize)const [private]

Parameters

TInt aBufferSize

GetAlarmCategory(TAlarmId, TAlarmCategory &)

IMPORT_C TIntGetAlarmCategory(TAlarmIdaAlarmId,
TAlarmCategory &aCategory
)const

Parameters

TAlarmId aAlarmId
TAlarmCategory & aCategory

GetAlarmCharacteristics(TAlarmId, TAlarmCharacteristicsFlags &)

IMPORT_C TIntGetAlarmCharacteristics(TAlarmIdaAlarmId,
TAlarmCharacteristicsFlags &aCharacteristics
)const

Parameters

TAlarmId aAlarmId
TAlarmCharacteristicsFlags & aCharacteristics

GetAlarmCountForCategory(TAlarmCategory)

IMPORT_C TIntGetAlarmCountForCategory(TAlarmCategoryaCategory)const

Parameters

TAlarmCategory aCategory

GetAlarmData(TAlarmId, TDes8 &)

IMPORT_C TIntGetAlarmData(TAlarmIdaAlarmId,
TDes8 &aSink
)const

Parameters

TAlarmId aAlarmId
TDes8 & aSink

GetAlarmData(TAlarmId, HBufC8 *&)

IMPORT_C TIntGetAlarmData(TAlarmIdaAlarmId,
HBufC8 *&aSink
)const

Parameters

TAlarmId aAlarmId
HBufC8 *& aSink

GetAlarmDayOrTimed(TAlarmId, TAlarmDayOrTimed &)

IMPORT_C TIntGetAlarmDayOrTimed(TAlarmIdaAlarmId,
TAlarmDayOrTimed &aDayOrTimed
)const

Parameters

TAlarmId aAlarmId
TAlarmDayOrTimed & aDayOrTimed

GetAlarmDetails(TAlarmId, TASShdAlarm &)

IMPORT_C TIntGetAlarmDetails(TAlarmIdaAlarmId,
TASShdAlarm &aAlarm
)const

Parameters

TAlarmId aAlarmId
TASShdAlarm & aAlarm

GetAlarmIdListByStateL(TAlarmState, RArray< TAlarmId > &)

IMPORT_C voidGetAlarmIdListByStateL(TAlarmStateaState,
RArray< TAlarmId > &aAlarmIds
)const

Parameters

TAlarmState aState
RArray< TAlarmId > & aAlarmIds

GetAlarmIdListForCategoryL(TAlarmCategory, RArray< TAlarmId > &)

IMPORT_C voidGetAlarmIdListForCategoryL(TAlarmCategoryaCategory,
RArray< TAlarmId > &aAlarmIds
)const

Parameters

TAlarmCategory aCategory
RArray< TAlarmId > & aAlarmIds

GetAlarmIdListL(RArray< TAlarmId > &)

IMPORT_C voidGetAlarmIdListL(RArray< TAlarmId > &aAlarmIds)const

Parameters

RArray< TAlarmId > & aAlarmIds

GetAlarmOwner(TAlarmId, TFullName &)

IMPORT_C TIntGetAlarmOwner(TAlarmIdaAlarmId,
TFullName &aThreadName
)const

Parameters

TAlarmId aAlarmId
TFullName & aThreadName

GetAlarmPlayIntervalsL(CArrayFix< TASCliSoundPlayDefinition > &)

IMPORT_C voidGetAlarmPlayIntervalsL(CArrayFix< TASCliSoundPlayDefinition > &aIntervals)const

Parameters

CArrayFix< TASCliSoundPlayDefinition > & aIntervals

GetAlarmSoundState(TAlarmGlobalSoundState &)

IMPORT_C TIntGetAlarmSoundState(TAlarmGlobalSoundState &aState)const

Parameters

TAlarmGlobalSoundState & aState

GetAlarmSoundsSilentUntil(TTime &)

IMPORT_C TIntGetAlarmSoundsSilentUntil(TTime &aLocalTime)const

Parameters

TTime & aLocalTime

GetAlarmStatus(TAlarmId, TAlarmStatus &)

IMPORT_C TIntGetAlarmStatus(TAlarmIdaAlarmId,
TAlarmStatus &aStatus
)const

Parameters

TAlarmId aAlarmId
TAlarmStatus & aStatus

GetAvailableCategoryListL(RArray< TAlarmCategory > &)

IMPORT_C voidGetAvailableCategoryListL(RArray< TAlarmCategory > &aCategories)const

Parameters

RArray< TAlarmCategory > & aCategories

GetNextDueAlarmId(TAlarmId &)

IMPORT_C TIntGetNextDueAlarmId(TAlarmId &aAlarmId)const

Parameters

TAlarmId & aAlarmId

NotifyChange(TRequestStatus &, TAlarmId &)

IMPORT_C voidNotifyChange(TRequestStatus &aStatus,
TAlarmId &aAlarmId
)

Parameters

TRequestStatus & aStatus
TAlarmId & aAlarmId

NotifyChangeCancel()

IMPORT_C voidNotifyChangeCancel()const

NumberOfAlarmsActiveInQueue()

IMPORT_C TIntNumberOfAlarmsActiveInQueue()const

SetAlarmCharacteristics(TAlarmId, TAlarmCharacteristicsFlags)

IMPORT_C TIntSetAlarmCharacteristics(TAlarmIdaAlarmId,
TAlarmCharacteristicsFlagsaCharacteristics
)const

Parameters

TAlarmId aAlarmId
TAlarmCharacteristicsFlags aCharacteristics

SetAlarmDayOrTimed(TAlarmId, TAlarmDayOrTimed)

IMPORT_C TIntSetAlarmDayOrTimed(TAlarmIdaAlarmId,
TAlarmDayOrTimedaDayOrTimed
)const

Parameters

TAlarmId aAlarmId
TAlarmDayOrTimed aDayOrTimed

SetAlarmPlayIntervalsL(const CArrayFix< TASCliSoundPlayDefinition > &)

IMPORT_C voidSetAlarmPlayIntervalsL(const CArrayFix< TASCliSoundPlayDefinition > &aIntervals)const

Parameters

const CArrayFix< TASCliSoundPlayDefinition > & aIntervals

SetAlarmSoundState(TAlarmGlobalSoundState)

IMPORT_C TIntSetAlarmSoundState(TAlarmGlobalSoundStateaState)const

Parameters

TAlarmGlobalSoundState aState

SetAlarmSoundsSilentFor(TTimeIntervalMinutes)

IMPORT_C TIntSetAlarmSoundsSilentFor(TTimeIntervalMinutesaTimeToRemainSilentFor)const

Parameters

TTimeIntervalMinutes aTimeToRemainSilentFor

SetAlarmSoundsSilentUntil(const TTime &)

IMPORT_C TIntSetAlarmSoundsSilentUntil(const TTime &aLocalTime)const

Parameters

const TTime & aLocalTime

SetAlarmStatus(TAlarmId, TAlarmStatus)

IMPORT_C TIntSetAlarmStatus(TAlarmIdaAlarmId,
TAlarmStatusaStatus
)const

Parameters

TAlarmId aAlarmId
TAlarmStatus aStatus

SetAlarmStatusByCategory(TAlarmCategory, TAlarmStatus)

IMPORT_C TIntSetAlarmStatusByCategory(TAlarmCategoryaCategory,
TAlarmStatusaStatus
)const

Parameters

TAlarmCategory aCategory
TAlarmStatus aStatus

SetAlarmStatusForCalendarFile(const TDesC &, TAlarmStatus)

IMPORT_C TIntSetAlarmStatusForCalendarFile(const TDesC &aFileName,
TAlarmStatusaStatus
)const

Parameters

const TDesC & aFileName
TAlarmStatus aStatus

SetClientData(const TASShdAlarm &)

IMPORT_C TIntSetClientData(const TASShdAlarm &aAlarm)

Parameters

const TASShdAlarm & aAlarm

Version()

IMPORT_C TVersionVersion()const

__DbgFailAlloc(TInt)

IMPORT_C void__DbgFailAlloc(TIntaCount)const

Parameters

TInt aCount

__DbgPreventUserNotify(TBool)

IMPORT_C void__DbgPreventUserNotify(TBoolaShouldStop)const

Parameters

TBool aShouldStop

__DbgSetEnvChgHandling(TBool)

IMPORT_C TInt__DbgSetEnvChgHandling(TBoolaFlag)const

Parameters

TBool aFlag

__DbgShutDownServer()

IMPORT_C void__DbgShutDownServer()const

__DbgSnoozeAlarm(TAlarmId, const TTime &)

IMPORT_C TInt__DbgSnoozeAlarm(TAlarmIdaAlarmId,
const TTime &aNewTime
)const

Parameters

TAlarmId aAlarmId
const TTime & aNewTime

Member Data Documentation

TPtr8 iAlarmIdPointer

TPtr8 iAlarmIdPointer[private]

TPtr8 iPackage

TPtr8 iPackage[private]
© Nokia 2010.