You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This class provides methods for performing operations on SimpleDateTime objects, such as instantiating objects, for example.

You can also use this class to perform date-time operations, such as calculations, formatting or converting between date-time formats.

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

Описание:
Добавляет указанное количество недель к текущему объекту SimpleDateTime. Отрицательный параметр вычитает недели. Метод определяет локальную дату и время, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает недели, используя локальные значения даты и времени.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addWeeksLocalTime(2)
ss.info(simple_date_time.getValue()); // 2019-01-15

addWeeksUTC(weeks)

Описание:
Добавляет указанное количество недель к текущему объекту SimpleDateTime. Отрицательный параметр вычитает недели. Метод определяет дату и время в формате UTC, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает недели, используя значения даты и времени в формате UTC.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addWeeksUTC(-1)
ss.info(simple_date_time.getValue()); // 2018-12-25 08:00:00

addMonthsLocalTime(months)

Описание:
Добавляет указанное количество месяцев к текущему объекту SimpleDateTime. Отрицательный параметр вычитает месяцы.Метод определяет локальную дату и время, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает месяцы, используя локальные значения даты и времени.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addMonthsLocalTime(1)
ss.info(simple_date_time.getValue()); // 2019-02-01

addMonthsUTC(months)

Описание:
Добавляет указанное количество месяцев к текущему объекту SimpleDateTime. Отрицательный параметр вычитает месяцы. Метод определяет дату и время в формате UTC, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает месяцы, используя значения даты и времени в формате UTC.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addMonthsUTC(-1)
ss.info(simple_date_time.getValue()); // 2018-12-01 08:00:00

addYearsLocalTime(years)

Описание:
Добавляет указанное количество лет к текущему объекту SimpleDateTime. Отрицательный параметр вычитает годы.Метод определяет локальную дату и время, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает годы, используя локальные значения даты и времени.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addYearsLocalTime(1)
ss.info(simple_date_time.getValue()); // 2020-01-01

addYearsUTC(years)

Описание:
Добавляет указанное количество лет к текущему объекту SimpleDateTime. Отрицательный параметр вычитает годы. Метод определяет дату и время в формате UTC, эквивалентные значению, сохраненному объектом SimpleDateTime, затем добавляет или вычитает годы, используя значения даты и времени в формате UTC.

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

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addYearsLocalTime(-1)
ss.info(simple_date_time.getValue()); // 2018-01-01 08:00:00

after(dateTime)

Описание: Возвращает true, если текущая дата позже переданной.
Принимает:объект SimpleDateTime.
Возвращает: bool.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
let result = first_simple_date_time.after(second_simple_date_time);
ss.info(result) // true

before(dateTime)

Описание: Возвращает true, если текущая дата раньше переданной.
Принимает:объект SimpleDateTime.
Возвращает: bool.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
let result = first_simple_date_time.before(second_simple_date_time);
ss.info(result) // false

compareTo(dateTime)

Описание: Возвращает 0, если переданная и текущая дата равны, 1 - если текущая дата больше и -1, если текущая дата меньше.
Принимает:объект SimpleDateTime.
Возвращает: null|int.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
var third_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");

ss.info( first_simple_date_time.compareTo(second_simple_date_time) ); // 1
ss.info( second_simple_date_time.compareTo(first_simple_date_time) ); // -1
ss.info( third_simple_date_time.compareTo(second_simple_date_time ) ); // 0

equals(dateTime)

Описание: Проверяет, равна ли переданная дата дате текущего объекта.
Принимает:объект SimpleDateTime.
Возвращает: bool.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
var third_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");

ss.info( first_simple_date_time.equals(second_simple_date_time) ); // 0
ss.info( third_simple_date_time.equals(second_simple_date_time ) ); // 1

getValue()

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

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getValue() ); //2019-01-01 08:00:00

getDisplayValue()

Описание: Возвращает дату и время в пользовательском формате и пользовательской тайм-зоне

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDisplayValue() ) ; //uses current user session time zone 

 
getNumericValue()

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

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getNumericValue() ) ; // 1546318800

getTime()

Описание: Возвращает объект SimpleTimeApi с текущим временем в дефолтной тайм-зоне.

Принимает:Ничего.
Возвращает: объект SimpleDateTime.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var time = first_simple_date_time.getTime();
ss.info( time.getByFormat('h:m:s') );

getLocalTime()

Описание: Возвращает объект SimpleTimeApi с текущим временем в пользовательской тайм-зоне

