Collapse all Symbian^3 Product Developer Library

MMRInfoObject Class Reference

class MMRInfoObject

MMRInfoObject defines meeting request interface.

MMRInfoObject can be fetched from ES Email framework, when meeting request is received in flattened format.

FSFWCommonLib

Since: S60 v3.1

Public Member Functions
	~MMRInfoObject()
void	AddAttachmentsL(MMRAttachment *)
void	AddAttendeeL(MMRAttendee *)
void	AddRecurrenceExceptionL(MMRInfoObject *)
TTime	AlarmInUtcL()
const RPointerArray< MMRAttachment > &	AttachmentsL()
RPointerArray< MMRAttendee > &	AttendeesL()
TTime	CreationTimeInUtcL()
const TDesC &	DescriptionL()
TTime	EndTimeInUtcL()
TAny *	ExtensionL(TUid)
const TDesC &	LocationL()
TMRMethod	MRMethodL()
MMROrganizer &	MROrganizerL()
TTime	MRRecurrenceId()
TResponse	MRResponse()
TInt	MRSequenceNumberL()
TUint	PriorityL()
const RPointerArray< MMRInfoObject > &	RecurrenceExceptionsL()
const MRRecurrenceRule &	RecurrenceRuleL()
void	SetAlarmInUtcL(TTime)
void	SetCreationTimeInUtcL(TTime)
void	SetDescriptionL(const TDesC &)
void	SetEndTimeInUtcL(TTime)
void	SetLocationL(const TDesC &)
void	SetMRRecurrenceIdL(TTime)
void	SetMRResponseL(TResponse)
void	SetPriorityL(TUint)
void	SetRecurrenceRuleL(const MRRecurrenceRule &)
void	SetStartTimeInUtcL(TTime)
void	SetSubjectL(const TDesC &)
TTime	StartTimeInUtcL()
const TDesC &	SubjectL()
TInt	SupportedFields(RArray< TESMRInfoField > &)
const TDesC &	UidL()

Public Member Enumerations
enum	TESMRInfoField { EESMRInfoFieldId, EESMRInfoFieldSeqNo, EESMRInfoFieldMethod, EESMRInfoFieldMStatus, EESMRInfoFieldCreationDateTime, EESMRInfoFieldOrganizer, EESMRInfoFieldAttendee, EESMRInfoFieldOptAttendee, EESMRInfoFieldStartDateTime, EESMRInfoFieldStopDateTime, EESMRInfoFieldLocation, EESMRInfoFieldAlarm, EESMRInfoFieldSubject, EESMRInfoFieldDescription, EESMRInfoFieldRecurrence, EESMRInfoFieldPriority }
enum	TMRMethod { EMRMethodRequest, EMRMethodCancel, EMRMethodResponse }
enum	TResponse { EMrCmdResponseAccept, EMrCmdResponseTentative, EMrCmdResponseDecline }

Constructor & Destructor Documentation

~MMRInfoObject()

~MMRInfoObject

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

AddAttachmentsL(MMRAttachment *)

void

AddAttachmentsL

(

MMRAttachment *

aAttachment

)

[pure virtual]

Adds meeting request attachment. Ownership is transferred.

Exceptions

System

wide error code.

Parameters

MMRAttachment * aAttachment

Attacment to be added.

AddAttendeeL(MMRAttendee *)

void

AddAttendeeL

(

MMRAttendee *

aAttendee

)

[pure virtual]

Adds attendee to meeting request. Ownership is transferred from caller.

Exceptions

System

wide error code.

Parameters

MMRAttendee * aAttendee

AddRecurrenceExceptionL(MMRInfoObject *)

void

AddRecurrenceExceptionL

(

MMRInfoObject *

aException

)

[pure virtual]

Adds recurrence exception to this meeting request. Ownership is transferred from caller.

Exceptions

System

wide error code.

Parameters

MMRInfoObject * aException

AlarmInUtcL()

TTime

AlarmInUtcL

