MRRecurrenceRule Class Reference

class MRRecurrenceRule

MRRecurrenceRule defines meeting request recurrence rule.

Nested Classes and Structures

Public Member Functions
~MRRecurrenceRule()
TTime RecurrenceStartTime()
TUint RecurrentCount()
const RArray< TRecurrentDaysofMonth > &RecurrentDaysofMonth()
TInt RecurrentInterval()
const RArray< TInt > &RecurrentMonthDays()
const RArray< TMRRecurrenceMonth > &RecurrentMonths()
TTime RecurrentUntil()
const RArray< TMRRecurrentDay > &RecurrentWeekDays()
voidSetRecurrenceStartTimeL(TTime)
voidSetRecurrenceTypeL(TMRRecurrenceType)
voidSetRecurrenceUntilL(TTime)
voidSetRecurrentCountL(TInt)
voidSetRecurrentDaysofMonthL(RArray< TRecurrentDaysofMonth > &)
voidSetRecurrentInterval(TInt)
voidSetRecurrentMonthDaysL(RArray< TInt > &)
voidSetRecurrentMonthsL(RArray< TMRRecurrenceMonth > &)
voidSetRecurrentWeekDaysL(RArray< TMRRecurrentDay > &)
TMRRecurrenceType Type()
Public Member Enumerations
enumTMRRecurrenceMonth {
EMRRecurrenceJanuary = 1, EMRRecurrenceFebryary, EMRRecurrenceMarch, EMRRecurrenceApril, EMRRecurrenceMay, EMRRecurrenceJune, EMRRecurrenceJuly, EMRRecurrenceAugust, EMRRecurrenceSeptember, EMRRecurrenceOctober, EMRRecurrenceNovember, EMRRecurrenceDecember
}
enumTMRRecurrenceType {
EMRRecurrenceInvalid, EMRRecurrenceDaily, EMRRecurrenceWeekly, EMRRecurrenceMonthly, EMRRecurrenceMonthlyByDay, EMRRecurrenceYearly, EMRRecurrenceYearlyByDay
}
enumTMRRecurrenceWeek { EMRRecurrenceLastWeekOfMonth = -1, EMRRecurrenceFirstWeekOfMonth = 1, EMRRecurrenceSecondWeekOfMonth = 2, EMRRecurrenceThirdWeekOfMonth = 3, EMRRecurrenceFourthWeekOfMonth = 4 }
enumTMRRecurrentDay {
EMRRecurrenceMonday, EMRRecurrenceTuesday, EMRRecurrenceWednesday, EMRRecurrenceThursday, EMRRecurrenceFriday, EMRRecurrenceSaturday, EMRRecurrenceSunday
}

Constructor & Destructor Documentation

~MRRecurrenceRule()

~MRRecurrenceRule()[inline, virtual]

Virtual destructor.

Member Functions Documentation

RecurrenceStartTime()

TTime RecurrenceStartTime()const [pure virtual]

Fetches the recurrence start time. Time information is returned in utc.

RecurrentCount()

TUint RecurrentCount()const [pure virtual]

Fetches the number of recurrences.

RecurrentDaysofMonth()

const RArray< TRecurrentDaysofMonth > &RecurrentDaysofMonth()const [pure virtual]

RecurrentInterval()

TInt RecurrentInterval()const [pure virtual]

Fetches the recurrent interval. Interval is a number of days for a daily repeat, a number of weeks for a weekly repeat, etc.

RecurrentMonthDays()

const RArray< TInt > &RecurrentMonthDays()const [pure virtual]

Fetches all days in the month on which this rule is repeated. The returned array is empty if this is not a monthly or yearly recurrence.

RecurrentMonths()

const RArray< TMRRecurrenceMonth > &RecurrentMonths()const [pure virtual]

Fetches the months of the year for this repeat rule. This function will do nothing if this is not a yearly repeat rule.

RecurrentUntil()

TTime RecurrentUntil()const [pure virtual]

Fetches the date on which this repeat rule finishes. Time information is returned in utc.

RecurrentWeekDays()

const RArray< TMRRecurrentDay > &RecurrentWeekDays()const [pure virtual]

Fetches all weekdays on which this rule is repeated. The returned array is empty if this is not a weekly recurrence.

SetRecurrenceStartTimeL(TTime)

voidSetRecurrenceStartTimeL(TTimeaStartTime)[pure virtual]

Sets the recurrence start time.

Parameters