Принимает:Ничего.
Возвращает: объект SimpleDateTime.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var time = first_simple_date_time.getLocalTime();
ss.info( "My local time is " + time.getByFormat('h:m:s') ) ;

getDate()

Описание: Возвращает текущую дату в дефолтной тайм-зоне.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDate() ); // 2019-01-01

getLocalDate()

Описание: Возвращает текущую дату в пользовательской тайм-зоне.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getLocalDate() )

getMonthLocalTime()

Описание: Возвращает месяц, сохраненный объектом SimpleDateTime, в пользовательской тайм-зоне.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getMonthLocalTime() ); // January

getMonthUTC()

Описание: Возвращает месяц, сохраненный объектом SimpleDateTime, в дефолтной тайм-зоне.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getMonthUTC() );

getYearLocalTime()

Описание: Возвращает год, сохраненный объектом SimpleDateTime, в пользовательской тайм-зоне.

Принимает:Ничего.
Возвращает: int (номер года).

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getYearLocalTime() ); // 2019

getYearUTC()

Описание: Возвращает год, сохраненный объектом SimpleDateTime, в в дефолтной тайм-зоне.

Принимает:Ничего.
Возвращает: int (номер года).

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getYearUTC() );

getWeekOfYearLocalTime()

Описание: Возвращает неделю года , сохраненную объектом SimpleDateTime, в пользовательской тайм-зоне.

Принимает:Ничего.
Возвращает: int (номер недели в году).

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getWeekOfYearLocalTime() ); // 1

getWeekOfYearUTC()

Описание: Возвращает неделю года , сохраненную объектом SimpleDateTime, в дефолтной тайм-зоне.

Принимает:Ничего.
Возвращает: int (номер недели в году).

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getWeekOfYearUTC() );

getDayOfWeekLocalTime()

Описание: Возвращает день недели , сохраненный объектом SimpleDateTime, в пользовательской тайм-зоне.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfWeekLocalTime() ); // Tue

getDayOfWeekUTC()

Описание: Возвращает день недели , сохраненный объектом SimpleDateTime, в дефолтной тайм-зоне.

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

Exaple:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfWeekUTC() );

getDayOfMonthLocalTime()

Описание: Возвращает день месяца в пользовательской тайм-зоне.

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

Exaple:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfMonthLocalTime() ); // 1

getDayOfMonthUTC()

Описание: Возвращает день месяца в UTC тайм-зоне

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfMonthUTC() );

getDaysInMonthLocalTime()

Описание: Возвращает количество дней в месяце в пользовательской тайм-зоне

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDaysInMonthLocalTime() ); // 31

getDaysInMonthUTC()

Описание: Возвращает количество дней в месяце в дефолтной тайм-зоне

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDaysInMonthUTC() );

getErrorMsg()

Описание: Возвращает сообщение об ошибке в случае неверного формата DateTime.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-zz-01 08:00:00");
ss.info( first_simple_date_time.getErrorMsg() ) ;  //The parsed date or time was invalid!

isValid()

Описание:Валидация корректной даты и времени.

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

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setDisplayValue("2011-aa-01 00:00:00");
ss.info( first_simple_date_time.isValid() ) ;  // false

setDisplayValue(dateTime, format)

Описание:Устанавливает DateTime с учетом пользовательской тайм-зоны.

Принимает:dateTime - string, опционально: format - string (по умолчанию - null).
Возвращает: Ничего.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setDisplayValue("2020-01-01 12:00:00");
ss.info( first_simple_date_time.getValue() );

setValue(dateTime)

Описание: Устанавливает дату и время объекта SimpleDateTime.

Принимает:

  •  - A string in the UTC time zone and the internal format of yyyy-MM-dd HH:mm:ss.
  • - A Simple DateTime object
  • - A JavaScript Number. Sets the value of the object using the Number value as milliseconds past January 1, 1970 00:00:00 GMT.

Возвращает: Ничего.

Example:

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setValue("2020-01-01 12:00:00");
ss.info( first_simple_date_time.getValue() );  // 2020-01-01 12:00:00


subtract(first, second)

Описание:Отнимает от текущего времени либо возвращает разницу между переданными объектами SimpleDateTime.

Принимает:

  • SimpleDateTime Object
  • SimpleTime Object
  • Number milliseconds

Возвращает: объект SimpleDuration

Example:

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");

var simple_time = new SimpleTime();
simple_time.setValue("00:00:20");

simple_date_time.subtract(simple_time);

var second_simple_time  = simple_date_time.getTime();
ss.info( second_simple_time.getByFormat('h:m:s') ); // 2019-01-01 07:59:40

  • No labels