Class CCalSession

class CCalSession : public CBase;

Description

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.

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CCalSession - A handle to the calendar file.

Members

Defined in CCalSession:

• CreateCalFileL(const TDesC &)constCreates a new calendar file. ...
• CreateCalFileL(const TDesC &)const
• DefaultFileNameL()constGets the name of the default calendar file held by the server.
• DefaultFileNameL()const
• DeleteCalFileL(const TDesC &)constDeletes a calendar file with the supplied filename.
• DeleteCalFileL(const TDesC &)const
• DisableChangeBroadcast()Disable all notifications from changes made within this session. Changes made wi...
• DisableChangeBroadcast()
• DisablePubSubNotificationsL()Disable Publish and Subscribe notifications for changes made by this client only...
• DisablePubSubNotificationsL()
• EnableChangeBroadcast()Re-enable all notifications from changes made within this session. This function...
• EnableChangeBroadcast()
• EnablePubSubNotificationsL()Enable Publish and Subscribe notifications for changes made by this client only....
• EnablePubSubNotificationsL()
• FileIdL(TCalFileId &)constGets the file ID of the currently open Calendar file. This is unique to the file...
• FileIdL(TCalFileId &)const
• GetFileNameL(TCalPubSubData,TDes &)constRetrieve a calendar file name from its hash value. The hash value comes from the...
• GetFileNameL(TCalPubSubData,TDes &)const
• IsFileNameL(TCalPubSubData,const TDesC &)constTest if the full file name passed is the one that was changed.
• IsFileNameL(TCalPubSubData,const TDesC &)const
• IsOpenedFileL(TCalPubSubData)constTest if the publish and subscribe data relates to the currently open calendar fi...
• IsOpenedFileL(TCalPubSubData)const
• ListCalFilesL()constGets a list of all calendar files held by the server. The caller takes ownership...
• ListCalFilesL()const
• NewL()Allocates and constructs a session to the Calendar server.
• NewL()
• OpenL(const TDesC &)constOpens an calendar file using the server.
• OpenL(const TDesC &)const
• StartChangeNotification(MCalChangeCallBack2 &,const CCalChangeNotificationFilter &)Start notification of any changes to calendar entries. These changes can be filt...
• StartChangeNotification(MCalChangeCallBack2 &,const CCalChangeNotificationFilter &)
• StopChangeNotification()Stop all notifications from this session.
• StopChangeNotification()
• ~CCalSession()Destructor for the session. Clear away any resources.
• ~CCalSession()

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Related Topics

 » Symbian OS v9.4 » Examples » Application Engines example code » CalinterimAPI: Using Calendar API

• CalInterimAPI: Using the Calendar API » Class Summary

IMPORT_C static CCalSession* NewL();

Description

Allocates and constructs a session to the Calendar server.

Return value

IMPORT_C ~CCalSession();

Description

Destructor for the session. Clear away any resources.

IMPORT_C static CCalSession* NewL();

Description

Return value

IMPORT_C ~CCalSession();

Description

IMPORT_C void CreateCalFileL(const TDesC &aFileName) const;

Description

Creates a new calendar file. It leaves if the file with the name specified already exists.

Parameters

IMPORT_C void OpenL(const TDesC &aFileName) const;

Description

Opens an calendar file using the server.

If another agenda file is open in the same server session, it is closed.

Parameters

Leave codes

IMPORT_C const TDesC& DefaultFileNameL() const;

Description

Gets the name of the default calendar file held by the server.

Return value

IMPORT_C void DeleteCalFileL(const TDesC &aFileName) const;

Description

Deletes a calendar file with the supplied filename.

If the file is opened, it will be closed first

Parameters

Leave codes

IMPORT_C CDesCArray* ListCalFilesL() const;

Description

Gets a list of all calendar files held by the server. The caller takes ownership of the returned descriptor array. Note that:

• The calendar files can be stored on any drive.

• Since the directories are not seen by clients, the filenames returned are a combination of drive letter and file name, in other words DriveLetter:FileName

• The files are ordered alphabetically by drive letter. Files on the same drive are ordered by filename, for instance a:agenda, c:agenda, c:calendar, d:agenda, d:calendar.

