TScheduleEntryInfo2 Class Reference

class TScheduleEntryInfo2

Contains detailed information for a single schedule entry.

A schedule can have any number of schedule entries. A client passes one or more of these objects, contained within an array, to the RScheduler functions that create or amend a schedule.

RScheduler::CreatePersistentSchedule()

RScheduler::EditSchedule()

RScheduler::ScheduleTask()

RScheduler::GetScheduleL()

Constructor & Destructor Documentation

TScheduleEntryInfo2()

IMPORT_CTScheduleEntryInfo2()

TScheduleEntryInfo2(const TScheduleEntryInfo2 &)

IMPORT_CTScheduleEntryInfo2(const TScheduleEntryInfo2 &aEntryInfo)

Parameters

const TScheduleEntryInfo2 & aEntryInfo

TScheduleEntryInfo2(const TTsTime &, TIntervalType, TInt, TTimeIntervalMinutes)

IMPORT_CTScheduleEntryInfo2(const TTsTime &aStartTime,
TIntervalTypeaIntervalType,
TIntaInterval,
TTimeIntervalMinutesaValidityPeriod
)

Parameters

const TTsTime & aStartTime
TIntervalType aIntervalType
TInt aInterval
TTimeIntervalMinutes aValidityPeriod

TScheduleEntryInfo2(const TScheduleEntryInfo &)

TScheduleEntryInfo2(const TScheduleEntryInfo &aEntryInfo)

Parameters

const TScheduleEntryInfo & aEntryInfo

Member Functions Documentation

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

Interval()

IMPORT_C TIntInterval()const

IntervalType()

IMPORT_C TIntervalTypeIntervalType()const

ProcessOffsetEvent()

voidProcessOffsetEvent()

SetInterval(TInt)

IMPORT_C voidSetInterval(TIntaInterval)

Parameters

TInt aInterval

SetIntervalType(TIntervalType)

IMPORT_C voidSetIntervalType(TIntervalTypeaIntervalType)

Parameters

TIntervalType aIntervalType

SetStartTime(const TTsTime &)

IMPORT_C voidSetStartTime(const TTsTime &aStartTime)

Parameters

const TTsTime & aStartTime

SetValidityPeriod(TTimeIntervalMinutes)

IMPORT_C voidSetValidityPeriod(TTimeIntervalMinutesaValidityPeriod)

Parameters

TTimeIntervalMinutes aValidityPeriod

StartTime()

IMPORT_C const TTsTime &StartTime()const

ValidityPeriod()

IMPORT_C TTimeIntervalMinutesValidityPeriod()const

operator=(const TScheduleEntryInfo2 &)

IMPORT_C TScheduleEntryInfo2 &operator=(const TScheduleEntryInfo2 &aEntryInfo)

Parameters

const TScheduleEntryInfo2 & aEntryInfo

Member Data Documentation

TInt iInterval

TInt iInterval[private]

The interval between execution of tasks. The way that this value is interpreted depends on the value of iIntervalType. For example, if the interval is 2 and iIntervalType has a value of EMonthly, then the interval is 2 months. The interval must have a minimum value of 1.

TIntervalType iIntervalType

TIntervalType iIntervalType[private]

Defines the type of interval between the execution of tasks. May be EHourly, EDaily, EMonthly or EYearly.

TAny * iReserved

TAny *iReserved[private]

For future use

TTsTime iStartTime

TTsTime iStartTime[private]

The first time that the entry will cause execution of tasks.

TTimeIntervalMinutes iValidityPeriod

TTimeIntervalMinutes iValidityPeriod[private]

The period for which the entry is valid. After the validity period has expired, tasks associated with the entry will not be eligible for execution.