core/com.tealium.prism.core.api.misc/TimeFrame

TimeFrame

data class TimeFrame(val number: Long, val unit: TimeUnit) : Comparable<TimeFrame>

Class denoting a length of time that is easily convertible into any required time units.

The class is Comparable for easy comparison. Although it should be noted that the comparison may not be reliable when comparing very large units with very small units as the conversions are taken from TimeUnit which will truncate limit conversions to Long.MAX_VALUE/Long.MIN_VALUE in cases when a conversion would exceed the max/min value.

Constructors

constructor(number: Long, unit: TimeUnit)

Properties

val number: Long

val unit: TimeUnit

Functions

fun TimeFrame.asUnit(unit: TimeUnit): Long

Converts the current TimeFrame to the give unit

open operator override fun compareTo(other: TimeFrame): Int

fun TimeFrame.inDays(): Long

Converts the current TimeFrame to days

fun TimeFrame.inHours(): Long

Converts the current TimeFrame to hours

fun TimeFrame.inMilliseconds(): Long

Converts the current TimeFrame to milliseconds

fun TimeFrame.inMinutes(): Long

Converts the current TimeFrame to minutes

fun TimeFrame.inSeconds(): Long

Converts the current TimeFrame to seconds