Return value

IMPORT_C void StartChangeNotification(MCalChangeCallBack2 &aCallBack, const CCalChangeNotificationFilter &aFilter);

Description

Start notification of any changes to calendar entries. These changes can be filtered, and when a change occurs the MCalChangeCallBack2 callback function is called with details about the entry which has changed (TCalLocalUid and entry type) and the type of change (add/delete/modify).

Parameters

IMPORT_C void CreateCalFileL(const TDesC &aFileName) const;

Description

Parameters

IMPORT_C void StopChangeNotification();

Description

Stop all notifications from this session.

IMPORT_C void OpenL(const TDesC &aFileName) const;

Description

Parameters

IMPORT_C void DisableChangeBroadcast();

Description

Disable all notifications from changes made within this session. Changes made within other sessions will still be notified. This can be done before a bulk operation, to prevent a large number of notifications from appearing. Note that this call does not disable publish and subscribe notifications. That must be done from DisablePubSubNotificationsL.

IMPORT_C void EnableChangeBroadcast();

Description

Re-enable all notifications from changes made within this session. This function has the opposite effect of DisableChangeBroadcast.

IMPORT_C const TDesC& DefaultFileNameL() const;

Description

Return value

IMPORT_C void DeleteCalFileL(const TDesC &aFileName) const;

Description

Parameters

IMPORT_C CDesCArray* ListCalFilesL() const;

Description

Return value

IMPORT_C void StartChangeNotification(MCalChangeCallBack2 &aCallBack, const CCalChangeNotificationFilter &aFilter);

Description

Parameters

IMPORT_C void EnablePubSubNotificationsL();

Description

Enable Publish and Subscribe notifications for changes made by this client only.

IMPORT_C void StopChangeNotification();

Description

IMPORT_C void DisablePubSubNotificationsL();

Description

Disable Publish and Subscribe notifications for changes made by this client only.

IMPORT_C void DisableChangeBroadcast();

Description

IMPORT_C void EnableChangeBroadcast();

Description

IMPORT_C void FileIdL(TCalFileId &aCalFileId) const;

Description

Gets the file ID of the currently open Calendar file. This is unique to the file.

Parameters

IMPORT_C void GetFileNameL(TCalPubSubData aPubSubData, TDes &aFileName) const;

Description

Retrieve a calendar file name from its hash value. The hash value comes from the Publish and Subscribe CalInterimAPI data in TCalPubSubData.

Parameters

IMPORT_C void EnablePubSubNotificationsL();

Description

IMPORT_C TBool IsFileNameL(TCalPubSubData aPubSubData, const TDesC &aFileName) const;

Description

Test if the full file name passed is the one that was changed.

Parameters

Return value

IMPORT_C void DisablePubSubNotificationsL();

Description

IMPORT_C TBool IsOpenedFileL(TCalPubSubData aPubSubData) const;

Description

Test if the publish and subscribe data relates to the currently open calendar file.

Parameters

Return value

IMPORT_C void FileIdL(TCalFileId &aCalFileId) const;

Description

Parameters

IMPORT_C void GetFileNameL(TCalPubSubData aPubSubData, TDes &aFileName) const;

Description

Parameters

IMPORT_C void StartChangeNotification(MCalChangeCallBack *aCallBack, MCalChangeCallBack::TChangeEntryType aChangeEntryType, TBool aIncludeUndatedTodos, TTime aFilterStartTime, TTime aFilterEndTime);

Description

Start notification of any changes to calendar entries. These changes can be filtered, and when a change occurs the MCalChangeCallBack callback function is called with the type of entry which has changed (event or todo).

Parameters

IMPORT_C TBool IsFileNameL(TCalPubSubData aPubSubData, const TDesC &aFileName) const;

Description

Parameters

Return value

IMPORT_C TBool IsOpenedFileL(TCalPubSubData aPubSubData) const;

Description

Parameters

Return value

IMPORT_C void StartChangeNotification(MCalChangeCallBack *aCallBack, MCalChangeCallBack::TChangeEntryType aChangeEntryType, TBool aIncludeUndatedTodos, TTime aFilterStartTime, TTime aFilterEndTime);

Description

Parameters