SimpleDuration

Объекты этого серверного класса хранят продолжительность в виде даты и времени, начиная с 1 января 1970 года, 00:00:00.

SimpleDuration(duration)

---

Используйте этот конструктор для создания нового экземпляра объекта SimpleDuration.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
duration	Integer (секунды)	Нет	''
duration	String (длительность в формате 'ч:м:с')	Нет	''

Пример:

SimpleDuration()

const durationOne = new SimpleDuration(3600);
const durationTwo = new SimpleDuration('00:30:00');

add(duration)

---

Используйте этот метод, чтобы добавить к текущему значению значение другого объекта SimpleDuration. Значение текущего объекта меняется. Также метод возвращает результат суммы в виде нового объекта SimpleDuration.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
duration	SimpleDuration object	Да	Нет

Возвращаемое значение:

Тип	Описание
SimpleDuration object	Метод возвращает сумму двух объектов SimpleDuration.

Пример:

add()

const durationOne = new SimpleDuration(3600);
const durationTwo = new SimpleDuration('00:30:00');
const totalDuration = durationOne.add(durationTwo);
ss.info(totalDuration.getDurationValue());
// Информация: 01:30:00

getByFormat(format)

---

Этот метод возвращает значение продолжительности в заданном формате.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
format	String	Нет	'г-м-д ч:м:с'

Возвращаемое значение:

Тип	Описание
String	Метод возвращает значение продолжительности в заданном формате.

Пример:

getByFormat()

const datetime = new SimpleDateTime('2019-11-12 15:34:13');
const duration = new SimpleDuration(datetime.getNumericValue());
ss.info(duration.getByFormat('j F Y (D) H:i:s'));
// Информация: 12 November 2019 (Tue) 15:34:13

getDayPart()

---

Используйте этот метод, чтобы получить значение длительности, выраженное в количестве целых дней. Например, при длительности события в 2 дня 23:59:59 метод вернет значение '2'.

Возвращаемое значение:

Тип	Описание
Integer	Метод возвращает количество дней.

Пример:

getDayPart()

const duration = new SimpleDuration('02 01:30:00');
ss.info(duration.getDayPart());
// Информация: 2

getDisplayValue()

---

Используйте этот метод, чтобы получить количество дней, часов, минут и секунд из объекта SimpleDuration.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает количество дней, часов и минут.

Пример:

getDisplayValue()

const duration = new SimpleDuration(3605);
ss.info(duration.getDisplayValue());
// Информация: 1 hour 5 seconds

getDurationSeconds()

---

Используйте этот метод, чтобы получить значение продолжительности в секундах.

Возвращаемое значение:

Тип	Описание
Integer	Метод возвращает значение продолжительности в секундах.

Пример:

getDurationSeconds()

const duration = new SimpleDuration('10:00:00');
ss.info(duration.getDurationSeconds());
//Информация: 36000

getDurationValue()

---

Используйте этот метод, чтобы получить значение из объекта SimpleDuration в формате 'д ч:м:с'.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает значение продолжительности.

Пример:

getDurationValue()

const duration = new SimpleDuration(7200);
ss.info(duration.getDurationValue());
// Информация: 02:00:00

getRoundedDayPart()

---

Используйте этот метод, чтобы получить количество дней с учетом количества часов в объекте SimpleDuration. Если количество часов меньше 12, значение округляется в меньшую сторону. В противном случае значение округляется в большую сторону.

Возвращаемое значение:

Тип	Описание
Integer	Метод возвращает округленное количество дней.

Пример:

getRoundedDayPart()

const duration = new SimpleDuration('5 12:52:22');
ss.info(duration.getRoundedDayPart());
//Информация: 6

getValue()

---

Используйте метод, чтобы получить значение даты и времени во внутреннем формате.

Объекты SimpleDuration хранят продолжительность в виде даты и времени, начиная с 1 января 1970 года, 00:00:00.

Возвращаемое значение:

Тип	Описание
String	Метод возвращает значение продолжительности во внутреннем формате объекта.

Пример 1:

getValue()

const duration = new SimpleDuration('10 15:00:00');
ss.info(duration.getValue());
//Информация: 1970-01-11 15:00:00

Пример 2:

getValue()

const myUserId = ss.getUserId();
const timestamp = Number(myUserId.slice(0, 10)); // Пользователь создан в
const duration = new SimpleDuration(timestamp);
ss.info(duration.getValue());
// Информация: 2019-05-31 14:02:39

setDisplayValue(duration)

---

Используйте этот метод, чтобы установить значение в формате 'д ч:м:с'.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
duration	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

setDisplayValue()

const duration = new SimpleDuration();
duration.setDisplayValue('2 10:00:00');
ss.info(duration.getDisplayValue());
//Информация: 2 days 10 hours

setValue(dateTime)

---

Используйте этот метод, чтобы установить значение в формате 'ГГГГГ-ММ-ДД ч:м:с'.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
dateTime	String	Да	Нет
dateTime	SimpleDateTime object	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

setValue()

const durationOne = new SimpleDuration();
durationOne.setValue('2019-08-01 09:00:00');
ss.info(durationOne.getByFormat());
const durationTwo = new SimpleDuration();
durationTwo.setValue(new SimpleDateTime('2019-09-05 12:00:00'));
ss.info(durationTwo.getByFormat());
// Информация: 2019-08-01 09:00:00
// Информация: 2019-09-05 12:00:00

subtract(duration)

---

Используйте этот метод, чтобы вычесть из текущего значения значение другого объекта SimpleDuration. Значение текущего объекта меняется. Также метод возвращает результат вычитания в виде нового объекта SimpleDuration.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
duration	SimpleDuration object	Да	Нет

Возвращаемое значение:

Тип	Описание
SimpleDuration object	Метод возвращает объект с результатом вычитания.

Пример:

subtract()

const durationOne = new SimpleDuration();
durationOne.setValue('2019-11-08 20:01:58');
const durationTwo = new SimpleDuration(3600);
const datetime = durationOne.subtract(durationTwo);
ss.info(datetime.getByFormat());
// Информация: 2019-11-08 19:01:58