Page History

The The objects of this server class store duration as a date and time starting with January 1, 1970, 00:00:00.

SimpleDuration(duration)

This constructor instantiates a Use this constructor to instantiate a new SimpleDuration object.

ParameterParameter(s):

Example:

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

add(duration)

Use this method to add to the current value the value of another SimpleDuration object. The value of the current object changes. The method returns the sum as a new SimpleDuration object.

Parameter(s):

Return:

Example:

const durationOne = new SimpleDuration(3600);
const durationTwo = new SimpleDuration('00:30:00');
const totalDuration = durationOne.add(durationTwo);
ss.info(totalDuration.getDurationValue());
// Info: 01:30:00

getByFormat(format)

This method allows to get the duration value in the set format.

Parameter(s):

Return:

Example:

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'));
// Info: 12 November 2019 (Tue) 15:34:13

getDayPart()

This method allows to get the duration value as a number of full days. For example, if an event lasts 2 days 23:59:59, the method returns 2.

Return:

Example:

const duration = new SimpleDuration('02 01:30:00');
ss.info(duration.getDayPart());
// Info: 2

getDisplayValue()

This method allows to get the number of days, hours, minutes, and seconds from the SimpleDuration object.

Return:

Example:

const duration = new SimpleDuration(3605);
ss.info(duration.getDisplayValue());
// Info: 1 hour 5 seconds

getDurationSeconds()

This method returns the duration value in seconds.

Return:

Example:

const duration = new SimpleDuration('10:00:00');
ss.info(duration.getDurationSeconds());
//Info: 36000

getDurationValue()

This method allows to get the value from the SimpleDuration object in 'd H:i:s' format.

Return:

Example:

const duration = new SimpleDuration(7200);
ss.info(duration.getDurationValue());
// Info: 02:00:00

getRoundedDayPart()

This method returns the number of days taking into account the quantity of hours in the SimpleDuration object. If the number of hours is less than 12, the method rounds the value down. Otherwise, it rounds the value up.

Return:

Example:

const duration = new SimpleDuration('5 12:52:22');
ss.info(duration.getRoundedDayPart()); 
//Info: 6

getValue()

This method returns the date and time value in the internal format.

SimpleDuration objects store duration as a date and time starting with January 1, 1970, 00:00:00.

Return:

Example 1:

const duration = new SimpleDuration('10 15:00:00');
ss.info(duration.getValue());
//Info: 1970-01-11 15:00:00

Example 2:

const myUserId = ss.getUserId();
const timestamp = Number(myUserId.slice(0, 10)); // User created at
const duration = new SimpleDuration(timestamp);
ss.info(duration.getValue());
// Info: 2019-05-31 14:02:39

setDisplayValue(duration)

This Use this method sets to set the value in a a 'd H:i:s' format.

Parameter(s):

Return:

Example:

const duration = new SimpleDuration();
duration.setDisplayValue('2 10:00:00');
ss.info(duration.getDisplayValue());
//Info: 2 days 10 hours

setValue(dateTime)

This method sets the value in a 'YYYY-MM-DD hh:mm:ss' format.

Parameter(s):

Return:

Example:

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());
// Info: 2019-08-01 09:00:00
// Info: 2019-09-05 12:00:00

subtract(duration)

This method subtracts from the current value of another SimpleDuration object from the current value of another object. The value of the current object changes. The method returns the subsstraction substraction result as a new SimpleDuration object. 

Parameter(s):

Return:

Example:

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());
// Info: 2019-11-08 19:01:58