Class CCalEntry

class CCalEntry : public CBase;

Description

Class representing a calendar entry. This can be an appointment, to-do item, reminder, event or anniversary.

CCalEntry contains information about a calendar entry, including a repeat definition, synchronisation information, and group scheduling data.

A repeating calendar entry has more than one occurrence. Instances are represented by the CCalInstance class.

Synchronisation information includes a record of the date/time the entry was last modified. This can be found by calling the LastModifiedDateL() function.

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CCalEntry - Class representing a calendar entry

Members

Defined in CCalEntry:
AddAttendeeL(), AddCategoryL(), AlarmL(), AttendeesL(), CategoryListL(), ClearRepeatingPropertiesL(), CompareL(), CompletedTimeL(), CopyFromL(), CopyFromL(), DTStampL(), DeleteAttendeeL(), DeleteCategoryL(), DescriptionL(), EAnniv, EAppt, ECancelled, EConfirmed, EEvent, EMethodAdd, EMethodCancel, EMethodCounter, EMethodDeclineCounter, EMethodNone, EMethodPublish, EMethodRefresh, EMethodReply, EMethodRequest, ENullStatus, EOpen, EPrivate, EReminder, ERestricted, ETentative, ETodo, ETodoCompleted, ETodoInProcess, ETodoNeedsAction, EndTimeL(), EntryTypeL(), GetExceptionDatesL(), GetRDatesL(), GetRRuleL(), LastModifiedDateL(), LocalUidL(), LocationL(), MethodL(), NewL(), NewL(), OrganizerL(), PhoneOwnerL(), PriorityL(), RecurrenceIdL(), RecurrenceRangeL(), ReplicationStatusL(), SequenceNumberL(), SetAlarmL(), SetCompletedL(), SetDTStampL(), SetDescriptionL(), SetExceptionDatesL(), SetLastModifiedDateL(), SetLocalUidL(), SetLocationL(), SetMethodL(), SetOrganizerL(), SetPhoneOwnerL(), SetPriorityL(), SetRDatesL(), SetRRuleL(), SetReplicationStatusL(), SetSequenceNumberL(), SetStartAndEndTimeL(), SetStatusL(), SetSummaryL(), SetTzRulesL(), SetTzRulesL(), StartTimeL(), StatusL(), SummaryL(), TMethod, TReplicationStatus, TStatus, TType, TzRulesL(), UidL(), ~CCalEntry()

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

static IMPORT_C CCalEntry *NewL(TType aType, HBufC8 *aUid, TMethod aMethod, TUint aSeqNum);

Description

Allocates and constructs a new entry of the specified type, Global UID and sequence number.

The entry's data is all initialised to default values, e.g. the start and end dates are reset to null.

The entry takes ownership of the Uid descriptor.

Note that this function will not work unless a CCalSession has been created by calling CCalSession::NewL().

Parameters

Return value

static IMPORT_C CCalEntry *NewL(TType aType, HBufC8 *aUid, TMethod aMethod, TUint aSeqNum, const TCalTime &aRecurrenceId, CalCommon::TRecurrenceRange aRange);

Description

Allocates and constructs a new entry of the specified type, Global UID, sequence number and recurrence ID.

The entry takes ownership of the Uid descriptor.

Parameters

Return value

Leave codes

Panic codes

IMPORT_C ~CCalEntry();

Description

The destructor frees all resources owned by the entry, prior to its destruction.

IMPORT_C TCalTime StartTimeL() const;

Description

Gets the start date/time for an entry.

Return value

IMPORT_C TCalTime EndTimeL() const;

Description

Gets the entry's end date/time.

Return value

IMPORT_C void SetStartAndEndTimeL(const TCalTime &aStartTime, const TCalTime &aEndTime);

Description

Sets the start and end date/times for an entry.

For a reminder, the end date will be ignored. For a to-do entry, the end date is the 'due date'. The time portion of the start date will not be stored for todos, only the number of days until the due date. Only Undated Todo's can have both start and end date as NullTime.

This function adjusts the start time of the repeat rule to the first instance. For EAppt, EEvent, EReminder, EAnniv this function also aligns the start date of the entry with that of the repeat rule. For ETodo, the start date of the entry is the start date of the first instance, and this is different from the instance date.

Parameters

Leave codes

IMPORT_C void SetLastModifiedDateL();

Description

Sets the entry's last modified date to the current time.

IMPORT_C TCalTime LastModifiedDateL() const;

Description

Gets the entry's last changed date/time.

Return value

IMPORT_C void SetDTStampL(const TCalTime &aTime);

