Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
titleload
let simple_schedule = new SimpleSchedule();

simple_schedule.load('1');


getname()

Parameter(s):

...

Returns a schedule name.


Return:

TypeDescription
StringThe schedule name.


Example:

Code Block
languagejs
titlegetName
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.getName());

...

Описание: Возвращает имя расписания.

Принимает: Ничего.
Возвращает: string.

...

Описание: Проверяет, есть ли записи для выбранного расписания.

Принимает: Ничего.
Возвращает: boolean.

Пример:


isValid()

Parameter(s):

NameType



Return:

TypeDescription



Example:

Code Block
languagejs
titleisValid
let simple_schedule = new 

...

SimpleSchedule('1', 'Europe/Moscow');

...


ss.info(simple_schedule.isValid());


МетодОписание метода
isValid()

Описание: Проверяет, есть ли записи для выбранного расписания.

Принимает: Ничего.
Возвращает: boolean.

isInSchedule(time)

Описание: Определяет, находится ли данное время в текущем расписании.

Принимает: SimpleDateTime.

Возвращает: boolean.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isInSchedule(time));

isWorkingTime(time)

Описание: Определяет, является время рабочим или нет.

Принимает: SimpleDateTime.
Возвращает: boolean.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isWorkingTime(time));

Не выносить в документацию

setTimeZone(timeZone)

Описание: Устанавливает тайм-зону.

Принимает: string.
Возвращает: Ничего.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
simple_schedule.setTimeZone('US/Central');

whenWillExpire(startDate, finalWorkingSeconds)

Описание: Определяет, когда истекает указанное рабочее время.

Принимает:startDate - SimpleDateTime, finalWorkingSeconds - integer
Возвращает: false|string.

Пример:

let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let finalWorkingSeconds = 12345;
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.whenWillExpire(startDate, finalWorkingSeconds));

whenNext(time, timeZone)

Описание: Определяет, сколько времени (в секундах) до времени начала следующего элемента расписания.

Принимает: time - SimpleDateTime; (опционально) timeZone - string (по умолчанию - пустая строка).

Возвращает: integer.

Пример:

let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.whenNext(startDate));



...