CCalSession Class Reference

class CCalSession : public CBase

A handle to the calendar file.

When the client instantiates a CCalSession, it will connect to the calendar server. In turn, the client can use its APIs, for instance to create or open a calendar file.

The agenda data in the file can be accessed as entries. To access the entries, clients should use class CCalEntryView or CCalInstanceView to process the entry data. However, both view classes require the handle to the file which is represented by this class.

A calendar file can be opened on any writable drive. Note that if the file is opened on a removable media and that media is removed, operations will leave with KErrNotReady. This error can also happen when trying to access file attachments on removed media. When this error occurs, the user should close the CCalSession and re-open it once the media has been replaced. It is recommended that when using a calendar file on removable media, the user should watch for when the media is removed / replaced using the RFs::NotifyChange API.

The session object must not be destroyed until all the objects which where created by referencing it have been destroyed.

Inherits from

Public Member Functions
~CCalSession()
IMPORT_C CCalCalendarInfo *CalendarInfoL()
IMPORT_C TCalCollectionIdCollectionIdL()
IMPORT_C voidCreateCalFileL(const TDesC &)
IMPORT_C voidCreateCalFileL(const TDesC &, const CCalCalendarInfo &)
IMPORT_C const TDesC &DefaultFileNameL()
IMPORT_C voidDeleteCalFileL(const TDesC &)
IMPORT_C voidDisableChangeBroadcast()
IMPORT_C voidDisablePubSubNotificationsL()
IMPORT_C voidEnableChangeBroadcast()
IMPORT_C voidEnablePubSubNotificationsL()
IMPORT_C voidFileIdL(TCalFileId &)
IMPORT_C voidGetFileNameL(TCalPubSubData, TDes &)
CCalSessionImpl &Impl()
IMPORT_C TBoolIsFileNameL(TCalPubSubData, const TDesC &)
IMPORT_C TBoolIsOpenedFileL(TCalPubSubData)
IMPORT_C CDesCArray *ListCalFilesL()
IMPORT_C CCalSession *NewL()
IMPORT_C CCalSession *NewL(CCalSession &)
IMPORT_C voidOpenL(const TDesC &)
IMPORT_C voidOpenL(const TDesC &, CalCommon::TCalFileVersionSupport &)
IMPORT_C voidSetCalendarInfoL(const CCalCalendarInfo &)
IMPORT_C voidStartChangeNotification(MCalChangeCallBack2 &, const CCalChangeNotificationFilter &)
IMPORT_C voidStartChangeNotification(MCalChangeCallBack *, MCalChangeCallBack::TChangeEntryType, TBool, TTime, TTime)
IMPORT_C voidStartFileChangeNotificationL(MCalFileChangeObserver &)
IMPORT_C voidStopChangeNotification()
IMPORT_C voidStopFileChangeNotification()
IMPORT_C TInt_DebugRequestAllocatedCellsL()
IMPORT_C TInt_DebugRequestAllocatedHeapSizeL()
IMPORT_C void_DebugSetHeapFailL(RAllocator::TAllocFail, TInt)
IMPORT_C void__dbgClearTzClientCacheL(TBool)
Private Member Functions
CCalSession()
voidConstructL()
voidConstructL(CCalSession &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CCalSessionImpl *iImpl

Constructor & Destructor Documentation

CCalSession()

CCalSession()[private]

~CCalSession()

IMPORT_C~CCalSession()

Member Functions Documentation

CalendarInfoL()

IMPORT_C CCalCalendarInfo *CalendarInfoL()const

CollectionIdL()

IMPORT_C TCalCollectionIdCollectionIdL()const

ConstructL()

voidConstructL()[private]

ConstructL(CCalSession &)

voidConstructL(CCalSession &aCalSession)[private]

Parameters

CCalSession & aCalSession

CreateCalFileL(const TDesC &)

IMPORT_C voidCreateCalFileL(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

CreateCalFileL(const TDesC &, const CCalCalendarInfo &)

IMPORT_C voidCreateCalFileL(const TDesC &aFileName,
const CCalCalendarInfo &aCalendarInfo
)const

Parameters

const TDesC & aFileName
const CCalCalendarInfo & aCalendarInfo

DefaultFileNameL()

IMPORT_C const TDesC &DefaultFileNameL()const

DeleteCalFileL(const TDesC &)

IMPORT_C voidDeleteCalFileL(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

DisableChangeBroadcast()

IMPORT_C voidDisableChangeBroadcast()

DisablePubSubNotificationsL()

IMPORT_C voidDisablePubSubNotificationsL()

EnableChangeBroadcast()

IMPORT_C voidEnableChangeBroadcast()

EnablePubSubNotificationsL()

IMPORT_C voidEnablePubSubNotificationsL()

FileIdL(TCalFileId &)

IMPORT_C voidFileIdL(TCalFileId &aCalFileId)const

Parameters

TCalFileId & aCalFileId

GetFileNameL(TCalPubSubData, TDes &)

IMPORT_C voidGetFileNameL(TCalPubSubDataaPubSubData,
TDes &aFileName
)const

Parameters

TCalPubSubData aPubSubData
TDes & aFileName

Impl()

CCalSessionImpl &Impl()const

IsFileNameL(TCalPubSubData, const TDesC &)

IMPORT_C TBoolIsFileNameL(TCalPubSubDataaPubSubData,
const TDesC &aFileName
)const

Parameters

TCalPubSubData aPubSubData
const TDesC & aFileName

IsOpenedFileL(TCalPubSubData)

IMPORT_C TBoolIsOpenedFileL(TCalPubSubDataaPubSubData)const

Parameters

TCalPubSubData aPubSubData

ListCalFilesL()

IMPORT_C CDesCArray *ListCalFilesL()const

NewL()

IMPORT_C CCalSession *NewL()[static]

NewL(CCalSession &)

IMPORT_C CCalSession *NewL(CCalSession &aCalSession)[static]

Parameters

CCalSession & aCalSession

OpenL(const TDesC &)

IMPORT_C voidOpenL(const TDesC &aFileName)const

Parameters

const TDesC & aFileName

OpenL(const TDesC &, CalCommon::TCalFileVersionSupport &)

IMPORT_C voidOpenL(const TDesC &aFileName,
CalCommon::TCalFileVersionSupport &aFileSupportStatus
)const

Parameters

const TDesC & aFileName
CalCommon::TCalFileVersionSupport & aFileSupportStatus

SetCalendarInfoL(const CCalCalendarInfo &)

IMPORT_C voidSetCalendarInfoL(const CCalCalendarInfo &aCalendarInfo)const

Parameters

const CCalCalendarInfo & aCalendarInfo

StartChangeNotification(MCalChangeCallBack2 &, const CCalChangeNotificationFilter &)

IMPORT_C voidStartChangeNotification(MCalChangeCallBack2 &aCallBack,
const CCalChangeNotificationFilter &aFilter
)

Parameters

MCalChangeCallBack2 & aCallBack
const CCalChangeNotificationFilter & aFilter

StartChangeNotification(MCalChangeCallBack *, MCalChangeCallBack::TChangeEntryType, TBool, TTime, TTime)

IMPORT_C voidStartChangeNotification(MCalChangeCallBack *aCallBack,
MCalChangeCallBack::TChangeEntryTypeaChangeEntryType,
TBoolaIncludeUndatedTodos,
TTimeaFilterStartTime,
TTimeaFilterEndTime
)

Parameters

MCalChangeCallBack * aCallBack
MCalChangeCallBack::TChangeEntryType aChangeEntryType
TBool aIncludeUndatedTodos
TTime aFilterStartTime
TTime aFilterEndTime

StartFileChangeNotificationL(MCalFileChangeObserver &)

IMPORT_C voidStartFileChangeNotificationL(MCalFileChangeObserver &aCallBack)

Parameters

MCalFileChangeObserver & aCallBack

StopChangeNotification()

IMPORT_C voidStopChangeNotification()

StopFileChangeNotification()

IMPORT_C voidStopFileChangeNotification()

_DebugRequestAllocatedCellsL()

IMPORT_C TInt_DebugRequestAllocatedCellsL()

_DebugRequestAllocatedHeapSizeL()

IMPORT_C TInt_DebugRequestAllocatedHeapSizeL()

_DebugSetHeapFailL(RAllocator::TAllocFail, TInt)

IMPORT_C void_DebugSetHeapFailL(RAllocator::TAllocFailaFail,
TIntaRate
)

Parameters

RAllocator::TAllocFail aFail
TInt aRate

__dbgClearTzClientCacheL(TBool)

IMPORT_C void__dbgClearTzClientCacheL(TBoolaRestartCaching)

Parameters

TBool aRestartCaching

Member Data Documentation

CCalSessionImpl * iImpl

CCalSessionImpl *iImpl[private]
© Nokia 2010.