Collapse all Symbian^3 Application Developer Library

ESMREntryHelper Class Reference

class ESMREntryHelper

Static helpers methods for MR Viewers for analyzing entry content and properties.

Public Member Functions
IMPORT_C void	CheckRepeatUntilValidityL ( CCalEntry &, const TCalTime &)
IMPORT_C CCalAttendee *	EqualAttendeeL (const CCalAttendee &, const CCalEntry &)
IMPORT_C TESMRCalendarEventType	EventTypeL (const CCalEntry &)
IMPORT_C TBool	IsAllDayEventL (const CCalEntry &)
IMPORT_C TBool	IsCancelledL (const CCalEntry &, CMRMailboxUtils &)
IMPORT_C TBool	IsLatestSavedSentL (const CCalEntry &)
IMPORT_C TBool	IsModifyingEntryL (const CCalEntry &)
IMPORT_C TBool	IsRepeatingMeetingL (const CCalEntry &)
IMPORT_C TBool	OccursInPastL (const CCalEntry &)
IMPORT_C const TDesC &	PhoneOwnerAddrL (const CCalEntry &, CMRMailboxUtils &)
IMPORT_C TMsvId	SendingMailBoxL (const MAgnEntryUi::TAgnEntryUiInParams &, CMRMailboxUtils &)
IMPORT_C void	SetInstanceStartAndEndL ( CCalEntry &, const CCalEntry &, const TCalTime &)
IMPORT_C TBool	SpansManyDaysL (const TCalTime &, const TCalTime &)

Member Functions Documentation

CheckRepeatUntilValidityL(CCalEntry &, const TCalTime &)

IMPORT_C void	CheckRepeatUntilValidityL	(	CCalEntry &	aEntry,
			const TCalTime &	aInstanceTime
		)	[static]

Checks and adjust repeat until validity. Method adjusts entry's recurrence until time if needed.

Parameters

CCalEntry & aEntry	Reference to parent entry
const TCalTime & aInstanceTime	Reference to instances time

EqualAttendeeL(const CCalAttendee &, const CCalEntry &)

IMPORT_C CCalAttendee *	EqualAttendeeL	(	const CCalAttendee &	aAttendee,
			const CCalEntry &	aEntry
		)	[static]

Searches for the given attendee in aEntry. This is usable e.g. in case of response, when compare and update attendee in response and request. Matching is done based on e-mail address.

Parameters

const CCalAttendee & aAttendee	reference attendee to be found entry containing possibly multiple attendees
const CCalEntry & aEntry

EventTypeL(const CCalEntry &)

IMPORT_C TESMRCalendarEventType

EventTypeL

(

const CCalEntry &

aCalEntry

)

[static]

Resolves the calendar entry type.

Parameters

const CCalEntry & aCalEntry

reference to calendar entry

IsAllDayEventL(const CCalEntry &)

IMPORT_C TBool

IsAllDayEventL

(

const CCalEntry &

aEntry

)

[static]

Checks if entry is all-day event.

Parameters

const CCalEntry & aEntry

IsCancelledL(const CCalEntry &, CMRMailboxUtils &)

IMPORT_C TBool	IsCancelledL	(	const CCalEntry &	aEntry,
			CMRMailboxUtils &	aUtils
		)	[static]

Checks if either entire meeting is cancelled, or if entry is cancellation for this particular attendee.

Parameters

const CCalEntry & aEntry
CMRMailboxUtils & aUtils

IsLatestSavedSentL(const CCalEntry &)

IMPORT_C TBool

IsLatestSavedSentL

(

const CCalEntry &

aEntry

)

[static]

Has this particular entry with it's latest saved content been sent? This is determined from the DTSTAMP value which is null until up to date entry is sent.

Parameters

const CCalEntry & aEntry

IsModifyingEntryL(const CCalEntry &)

IMPORT_C TBool

IsModifyingEntryL

(

const CCalEntry &

aEntry

)

[static]

Tests whether given entry is an originating entry or a modifying entry.

Parameters

const CCalEntry & aEntry

to evaluate

IsRepeatingMeetingL(const CCalEntry &)

IMPORT_C TBool

IsRepeatingMeetingL

(

const CCalEntry &

aEntry

)

[static]

Tells whether the entry belongs to a repeating meeting. The definition of a repeating meeting is not that there must be multiple instances, but that repeating properties exist (e.g. RRule).

Parameters

const CCalEntry & aEntry

OccursInPastL(const CCalEntry &)

IMPORT_C TBool

OccursInPastL

(

const CCalEntry &

aEntry

)

[static]

Checks whether entry is out of date or not.

Parameters

const CCalEntry & aEntry

entry to check

PhoneOwnerAddrL(const CCalEntry &, CMRMailboxUtils &)

IMPORT_C const TDesC &	PhoneOwnerAddrL	(	const CCalEntry &	aEntry,
			CMRMailboxUtils &	aUtils
		)	[static]

Returns phone owner's address, KNullDesC if not found.

Parameters

const CCalEntry & aEntry	entry to evaluate
CMRMailboxUtils & aUtils	utility reference

SendingMailBoxL(const MAgnEntryUi::TAgnEntryUiInParams &, CMRMailboxUtils &)

IMPORT_C TMsvId	SendingMailBoxL	(	const MAgnEntryUi::TAgnEntryUiInParams &	aInParams,
			CMRMailboxUtils &	aUtils
		)	[static]

Tells the mailbox id to use for sending a request or a response. From mail application we may only respond, and in that case we use the incoming mailbox. From other places we must use the default MR mailbox setting.

Parameters

const MAgnEntryUi::TAgnEntryUiInParams & aInParams	input parameters for AgnEntryUi
CMRMailboxUtils & aUtils	reference to MR Utils

SetInstanceStartAndEndL(CCalEntry &, const CCalEntry &, const TCalTime &)

IMPORT_C void	SetInstanceStartAndEndL	(	CCalEntry &	aChild,
			const CCalEntry &	aParent,
			const TCalTime &	aChildStart
		)	[static]

Sets child entry's start and end time.

Parameters

CCalEntry & aChild	Reference to child entry
const CCalEntry & aParent	Reference to parent entry
const TCalTime & aChildStart

SpansManyDaysL(const TCalTime &, const TCalTime &)

IMPORT_C TBool	SpansManyDaysL	(	const TCalTime &	aStartTime,
			const TCalTime &	aEndTime
		)	[static]

Method which checks if start and end time span multiple days.

Parameters

const TCalTime & aStartTime
const TCalTime & aEndTime