Helper Class Reference  1.3
HomeGenie - Automation Programs' Engine API
Public Member Functions | List of all members
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...
 
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

◆ WithName()

SchedulerHelper WithName ( string  name)

Select the schedule with the specified name.

Parameters
nameName.

◆ Get()

SchedulerItem Get ( )

Get the selected schedule instance.

◆ SetSchedule()

SchedulerHelper SetSchedule ( string  cronExpression)

Add/Modify the schedule with the previously selected name.

Parameters
cronExpressionCron expression.

◆ IsScheduling() [1/2]

bool IsScheduling ( )

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

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

◆ IsScheduling() [2/2]

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
cronExpressionCron expression.

◆ IsOccurrence()

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
dateDate.
cronExpressionCron expression.

◆ SolarTimes()

SolarTimes SolarTimes ( DateTime  date)

Solar Times data.

Returns
SolarTime data.
Parameters
dateDate.

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