Class TScheduleEntryInfo2

class TScheduleEntryInfo2;

Description

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.

Members

Defined in TScheduleEntryInfo2:

• Interval()constReturns the interval between execution of tasks.
• IntervalType()constReturns the Interval Type
• SetInterval(TInt)Sets the interval between execution of tasks. The way that this value is interpr...
• SetIntervalType(TIntervalType)Sets the type of interval used between due times for this schedule entry. The ty...
• SetStartTime(const TTsTime &)Sets the first time the entry will cause execution of tasks.
• SetValidityPeriod(TTimeIntervalMinutes)Sets the period for which the entry is valid. After the validity period has expi...
• StartTime()constReturns the first time at which the entry will cause execution of tasks.
• TScheduleEntryInfo2()TScheduleEntryInfo2 Default constructor. It sets the object's members data to th...
• TScheduleEntryInfo2(const TScheduleEntryInfo2 &)Copy constructor for TScheduleEntryInfo2 Sets the parameter's data to this objec...
• TScheduleEntryInfo2(const TTsTime &,TIntervalType,TInt,TTimeIntervalMinutes)TScheduleEntryInfo2 constructor taking the specified parameters.
• ValidityPeriod()constReturn the period for which the entry is valid. After the validity period has ex...
• operator=(const TScheduleEntryInfo2 &)Assignment operator for TScheduleEntryInfo2

See also:

• RScheduler::CreatePersistentSchedule(TSchedulerItemRef &,const CArrayFixFlat< TScheduleEntryInfo2 > &)Creates a persistent time based schedule.
• RScheduler::EditSchedule(const TInt,const CArrayFixFlat< TScheduleEntryInfo2 > &)Changes a time based schedule.
• RScheduler::ScheduleTask(TTaskInfo &,HBufC &,const TInt)Adds a task to an existing persistent schedule.
• RScheduler::GetScheduleL(const TInt,TScheduleState2 &,CArrayFixFlat< TScheduleEntryInfo2 > &,CArrayFixFlat< TTaskInfo > &,TTsTime &)Gets information relating to a specified time based schedule.

Related Topics

 » Symbian OS v9.4 » Examples » System Library example code » Taskschedulerexample: Using Task scheduler for creating and executing tasks

• TaskSchedulerExample: Using Task Scheduler for Creating and Executing Tasks » Class summary

IMPORT_C TScheduleEntryInfo2();

Description

TScheduleEntryInfo2 Default constructor. It sets the object's members data to the following default values. iIntervalType : EHourly iStartTime : UTC time set to 0 iInterval : 0 iValidityPeriod : 0

IMPORT_C TScheduleEntryInfo2(const TScheduleEntryInfo2 &aEntryInfo);

Description

Copy constructor for TScheduleEntryInfo2 Sets the parameter's data to this object.

Parameters

IMPORT_C TScheduleEntryInfo2(const TTsTime &aStartTime, TIntervalType aIntervalType, TInt aInterval, TTimeIntervalMinutes aValidityPeriod);

Description

TScheduleEntryInfo2 constructor taking the specified parameters.

Parameters

IMPORT_C TIntervalType IntervalType() const;

Description

Returns the Interval Type

Return value

See also:

• TIntervalTypeDefines the type of interval used by a schedule entry.

IMPORT_C void SetIntervalType(TIntervalType aIntervalType);

Description

Sets the type of interval used between due times for this schedule entry. The type of interval used may be EHourly, EDaily, EMonthly or EYearly.

Parameters

See also:

• TIntervalTypeDefines the type of interval used by a schedule entry.

IMPORT_C const TTsTime& StartTime() const;

Description

Returns the first time at which the entry will cause execution of tasks.

Return value

See also:

• TTsTimeIn Task Scheduler TTsTime is used to represent time as either UTC or Local Time....

IMPORT_C void SetStartTime(const TTsTime &aStartTime);

Description

Sets the first time the entry will cause execution of tasks.

Parameters

See also:

• TTsTimeIn Task Scheduler TTsTime is used to represent time as either UTC or Local Time....

IMPORT_C TInt Interval() const;

Description

Returns the interval between execution of tasks.

Return value

See also:

• TScheduleEntryInfo2::SetInterval(TInt)Sets the interval between execution of tasks. The way that this value is interpr...

IMPORT_C void SetInterval(TInt aInterval);

Description

Sets 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.

Parameters

IMPORT_C TTimeIntervalMinutes ValidityPeriod() const;

Description

Return 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

Return value

IMPORT_C void SetValidityPeriod(TTimeIntervalMinutes aValidityPeriod);

Description

Sets 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

Parameters

IMPORT_C TScheduleEntryInfo2& operator=(const TScheduleEntryInfo2 &aEntryInfo);

Description

Assignment operator for TScheduleEntryInfo2

Parameters

Return value

See also:

• Mem::Copy(TAny *,const TAny *,TInt)Copies data from a source location to a target location and returns a pointer to...