Collapse all Symbian^3 Product Developer Library

MESMRMeetingRequestEntry Class Reference

class MESMRMeetingRequestEntry : public MESMRCalEntry

MESMRCalEntry provides utility functions for handling MR Entry.

esmrservices.lib

Inherits from

MESMRMeetingRequestEntry
- MESMRCalEntry

Public Member Functions
	~MESMRMeetingRequestEntry()
TBool	AnyInstancesBetweenTimePeriodL(TTime &, TTime &)
TInt	AttendeeCountL(TUint)
TESMRAttendeeStatus	AttendeeStatusL()
const TDesC &	CalendarOwnerAddressL()
void	ConfirmEntryL()
TBool	Conflicts()
void	ConstructReplyL(TESMRAttendeeStatus)
TESMRMailPlugin	CurrentPluginL()
TESMREntryInfo	EntryAttendeeInfoL()
TInt	FetchConflictingEntriesL(RPointerArray< CCalEntry > &)
void	GetAddedAttendeesL(RArray< CCalAttendee * > &, TUint)
void	GetAttendeesL(RArray< CCalAttendee * > &, TUint)
void	GetFirstInstanceStartAndEndTimeL(TTime &, TTime &)
void	GetRemovedAttendeesL(RArray< CCalAttendee * > &, TUint)
TBool	IsEntryOutOfDateL()
TBool	IsForwardedL()
TBool	IsMeetingCancelledL()
TBool	IsOpenedFromMail()
TBool	IsSentL()
TBool	IsSyncObjectPresent()
CMRMailboxUtils &	MailboxUtils()
void	MarkMeetingCancelledL()
TBool	OccursInPastL()
TESMRRole	RoleL()
TBool	SendCanellationAvailable()
void	SetSendCanellationAvailable(TBool)
TBool	StartupParameters(TESMRInputParams &)
void	SwitchToForwardL()
void	SwitchToOrginalL()
MMRInfoObject &	SyncObjectL()
void	UpdateChildEntriesSeqNumbersL()
MMRInfoObject &	ValidateSyncObjectL()

Inherited Functions
	MESMRCalEntry::CanSetRecurrenceL()const
	MESMRCalEntry::CloneEntryLC(TESMRCalEntryType)const
	MESMRCalEntry::ContainsRemoteAttachmentsL()
	MESMRCalEntry::Entry()
	MESMRCalEntry::Entry()const
	MESMRCalEntry::GetAlarmL(TESMRAlarmType &,TTime &)
	MESMRCalEntry::GetDBMgr()
	MESMRCalEntry::GetPriorityL()const
	MESMRCalEntry::GetRecurrenceL(TESMRRecurrenceValue &,TTime &)const
	MESMRCalEntry::InstanceL()const
	MESMRCalEntry::IsAllDayEventL()const
	MESMRCalEntry::IsEntryEditedL()const
	MESMRCalEntry::IsEntryTypeChangedL()const
	MESMRCalEntry::IsRecurrentEventL()const
	MESMRCalEntry::IsStoredL()const
	MESMRCalEntry::MESMRCalEntryRef()
	MESMRCalEntry::MESMRCalEntryRef()const
	MESMRCalEntry::OriginalEntry()
	MESMRCalEntry::RecurrenceModRule()const
	MESMRCalEntry::RemoveInstanceFromSeriesL()
	MESMRCalEntry::SetAllDayEventL(TTime,TTime)
	MESMRCalEntry::SetDefaultValuesToEntryL()
	MESMRCalEntry::SetModifyingRuleL(TESMRRecurrenceModifyingRule,const TBool)
	MESMRCalEntry::SetPriorityL(TUint)
	MESMRCalEntry::SetRecurrenceL(TESMRRecurrenceValue,TTime)
	MESMRCalEntry::SetTypeChanged(TBool)
	MESMRCalEntry::SupportsCapabilityL(TMREntryCapability)const
	MESMRCalEntry::Type()const
	MESMRCalEntry::UpdateComparativeEntry(CCalEntry *)
	MESMRCalEntry::UpdateEntryAfterStoringL()
	MESMRCalEntry::UpdateTimeStampL()
	MESMRCalEntry::ValidateEntryL()
	MESMRCalEntry::~MESMRCalEntry()