(

)

const [pure virtual]

AttachmentsL()

const RPointerArray< MMRAttachment > &

AttachmentsL

(

)

const [pure virtual]

Fetches meeting request attachments.

Exceptions

KErrNotFoundif

field cannot be fetched.

AttendeesL()

RPointerArray< MMRAttendee > &

AttendeesL

(

)

[pure virtual]

Fetches Meeting request attendees.

Exceptions

KErrNotFoundif

field cannot be fetched.

CreationTimeInUtcL()

TTime

CreationTimeInUtcL

(

)

const [pure virtual]

Fetches meeting request utc creation time.

Exceptions

KErrNotFoundif

field cannot be fetched.

DescriptionL()

const TDesC &

DescriptionL

(

)

const [pure virtual]

Fetches meeting request description.

Exceptions

KErrNotFoundif

field cannot be fetched.

EndTimeInUtcL()

TTime

EndTimeInUtcL

(

)

const [pure virtual]

Fetches meeting request utc end time.

Exceptions

KErrNotFoundif

field cannot be fetched.

ExtensionL(TUid)

TAny *

ExtensionL

(

TUid

aExtensionUid

)

[pure virtual]

Fetches MMRInfoObject extension interface. Caller is responsible for casting returned parameter. Ownership is not transferred to caller.

Parameters

TUid aExtensionUid

LocationL()

const TDesC &

LocationL

(

)

const [pure virtual]

Fetches meeting request location.

Exceptions

KErrNotFoundif

field cannot be fetched.

MRMethodL()

TMRMethod

MRMethodL

(

)

const [pure virtual]

Fetches meeting request method.

Exceptions

KErrNotFoundif

field cannot be fetched.

MROrganizerL()

MMROrganizer &

MROrganizerL

(

)

[pure virtual]

Fetches reference to MR Organizer.

Exceptions

KErrNotFoundif

field cannot be fetched.

MRRecurrenceId()

TTime

MRRecurrenceId

(

)

const [pure virtual]

meeting request recurrence start time accessor

MRResponse()

TResponse

MRResponse

(

)

const [pure virtual]

meeting request response accessor

MRSequenceNumberL()

TInt

MRSequenceNumberL

(

)

const [pure virtual]

Fetches meeting request sequence number.

Exceptions

KErrNotFoundif

field cannot be fetched.

PriorityL()

TUint

PriorityL

(

)

const [pure virtual]

Fetches MR priority.

Exceptions

KErrNotFoundif

field cannot be fetched.

RecurrenceExceptionsL()

const RPointerArray< MMRInfoObject > &

RecurrenceExceptionsL

(

)

const [pure virtual]

Fetches recurrence exception information.

Exceptions

KErrNotFoundif

field cannot be fetched.

RecurrenceRuleL()

const MRRecurrenceRule &

RecurrenceRuleL

(

)

const [pure virtual]

Fetches recurrence rule information.

Exceptions

KErrNotFoundif

field cannot be fetched.

SetAlarmInUtcL(TTime)

void

SetAlarmInUtcL

(

TTime

aTime

)

[pure virtual]

Sets alarm time.

Exceptions

System

wide error code.

Parameters

TTime aTime

MR alarm time in utc format.

SetCreationTimeInUtcL(TTime)

void

SetCreationTimeInUtcL

(

TTime

aTime

)

[pure virtual]

Sets creation time.

Exceptions

System

wide error code.

Parameters

TTime aTime

MR creation time in utc format.

SetDescriptionL(const TDesC &)

void

SetDescriptionL

(

const TDesC &

aDescription

)

[pure virtual]

Sets meeting request description.

Exceptions

System

wide error code.

Parameters

const TDesC & aDescription

SetEndTimeInUtcL(TTime)

void

SetEndTimeInUtcL

(

TTime

aTime

)

[pure virtual]

Sets end time.

Exceptions

System

wide error code.

Parameters

TTime aTime

MR end time in utc format.

