SimpleSchedule

This server class provides methods to operate SimpleSchedule objects, for example, getting schedule name, determining if the current time matches with working time, and returning the difference between two time values.

SimpleSchedule(id, timeZoneTitle)

Instantiates a new SimpleSchedule object.

Parameter(s):

Example:

const schedule = new SimpleSchedule('157165292607666710', 'UTC');

duration(startDateTime, endDateTime)

This method determines the number of seconds in the schedule between two datetime values, based on the schedule time zone or, if not specified, the session time zone.

Parameter(s):

Return:

Example:

const startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
const endDatetime = new SimpleDateTime('2019-10-29 08:00:00');
const schedule = new SimpleSchedule('157165292607666710');
const duration = schedule.duration(startDatetime, endDatetime);
ss.info(duration.getValue());

load(sysId, timeZoneTitle)

This method initializes a schedule by the sys_id.

Parameter(s):

Return:

Example:

const schedule = new SimpleSchedule();
schedule.load('157165292607666710');

getname()

This method returns the name of the defined schedule.

Return:

Example:

const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.getName()); // Info: 8x5 excluding Russian Holidays

Example:

const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isValid()); // Info: true

isInSchedule(datetime)

This method checks whether the current schedule includes the given datetime or they do not match.

Parameter(s):

Return:

isValid()

The method checks if the specified schedule is valid.

Return:

Example:

const datetime = new SimpleDateTime();
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isInSchedule(datetime)); // Info: false

setTimeZone(timeZoneTitle)

This method defines which time zone is to be applied to the current schedule.

Parameter(s):

Return:

Example:

const schedule = new SimpleSchedule('157165292607666710');
schedule.setTimeZone('US/Central');

whenNext(datetime, timeZoneTitle)

This method returns the number of seconds left until the next schedule item starts.

Parameter(s):

Return:

Example:

const startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.whenNext(startDatetime));

whenWillExpire(startDateTime, finalWorkingSeconds)

This method determines the time after working seconds value specified in the finalWorkingSeconds parameter passes.

Parameter(s):

Return:

Example:

const startDatetime = new SimpleDateTime('2019-10-25 08:00:00'); // UTC datetime
const finalWorkingSeconds = 600; // 10 minutes
const schedule = new SimpleSchedule('157165292607666710'); // schedule ID
ss.info(schedule.whenWillExpire(startDatetime, finalWorkingSeconds).getValue()); // Info: 2019-10-25 08:10:00