Public Member Enumerations
enum	TESMREntryInfo { EESMREntryInfoOutOfDate, EESMREntryInfoCancelled, EESMREntryInfoAccepted, EESMREntryInfoTentativelyAccepted, EESMREntryInfoDeclined, EESMREntryInfoOccursInPast, EESMREntryInfoConflicts, EESMREntryInfoNormal }

Inherited Enumerations
	MESMRCalEntry:TESMRAlarmType
	MESMRCalEntry:TESMRCalEntryType
	MESMRCalEntry:TESMRRecurrenceModifyingRule
	MESMRCalEntry:TMREntryCapability

Constructor & Destructor Documentation

~MESMRMeetingRequestEntry()

~MESMRMeetingRequestEntry

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

AnyInstancesBetweenTimePeriodL(TTime &, TTime &)

TBool	AnyInstancesBetweenTimePeriodL	(	TTime &	aStart,
			TTime &	aEnd
		)	[pure virtual]

Checks if any instance (having same UID) occurs between specified time. Time information is considered to be device's local time.

Parameters

TTime & aStart	Start time
TTime & aEnd	End time

AttendeeCountL(TUint)

TInt

AttendeeCountL

(

TUint

aFilterFlags

)

const [pure virtual]

Fetches attendee count.

Filtering flags is combimnation of enumeration TESMRRole values. For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required attendee count is returns.

Parameters

TUint aFilterFlags

AttendeeStatusL()

TESMRAttendeeStatus

AttendeeStatusL

(

)

const [pure virtual]

Fetches attendee status. Phone owner needs to be in the attendee list.

CalendarOwnerAddressL()

const TDesC &

CalendarOwnerAddressL

(

)

const [pure virtual]

Fetches the calendar owner address.

ConfirmEntryL()

void

ConfirmEntryL

(

)

[pure virtual]

Sets entry's status to confirmed.

Conflicts()

TBool

Conflicts

(

)

const [pure virtual]

Checks, if this entry conflicts with other entries.

ConstructReplyL(TESMRAttendeeStatus)

void

ConstructReplyL

(

TESMRAttendeeStatus

aStatus

)

[pure virtual]

Constructs reply entry and sets attendee status. Phone owner needs to be found from entrys attendee list and role needs to be participant or optional participant.

Parameters

TESMRAttendeeStatus aStatus

Attendee status

CurrentPluginL()

TESMRMailPlugin

CurrentPluginL

(

)

[pure virtual]

Resolves current plugin in use.

EntryAttendeeInfoL()

TESMREntryInfo

EntryAttendeeInfoL

(

)

const [pure virtual]

Fetches entry information in attendee mode. Method will leave if phone owner is organizer.

FetchConflictingEntriesL(RPointerArray< CCalEntry > &)

TInt

FetchConflictingEntriesL

(

RPointerArray< CCalEntry > &

aEntryArray

)

[pure virtual]

Fetches the conflicting entries. Conflicting entries are added to aEntryArray.

Parameters

RPointerArray< CCalEntry > & aEntryArray

Array containing conflicting entries

GetAddedAttendeesL(RArray< CCalAttendee * > &, TUint)

void	GetAddedAttendeesL	(	RArray< CCalAttendee * > &	aAttendeeArray,
			TUint	aFilterFlags
		)	const [pure virtual]

Fetches attendees from entry. Attendees are added to aAttendeeArray. Attendees are filtered according to aFilterFlags parameter. Filtering flags is combimnation of enumeration TESMRRole values. For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required attendees are included to array. Ownership of the attendee objects is not transferred.

Parameters

RArray< CCalAttendee * > & aAttendeeArray	Reference to attendee array
TUint aFilterFlags	Attendee filtering flags.

GetAttendeesL(RArray< CCalAttendee * > &, TUint)

void	GetAttendeesL	(	RArray< CCalAttendee * > &	aAttendeeArray,
			TUint	aFilterFlags
		)	const [pure virtual]

Parameters

RArray< CCalAttendee * > & aAttendeeArray	Reference to attendee array
TUint aFilterFlags	Attendee filtering flags.

GetFirstInstanceStartAndEndTimeL(TTime &, TTime &)

void	GetFirstInstanceStartAndEndTimeL	(	TTime &	aStart,
			TTime &	aEnd
		)	[pure virtual]

