Class CCalEntryView

class CCalEntryView : public CBase;

Description

View class for accessing calendar entries.

Once a session to a calendar file has been created, a view to the session can be created.

This view can be used to fetch, store and delete entries.

Derivation

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

• CCalEntryView - View class for accessing calendar entries

Members

Defined in CCalEntryView:
DeleteL(), DeleteL(), DeleteL(), DeleteL(), FetchL(), FetchL(), GetIdsModifiedSinceDateL(), NewL(), StoreL(), UpdateL(), ~CCalEntryView()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also

• Class Summary

Capability:

Illegal

static IMPORT_C CCalEntryView *NewL(CCalSession &aSession, MCalProgressCallBack &aProgressCallBack);

Description

Allocates and constructs an entry view, with a reference to a state callback object.

Parameters

CCalSession &aSession The handle to the calendar session. MCalProgressCallBack &aProgressCallBack Provides a callback function which notifies the user when the index has been built.

Return value

CCalEntryView * A pointer to the new entry view object.

Capability:

Illegal

IMPORT_C ~CCalEntryView();

Description

The destructor frees all resources owned by the entry view, prior to its destruction. It cancels any active asynchronous operation, providing notification by calling Completed() function with the value KErrCancel on progress callback object. Note: Progress callback object must not be deleted before the entry view is destroyed, otherwise a panic will occur.

Capability:

ReadUserData

IMPORT_C void FetchL(const TDesC8 &aUid, RPointerArray< CCalEntry > &aCalEntryArray) const;

Description

Fetches all CCalEntry objects related to the Uid. The first entry in the array will always be the parent entry. see CCalEntry for definition of parent entry.

Parameters

const TDesC8 &aUid The Uid of the entries to fetch. RPointerArray< CCalEntry > &aCalEntryArray On return, this contains an array of related CCalEntry objects.

See also:

• CCalEntry

Capability:

ReadUserData

IMPORT_C CCalEntry *FetchL(TCalLocalUid aId) const;

Description

Fetches a CCalEntry object related to the cal unique id.

Parameters

TCalLocalUid aId

Return value

CCalEntry * The entry that has been fetched, this will be NULL if there are no entries with the cal unique id

Capability:

ReadUserData

IMPORT_C void GetIdsModifiedSinceDateL(const TCalTime &aTime, RArray< TCalLocalUid > &aIds) const;

Description

Gets all the modified calendar local ids in the file since a specified date

Parameters

const TCalTime &aTime The time to get the ids since. RArray< TCalLocalUid > &aIds

Capability:

WriteUserData

IMPORT_C void StoreL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Stores entries in the calendar file.

Parameters

const RPointerArray< CCalEntry > &aCalEntryList The list of entries to be stored. TInt &aNumSuccessfulEntry On return, this contains the number of entries which were successfully stored.

Capability:

WriteUserData

IMPORT_C void UpdateL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Updates entries in the calendar file.

Parameters

const RPointerArray< CCalEntry > &aCalEntryList The list of entries to be updated. TInt &aNumSuccessfulEntry On return, this contains the number of entries which were successfully updated.

Leave codes

KErrArgument If aCalEntryList contains a CCalEntry that is not the parent. see CCalEntry for definition of a parent entry

See also:

• CCalEntry

Capability:

WriteUserData

IMPORT_C void DeleteL(const CDesC8Array &aUidList);

Description

Deletes multiple entries from the calendar file.

Parameters

const CDesC8Array &aUidList A list of UIDs to delete.

Capability:

WriteUserData

IMPORT_C void DeleteL(const CCalEntry &aCalEntry);

Description

Deletes an entry from the calender file. If this a parent entry all it's children will also be deleted. see CCalEntry for definition of parent entry.

Parameters

const CCalEntry &aCalEntry The entry to delete.

See also:

• CCalEntry

IMPORT_C void DeleteL(const CalCommon::TCalTimeRange &aCalTimeRange, CalCommon::TCalViewFilter aFilter, MCalProgressCallBack &aProgressCallBack);

Description

Deletes a subset of the model's entries. The entries affected are those which occur within the time range specified by aCalTimeRange.

This method will lock the calendar file. Any request made, by any client, before this has completed will leave with KErrLocked.

Parameters

const CalCommon::TCalTimeRange &aCalTimeRange The Time Range for the operation. CalCommon::TCalViewFilter aFilter Identifies which entry types should be included in the operation. MCalProgressCallBack &aProgressCallBack Reference to a callback object which reports the progress of the operation.

Capability:

WriteUserData

IMPORT_C void DeleteL(const RArray< TCalLocalUid > &aIds, TInt &aNumSuccessfulDeleted);

Description

Deletes multiple entries from the calendar file.

Parameters

const RArray< TCalLocalUid > &aIds TInt &aNumSuccessfulDeleted The number of local ids that have been successfully processed.