CTaskSchedule Class Reference

List of all members.

Public Member Functions
	~CTaskSchedule ()
void	ConnectAndRegisterL ()
void	PersistentScheduleL ()
void	CreatePersistentScheduleL (TSchedulerItemRef &aRef, const TTsTime &aStartTime)
void	CreateTransientScheduleL ()
void	DoesScheduledItemExistL (TSchedulerItemRef &aRef, TBool &aExists)
void	DeleteSchedulesL (TSchedulerItemRef &aRef, TScheduleFilter aFilter)
Static Public Member Functions
static CTaskSchedule *	NewLC ()

---

Detailed Description

CTaskSchedule is a class that publicly inherits from CBase class

The class demonstrates how to connect and register with the task scheduler server, create persistent and transient schedules and to delete the persistent tasks and schedules.

Definition at line 35 of file taskscheduler.h.

---

Constructor & Destructor Documentation

CTaskSchedule::~CTaskSchedule

(

)

Destructor

Definition at line 89 of file taskscheduler.cpp.

---

Member Function Documentation

CTaskSchedule * CTaskSchedule::NewLC

(

)

[static]

Allocates and constructs a CTaskSchedule object using two phase construction Initialises all member data to their default values.

Definition at line 64 of file taskscheduler.cpp.

void CTaskSchedule::ConnectAndRegisterL

(

)

Connects a client to the task scheduler server by creating a session with that server and registers the client with the scheduler. system-wide error codes.

Definition at line 104 of file taskscheduler.cpp.

void CTaskSchedule::PersistentScheduleL

(

)

Creates a persistent schedule task by calling CreatePersistentScheduleL(). Launches the task executor after adding and scheduling the task. KErrArgument system-wide error codes.

Definition at line 130 of file taskscheduler.cpp.

void CTaskSchedule::CreatePersistentScheduleL	(	TSchedulerItemRef &	aRef,
		const TTsTime &	aStartTime
	)

Creates a persistent time based schedule with no tasks associated with it but merely contains start and end time information. A persistent schedule is a schedule whose lifetime is not limited to the lifetime of the tasks associated with it. Persistent schedules have their information persisted to disk. On device reboot, this data is read back into memory by the task scheduler server.

Parameters:

	aRef	Reference to TSchedulerItemRef for unique identification of the schedule
	aStartTime	Reference to TTsTime class

KErrArgument system-wide error codes.

Definition at line 197 of file taskscheduler.cpp.

void CTaskSchedule::CreateTransientScheduleL

(

)

Creates a new, transient, time based schedule, adds a task to it and then edits the schedule and executes the edited schedule. Launches the task executor after scheduling the task. A transient schedule is destroyed when the task is destroyed or power is lost. KErrArgument system-wide error codes.

Definition at line 240 of file taskscheduler.cpp.

void CTaskSchedule::DoesScheduledItemExistL	(	TSchedulerItemRef &	aRef,
		TBool &	aExists
	)

Checks if a schedule exists

Parameters:

	aRef	Reference to TSchedulerItemRef for unique identification of the schedule
	aExists	TBool value, ETrue if the schedule exists, EFalse otherwise system wide error codes

Definition at line 353 of file taskscheduler.cpp.

void CTaskSchedule::DeleteSchedulesL	(	TSchedulerItemRef &	aRef,
		TScheduleFilter	aFilter
	)

Delete all tasks and schedules created by this exe before program exit

Parameters:

	TSchedulerItemRef	Reference to TSchedulerItemRef for unique identification of the schedule
	TScheduleFilter	Reference to a filter when listing the schedules

KErrNotFound KErrAbort KErrPermissionDenied, KErrArgument system-wide error codes.

Definition at line 395 of file taskscheduler.cpp.