TimerOngoingActivityStatus

Kotlin |Java

open class TimerOngoingActivityStatus : OngoingActivityStatus

kotlin.Any
↳	androidx.wear.ongoingactivity.OngoingActivityStatus
	↳	androidx.wear.ongoingactivity.TimerOngoingActivityStatus

OngoingActivityStatus representing a timer or stopwatch.

Summary

Public constructors
`<init>(timeZeroMillis: Long, countDown: Boolean, pausedAtMillis: Long, totalDurationMillis: Long)` Create a Status representing a timer or stopwatch.
`<init>(timeZeroMillis: Long, countDown: Boolean, pausedAtMillis: Long)` Create a Status representing a timer or stopwatch.
`<init>(timeZeroMillis: Long, countDown: Boolean)` Create a Status representing a timer or stopwatch.
`<init>(timeZeroMillis: Long)` Create a Status representing stopwatch.

Public methods
open Boolean	`equals(other: Any?)`
open Long	`getNextChangeTimeMillis(fromTimeMillis: Long)` See `OngoingActivityStatus#getNextChangeTimeMillis(long)`
open Long	`getPausedAtMillis()`
open CharSequence	`getText(@NonNull context: Context, timeNowMillis: Long)` See `OngoingActivityStatus#getText(Context, long)`]
open Long	`getTimeZeroMillis()`
open Long	`getTotalDurationMillis()`
open Boolean	`hasTotalDuration()` Determines if this timer has a total duration set.
open Int	`hashCode()`
open Boolean	`isCountDown()`
open Boolean	`isPaused()` Determines if this timer is paused.

TimerOngoingActivityStatus(
    timeZeroMillis: Long, 
    countDown: Boolean, 
    pausedAtMillis: Long, 
    totalDurationMillis: Long)

Create a Status representing a timer or stopwatch.

Parameters
`timeZeroMillis`	Long: timestamp of the time at which this Timer should display 0, will be in the past for a stopwatch and usually in the future for timers.
`countDown`	Boolean: indicates if this is a stopwatch (when `false` or timer (when `true`).
`pausedAtMillis`	Long: timestamp of the time when this timer was paused. Or `-1L` if this timer is running.
`totalDurationMillis`	Long: total duration of this timer/stopwatch, useful to display as a progress bar or similar.

TimerOngoingActivityStatus(
    timeZeroMillis: Long, 
    countDown: Boolean, 
    pausedAtMillis: Long)

Create a Status representing a timer or stopwatch.

Parameters
`timeZeroMillis`	Long: timestamp of the time at which this Timer should display 0, will be in the past for a stopwatch and usually in the future for timers.
`countDown`	Boolean: indicates if this is a stopwatch (when `false`) or timer (when `true`).
`pausedAtMillis`	Long: timestamp of the time when this timer was paused. Or `-1L` if this timer is running.

TimerOngoingActivityStatus(
    timeZeroMillis: Long, 
    countDown: Boolean)

Create a Status representing a timer or stopwatch.

Parameters
`timeZeroMillis`	Long: timestamp of the time at which this Timer should display 0, will be in the past for a stopwatch and usually in the future for timers.
`countDown`	Boolean: indicates if this is a stopwatch (when `false`) or timer (when `true`).

TimerOngoingActivityStatus(timeZeroMillis: Long)

Create a Status representing stopwatch.

Parameters
`timeZeroMillis`	Long: timestamp of the time at which this Stopwatch started.

open fun equals(other: Any?): Boolean

open fun getNextChangeTimeMillis(fromTimeMillis: Long): Long

Parameters
`fromTimeMillis`	Long: current time, usually now as returned by `android.os.SystemClock#elapsedRealtime()`. In most cases `getText` and `getNextChangeTimeMillis` should be called with the exact same timestamp, so changes are not missed.

Return
`Long`	the first point in time after `fromTimeMillis` when the displayed value of this status will change. returns Long.MAX_VALUE if the display will never change.

open fun getPausedAtMillis(): Long

Return
`Long`	the timestamp of the time when this timer was paused. Use `TimerOngoingActivityStatus#isPaused()` to determine if this timer is paused or not.

@NonNull open fun getText(
    @NonNull context: Context, 
    timeNowMillis: Long
): CharSequence

Parameters
`context`	Context: may be used for internationalization. Only used while this method executed.
`timeNowMillis`	Long: the timestamp of the time we want to display, usually now, as returned by `android.os.SystemClock#elapsedRealtime()`.

open fun getTimeZeroMillis(): Long

Return
`Long`	the time at which this Timer will display 0, will be in the past for a stopwatch and usually in the future for timers.

open fun getTotalDurationMillis(): Long

Return
`Long`	the total duration of this timer/stopwatch, if set. Use `TimerOngoingActivityStatus#hasTotalDuration()` to determine if this timer has a duration set.

open fun hasTotalDuration(): Boolean

Determines if this timer has a total duration set.

Return
`Boolean`	`true` if this the total duration was set, `false` if not.

open fun hashCode(): Int

open fun isCountDown(): Boolean

Return
`Boolean`	`false` if this is a stopwatch or `true` if this is a timer.

open fun isPaused(): Boolean

Determines if this timer is paused. i.e. the display representation will not change over time.

Return
`Boolean`	`true` if this timer is paused, `false` if it's running.