TTime aStartTimeRecurrence start time as utc.

SetRecurrenceTypeL(TMRRecurrenceType)

voidSetRecurrenceTypeL(TMRRecurrenceTypeaType)[pure virtual]
Sets recurrence type. Calling this method will clear the previously set recurrence rules.
Exceptions
System

wide error code.

Parameters

TMRRecurrenceType aTypeRecurrence rule type.

SetRecurrenceUntilL(TTime)

voidSetRecurrenceUntilL(TTimeaStartTime)[pure virtual]

Sets the recurrence until time.

Parameters

TTime aStartTimeRecurrence until time in utc.

SetRecurrentCountL(TInt)

voidSetRecurrentCountL(TIntaCount)[pure virtual]
Sets recurrent count.
Exceptions
Normal

system wide error code.

Parameters

TInt aCount

SetRecurrentDaysofMonthL(RArray< TRecurrentDaysofMonth > &)

voidSetRecurrentDaysofMonthL(RArray< TRecurrentDaysofMonth > &aDays)[pure virtual]

Parameters

RArray< TRecurrentDaysofMonth > & aDays

SetRecurrentInterval(TInt)

voidSetRecurrentInterval(TIntaInterval)[pure virtual]
Sets recurrent rule interval.
Exceptions
Normal

system wide error code.

Parameters

TInt aIntervalRecurrent rule interval.

SetRecurrentMonthDaysL(RArray< TInt > &)

voidSetRecurrentMonthDaysL(RArray< TInt > &aDays)[pure virtual]
Sets the days in the month on which this rule is repeated. Calling this method has no effect if recurrence rule type is not monthly or yearly.
Exceptions
Normal

system wide error code.

Parameters

RArray< TInt > & aDaysDays in the month on which this rule is repeated.

SetRecurrentMonthsL(RArray< TMRRecurrenceMonth > &)

voidSetRecurrentMonthsL(RArray< TMRRecurrenceMonth > &aMonths)[pure virtual]
Sets the months of the year for this repeat rule. Calling this method has no effect if recurrence rule type is not yearly.
Exceptions
Normal

system wide error code.

Parameters

RArray< TMRRecurrenceMonth > & aMonthsMonths of the year for this repeat rule.

SetRecurrentWeekDaysL(RArray< TMRRecurrentDay > &)

voidSetRecurrentWeekDaysL(RArray< TMRRecurrentDay > &aDays)[pure virtual]
Sets the all weekdays on which this rule is repeated. Calling this method has no effect if recurrence rule type is not weekly.
Exceptions
Normal

system wide error code.

Parameters

RArray< TMRRecurrentDay > & aDaysRecurrence rule weekly days.

Type()

TMRRecurrenceType Type()const [pure virtual]

Fetches recurrence type.

Member Enumerations Documentation

Enum TMRRecurrenceMonth

Definition for recurrence months

Enumerators

EMRRecurrenceJanuary = 1
EMRRecurrenceFebryary
EMRRecurrenceMarch
EMRRecurrenceApril
EMRRecurrenceMay
EMRRecurrenceJune
EMRRecurrenceJuly
EMRRecurrenceAugust
EMRRecurrenceSeptember
EMRRecurrenceOctober
EMRRecurrenceNovember
EMRRecurrenceDecember

Enum TMRRecurrenceType

Enumerators

EMRRecurrenceInvalid

The type has not yet been defined

EMRRecurrenceDaily

Rule which repeats based on a number of days.

EMRRecurrenceWeekly

Rule which repeats based on a number of weeks

EMRRecurrenceMonthly

Rule which repeats based on a number of months

EMRRecurrenceMonthlyByDay
EMRRecurrenceYearly

Rule which repeats based on a number of years

EMRRecurrenceYearlyByDay

Enum TMRRecurrenceWeek

Definition for recurrent week

Enumerators

EMRRecurrenceLastWeekOfMonth = -1
EMRRecurrenceFirstWeekOfMonth = 1
EMRRecurrenceSecondWeekOfMonth = 2
EMRRecurrenceThirdWeekOfMonth = 3
EMRRecurrenceFourthWeekOfMonth = 4

Enum TMRRecurrentDay

Definition for recurrent day

Enumerators

EMRRecurrenceMonday
EMRRecurrenceTuesday
EMRRecurrenceWednesday
EMRRecurrenceThursday
EMRRecurrenceFriday
EMRRecurrenceSaturday
EMRRecurrenceSunday