Description

Sets the entry's DTSTAMP to the time specified.

This method may be called by clients to record the date/time that the entry was prepared for sending to a recipient as a scheduling object, as specified in RFC 2445, the Internet Calendaring and Scheduling Core Object Specification (iCalendar).

Parameters

IMPORT_C TCalTime DTStampL() const;

Description

Gets the entry's DTSTAMP.

Return value

IMPORT_C TCalTime CompletedTimeL() const;

Description

Gets a to-do entry's completed date.

This is the date on which the required action was carried out. If the entry has not been crossed out, or if this is not a to-do entry, then this function returns a null value.

Return value

IMPORT_C void SetCompletedL(TBool aCompleted, const TCalTime &aTime);

Description

Sets the crossed out date for a to-do entry. This is the date on which the required action was carried out.

If this function is called on an entry which is not a to-do, it will leave with KErrNotSupported.

Parameters

IMPORT_C void SetRRuleL(const TCalRRule &aRule);

Description

Sets the entry's repeat definition.

The repeat definition includes daily, weekly, monthly and yearly repeat details, and start and end details.

This function adjusts the start time of the repeat rule to the first instance. For EAppt, EEvent, EReminder, EAnniv this function also aligns the start date of the entry with that of the repeat rule. for ETodo, the start date of the entry is the start date of the first instance, and this is different from the instance date.

This does not take ownership of the parameter.

Parameters

Leave codes

IMPORT_C TBool GetRRuleL(TCalRRule &aRule) const;

Description

Get the entry's repeat rule.

In the returned TCalRRule, both the Count and the Until values can be accessed. However, in the case of a repeat rule which repeats forever, the Count will always be returned as 0.

Parameters

Return value

IMPORT_C void SetRDatesL(const RArray< TCalTime > &aRDateList);

Description

Replaces this group scheduling entry's list of RDATEs.

Parameters

Leave codes

IMPORT_C void GetRDatesL(RArray< TCalTime > &aRDateList) const;

Description

Gets a list of all RDATEs in this group scheduling entry.

Parameters

IMPORT_C void SetExceptionDatesL(const RArray< TCalTime > &aExDateList);

Description

Adds the given exception dates to this group scheduling entry.

Parameters

Leave codes

IMPORT_C void GetExceptionDatesL(RArray< TCalTime > &aExDateList) const;

Description

Gets a list of all exception dates on this group scheduling entry.

Parameters

IMPORT_C void ClearRepeatingPropertiesL();

Description

Clears the repeat details including exceptions and unsets the entry's 'is repeating' property.

IMPORT_C void SetAlarmL(CCalAlarm *aAlarm);

Description

Set the alarm for the entry.

This doesn't take ownership of the parameter.

Parameters

IMPORT_C CCalAlarm *AlarmL() const;

Description

Creates an alarm class containing data for this entry's alarm.

Return value

IMPORT_C TBool CompareL(const CCalEntry &aEntry) const;

Description

Compares another entry for equality with this one.

Parameters

Return value

IMPORT_C void CopyFromL(const CCalEntry &aOther);

Description

Copies the contents of another entry to this one. All entry fields will be overwritten, including the UID and the local UID. This is identical to calling CopyFromL(aOther, ECopyAll).

Parameters

Panic codes

IMPORT_C void CopyFromL(const CCalEntry &aOther, TCopyType aCopyType);

Description

Copies the contents of another entry to this one. The entry fields that are copied can be specified using the TCopyType parameter.

Parameters

Panic codes

IMPORT_C void SetSummaryL(const TDesC &aSummary);

Description

Sets the summary text for this entry.

Parameters

Leave codes

IMPORT_C const TDesC &SummaryL() const;

Description

Gets the summary for the entry.

Return value

Leave codes

IMPORT_C void SetDescriptionL(const TDesC &aDescription);

Description

Sets the description text for this entry.

Parameters

IMPORT_C const TDesC &DescriptionL() const;

Description

Gets the description text for the entry.

Return value

IMPORT_C void SetLocationL(const TDesC &aLocation);

Description

Sets the contents of the entry's location field.

Parameters

IMPORT_C const TDesC &LocationL() const;

Description

Gets the contents of the entry's location field.

Return value

IMPORT_C void AddCategoryL(CCalCategory *aCategory);

Description

Appends a category to the entry's list of categories.

The entry takes ownership of the category specified.

Parameters

IMPORT_C void DeleteCategoryL(TInt aIndex);

Description

Deletes a category from the entry's list of categories.

Parameters

IMPORT_C const RPointerArray< CCalCategory > &CategoryListL();

