SchedulerHelper Class Reference

Scheduler helper.
Class instance accessor: Scheduler More...

Public Member Functions
SchedulerHelper	WithName (string name)
	Select the schedule with the specified name. More...
SchedulerItem	Get ()
	Get the selected schedule instance. More...
SchedulerHelper	SetSchedule (string cronExpression)
	Add/Modify the schedule with the previously selected name. More...
SchedulerHelper	SetProgram (string programId)
	Sets the program id to run when the selected schedule occurs. More...
bool	IsScheduling ()
	Determines whether the selected schedule is matching in this very moment. More...
bool	IsScheduling (string cronExpression)
	Determines whether the given cron expression is matching at this very moment. More...
bool	IsOccurrence (DateTime date, string cronExpression)
	Determines whether the given cron expression is a matching occurrence at the given date/time. More...
SolarTimes	SolarTimes (DateTime date)
	Solar Times data. More...

Detailed Description

Scheduler helper.
Class instance accessor: Scheduler

Member Function Documentation

SchedulerHelper WithName

(

string

name

)

Select the schedule with the specified name.

Parameters

name

Name.

SchedulerItem Get

(

)

Get the selected schedule instance.

SchedulerHelper SetSchedule

(

string

cronExpression

)

Add/Modify the schedule with the previously selected name.

Parameters

cronExpression

Cron expression.

SchedulerHelper SetProgram

(

string

programId

)

Sets the program id to run when the selected schedule occurs.

Parameters

programId

Program ID.

bool IsScheduling

(

)

Determines whether the selected schedule is matching in this very moment.

Returns

true if the selected schedule is matching, otherwise, false.

bool IsScheduling

(

string

cronExpression

)

Determines whether the given cron expression is matching at this very moment.

Returns

true if the given cron expression is matching; otherwise, false.

Parameters

cronExpression

Cron expression.

bool IsOccurrence	(	DateTime	date,
		string	cronExpression
	)

Determines whether the given cron expression is a matching occurrence at the given date/time.

Returns

true if the given cron expression is matching; otherwise, false.

Parameters

date	Date.
cronExpression	Cron expression.

SolarTimes SolarTimes

(

DateTime

date

)

Solar Times data.

Returns

SolarTime data.

Parameters

date

Date.

---

The documentation for this class was generated from the following file:

• SchedulerHelper.cs