Fetches first instances start and end time. For non-recurrent entries this returns the entry's start and end time.

Parameters

TTime & aStart	On returns contains the first instance's start time.
TTime & aEnd	On returns contains the first instance's end time.

GetRemovedAttendeesL(RArray< CCalAttendee * > &, TUint)

void	GetRemovedAttendeesL	(	RArray< CCalAttendee * > &	aAttendeeArray,
			TUint	aFilterFlags
		)	const [pure virtual]

Parameters

RArray< CCalAttendee * > & aAttendeeArray	Reference to attendee array
TUint aFilterFlags	Attendee filtering flags.

IsEntryOutOfDateL()

TBool

IsEntryOutOfDateL

(

)

const [pure virtual]

Tests, whether entry is out of date. Entry is out of date, if newer entry exists in calendar db.

IsForwardedL()

TBool

IsForwardedL

(

)

const [pure virtual]

Tests if this is forwarded entry.

IsMeetingCancelledL()

TBool

IsMeetingCancelledL

(

)

const [pure virtual]

Tests, if meeting is cancelled.

IsOpenedFromMail()

TBool

IsOpenedFromMail

(

)

const [pure virtual]

Tests, if entry is opened from mail.

IsSentL()

TBool

IsSentL

(

)

const [pure virtual]

Tests whether entry is sent or not

IsSyncObjectPresent()

TBool

IsSyncObjectPresent

(

)

const [pure virtual]

Tests if meeting request entry contains synchronization object.

MailboxUtils()

CMRMailboxUtils &

MailboxUtils

(

)

const [pure virtual]

Gets the mailbox utils.

MarkMeetingCancelledL()

void

MarkMeetingCancelledL

(

)

[pure virtual]

For organizer, this marks meeting cancelled. For attendee, this constructs response entry and marks attendee status 'declined'.

OccursInPastL()

TBool

OccursInPastL

(

)

const [pure virtual]

Checks, whether entry occurs in the past

RoleL()

TESMRRole

RoleL

(

)

const [pure virtual]

Fetches the phone owner's role in this calendar entry. TESMRRole.

SendCanellationAvailable()

TBool

SendCanellationAvailable

(

)

[pure virtual]

check whether can send canellation

SetSendCanellationAvailable(TBool)

void

SetSendCanellationAvailable

(

TBool

aSendCanellation

)

[pure virtual]

set the cannellation flag

Parameters

TBool aSendCanellation

StartupParameters(TESMRInputParams &)

TBool

StartupParameters

(

TESMRInputParams &

aStarupParams

)

const [pure virtual]

Fetches startup parameters. Return ETrue if startup parameters were filled to aStarupParams structure.

Parameters

TESMRInputParams & aStarupParams

Reference to startup params structure

SwitchToForwardL()

void

SwitchToForwardL

(

)

[pure virtual]

Switched entry into forward mode. Current entry's all fields remain as they are.Entry's method is switched into request and attendee list is emptied. KErrNotSupported Current entry cannot be forwarded.

SwitchToOrginalL()

void

SwitchToOrginalL

(

)

[pure virtual]

Switched entry into orginal mode. Entry is restored to same state before switching into forwarding mode. KErrNotSupported Current entry cannot be forwarded.

SyncObjectL()

MMRInfoObject &

SyncObjectL

(

)

[pure virtual]

Fetches the reference to sync object If sync object is not present, method leaves with KErrNotSupported.

UpdateChildEntriesSeqNumbersL()

void

UpdateChildEntriesSeqNumbersL

(

)

[pure virtual]

Updates child entries sequence numbers and stores them to calendar DB.

ValidateSyncObjectL()

MMRInfoObject &

ValidateSyncObjectL

(

)

[pure virtual]

Validates the sync object and return pointer to it. If sync object is not present, method leaves with KErrNotSupported.

Member Enumerations Documentation

Enum TESMREntryInfo

Enumeration for meeting request entry information

Enumerators

EESMREntryInfoOutOfDate
EESMREntryInfoCancelled
EESMREntryInfoAccepted
EESMREntryInfoTentativelyAccepted
EESMREntryInfoDeclined
EESMREntryInfoOccursInPast
EESMREntryInfoConflicts
EESMREntryInfoNormal