Description

Gets a list of the entry's categories.

Return value

IMPORT_C void AddAttendeeL(CCalAttendee *aAttendee);

Description

Adds an attendee for this entry.

Parameters

IMPORT_C void DeleteAttendeeL(TInt aIndex);

Description

Deletes an attendee from this entry.

Parameters

Leave codes

IMPORT_C RPointerArray< CCalAttendee > &AttendeesL() const;

Description

Gets the attendees for this entry.

Return value

IMPORT_C void SetOrganizerL(CCalUser *aUser);

Description

Sets the organizer for this entry.

Parameters

IMPORT_C CCalUser *OrganizerL() const;

Description

Gets the organizer for this entry. This function creates a new CCalUser object containing the organizer data.

Return value

IMPORT_C void SetPhoneOwnerL(const CCalUser *aOwner);

Description

Sets the phone owner for this entry.

Parameters

IMPORT_C CCalUser *PhoneOwnerL() const;

Description

Gets the phone owner for this entry. This function creates a new CCalUser object containing the phone owner data.

Return value

IMPORT_C TType EntryTypeL() const;

Description

Gets the type of entry.

Return value

IMPORT_C void SetStatusL(TStatus aStatus);

Description

Sets the entry status.

For a to-do entry, this is one of: ECancelled, ETodoNeedsAction, ETodoCompleted, ETodoInProgress.

For any other entry types, this is one of: ECancelled, ETentative, EConfirmed.

Passing a value in which does not match the entry type will result in a panic.

Parameters

Leave codes

IMPORT_C TStatus StatusL() const;

Description

Gets the entry status.

For a to-do entry, this is one of: ECancelled, ETodoNeedsAction, ETodoCompleted, ETodoInProgress.

For any other entry types, this is one of: ECancelled, ETentative, EConfirmed.

Return value

Panic codes

IMPORT_C void SetReplicationStatusL(TReplicationStatus aReplicationStatus);

Description

Sets the entry replication status.

Parameters

IMPORT_C TReplicationStatus ReplicationStatusL() const;

Description

Gets the entry replication status.

This is defined by TReplicationStatus. Default is TReplicationStatus::EOpen

Return value

IMPORT_C void SetPriorityL(TUint aPriority);

Description

Sets the priority for the entry.

The default value is zero.

Parameters

IMPORT_C TUint PriorityL() const;

Description

Gets the priority of the entry.

Return value

IMPORT_C void SetMethodL(TMethod aMethod);

Description

Sets the entry's method property for group scheduling.

Parameters

IMPORT_C TMethod MethodL() const;

Description

Returns the entry's method property for group scheduling.

Return value

IMPORT_C void SetSequenceNumberL(TInt aSeq);

Description

Sets the entry's sequence number for group scheduling.

Parameters

IMPORT_C TInt SequenceNumberL() const;

Description

Returns the entry's sequence number for group scheduling.

Return value

IMPORT_C const TDesC8 &UidL() const;

Description

Returns the entry's Global UID for group scheduling.

Return value

IMPORT_C TCalTime RecurrenceIdL() const;

Description

Returns the entry's recurrence ID for group scheduling.

Return value

IMPORT_C CalCommon::TRecurrenceRange RecurrenceRangeL() const;

Description

Returns the recurrence range for the entry's recurrence ID.

Return value

IMPORT_C CTzRules *TzRulesL() const;

Description

Gets the timezone rules for this entry's repeat rule.

Return value

IMPORT_C void SetTzRulesL(const CTzRules &aTzRule);

Description

Sets the timezone rules for this entry's repeat rule.

If editing the repeat rule time zone rules of a previously stored entry, the repeat rule must be set again prior to setting its new time zone rules.

Parameters

Leave codes

IMPORT_C void SetTzRulesL();

Description

Creates the timezone rules for this entry's repeat rule from the local time zone settings.

Leave codes

IMPORT_C void SetLocalUidL(TCalLocalUid aLocalId);

Description

Sets the calendar local id for this entry. This should be only used to set the same unique id on a new entry which is the replacement of an existing one in the Calendar store.

Parameters

IMPORT_C TCalLocalUid LocalUidL() const;

Description

Gets the calendar local id of this entry. Note that this is the unique (for each Calendar file) Id of the entry allocated by the Calendar server internally and will remain unchanged for lifetime of the entry.

Return value

TType

Description

Defines the type of the calendar entry.

TStatus

Description

Defines the possible status values of the entry.

TReplicationStatus

Description

Replication status.

TMethod

Description

The method property of a Group Scheduling entry.