SetLocationL(const TDesC &)

void

SetLocationL

(

const TDesC &

aLocation

)

[pure virtual]

Sets meeting request location.

Exceptions

System

wide error code.

Parameters

const TDesC & aLocation

Reference to location.

SetMRRecurrenceIdL(TTime)

void

SetMRRecurrenceIdL

(

TTime

aRecId

)

[pure virtual]

meeting request recurrence start time mutator

Parameters

TTime aRecId

SetMRResponseL(TResponse)

void

SetMRResponseL

(

TResponse

aResponse

)

[pure virtual]

meeting request response mutator

Parameters

TResponse aResponse

SetPriorityL(TUint)

void

SetPriorityL

(

TUint

aPriority

)

[pure virtual]

Sets MR priority.

Exceptions

System

wide error code.

Parameters

TUint aPriority

MR priority.

SetRecurrenceRuleL(const MRRecurrenceRule &)

void

SetRecurrenceRuleL

(

const MRRecurrenceRule &

aRRule

)

[pure virtual]

Sets recurrence rule information.

Exceptions

System

wide error code.

Parameters

const MRRecurrenceRule & aRRule

SetStartTimeInUtcL(TTime)

void

SetStartTimeInUtcL

(

TTime

aTime

)

[pure virtual]

Sets start time.

Exceptions

System

wide error code.

Parameters

TTime aTime

MR start time in utc format.

SetSubjectL(const TDesC &)

void

SetSubjectL

(

const TDesC &

aSubject

)

[pure virtual]

Sets meeting request subject.

Exceptions

System

wide error code.

Parameters

const TDesC & aSubject

StartTimeInUtcL()

TTime

StartTimeInUtcL

(

)

const [pure virtual]

Fetches meeting request utc start time.

Exceptions

KErrNotFoundif

field cannot be fetched.

SubjectL()

const TDesC &

SubjectL

(

)

const [pure virtual]

Fetches meeting request subject.

Exceptions

KErrNotFoundif

field cannot be fetched.

SupportedFields(RArray< TESMRInfoField > &)

TInt

SupportedFields

(

RArray< TESMRInfoField > &

aFields

)

const [pure virtual]

Fetches the supported fields. Supported fields are stored to array given as parameter. Array defines the fields that can be fetched from meeting request info object

Parameters

RArray< TESMRInfoField > & aFields

Reference to fields table.

UidL()

const TDesC &

UidL

(

)

const [pure virtual]

Fetches meeting request id.

Exceptions

KErrNotFoundif

field cannot be fetched.

Member Enumerations Documentation

Enum TESMRInfoField

Meeting request fields

Enumerators

EESMRInfoFieldId	Meeting request ID field
EESMRInfoFieldSeqNo	Meeting request sequence number field
EESMRInfoFieldMethod	Meeting request method field
EESMRInfoFieldMStatus	Meeting request status field
EESMRInfoFieldCreationDateTime	Meeting request creation time field
EESMRInfoFieldOrganizer	Meeting request organizer field
EESMRInfoFieldAttendee	Meeting request attendee field
EESMRInfoFieldOptAttendee	Meeting request optional attendee field
EESMRInfoFieldStartDateTime	Meeting request start time field
EESMRInfoFieldStopDateTime	Meeting request end time field
EESMRInfoFieldLocation	Meeting request location field
EESMRInfoFieldAlarm	Meeting request alarm field
EESMRInfoFieldSubject	Meeting request subject field
EESMRInfoFieldDescription	Meeting request description field
EESMRInfoFieldRecurrence	Meeting request recurrence
EESMRInfoFieldPriority	Priority field

Enum TMRMethod

Definition for meeting request method

Enumerators

EMRMethodRequest	Meeting request request method
EMRMethodCancel	Meeting request cancel method
EMRMethodResponse	Meeting request response method

Enum TResponse

Enumerators

EMrCmdResponseAccept
EMrCmdResponseTentative
EMrCmdResponseDecline