Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server class provides methods to operate the SimpleTime class objects, for example, creating to create SimpleTime object instances or working work with the class fields.
SimpleTime(time)
Instantiates a new SimpleTime object.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
time | integer | N | 0 |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const reportTime = new SimpleTime(); ss.info(reportTime.getByFormat()); //Info: 03:00:00 |
getByFormat(format)
This method allows to get time value in the format you need.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
format | string | N | "H:i:s" |
Return:
Type | Description |
---|---|
string | The time in the specified format. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const reportTime = new SimpleTime(); reportTime.setValue('12:00:00'); ss.info(reportTime.getByFormat('H:i')); //Info: 12:00 |
getDisplayValue()
This method gets the time in the 'H:i:s' format.
Return:
Type | Description |
---|---|
String | The time in 'H:i:s'format. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const reportTime = new SimpleTime('12:00:00'); ss.info(reportTime.getDisplayValue()); //Info: 12:00:00 |
getHourLocalTime()
The output of this method is the hours part in the local time zone.
Return:
Type | Description |
---|---|
String | The hours part of the time. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const reportTime = new SimpleTime(); reportTime.setValue('12:00:00'); ss.info(reportTime.getHourLocalTime()); //Info: 12 |
getHourUTC()
The output of this method is the hours part in 12-hour clock in the UTC time zone. Noon is represented as 0, midnight is 12.
Return:
Type | Description |
---|---|
String | The hours part of the time. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const startPoint = new SimpleTime(); startPoint.setValue('12:00:00'); ss.info(startPoint.getHourUTC()); //Info: 09 |
getValue()
The output of this method is the time value saved in the SimpleTime object having the internal format (‘H:i:s’) and in the system time zone.
Return:
Type | Description |
---|---|
String | The time value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const startPoint = new SimpleTime('12:00:00'); ss.info(startPoint.getValue()); //Info: 09:00:00 |
setValue(time)
This method defines the time of the SimpleTime object in the internal time zone.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
time | String | N | "00:00:00" |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const startPoint = new SimpleTime(); startPoint.setValue('12:00:00'); ss.info(startPoint.getValue()); //Info: 09:00:00 |
Table of Contents | ||||
---|---|---|---|---|
|