Timer

Artifact: androidx.appsearch:appsearch-builtin-types

View Source

Added in 1.1.0-alpha07

---

Kotlin |Java

@Document(name = "builtin:Timer")
class Timer : Thing

kotlin.Any
↳	androidx.appsearch.builtintypes.Thing
	↳	androidx.appsearch.builtintypes.Timer

---

AppSearch document representing a Timer entity.

Summary

Nested types
class Timer.Builder Builder for Timer.

Constants
const Int	STATUS_EXPIRED = 3 The Timer is expired.
const Int	STATUS_MISSED = 4 The Timer is missed.
const Int	STATUS_PAUSED = 2 The Timer is paused.
const Int	STATUS_RESET = 5 The Timer is reset to its initial value.
const Int	STATUS_STARTED = 1 The Timer is started.
const Int	STATUS_UNKNOWN = 0 The Timer is in an unknown error state.

Public functions
Long	calculateBaseTimeMillis(context: Context) Calculates the base time in milliseconds using the currentTimeMillis time base.
Long	calculateCurrentRemainingDurationMillis(context: Context) Calculates the current remaining time in milliseconds.
Long	calculateExpirationTimeMillis(context: Context) Calculates the expire time in milliseconds in the currentTimeMillis time base.
Long	getBaseTimeMillis() Returns the point in time that the Timer counts down from, relative to its getRemainingDurationMillis.
Long	getBaseTimeMillisInElapsedRealtime() Returns the point in time that the Timer counts down from, relative to its getRemainingDurationMillis.
Int	getBootCount() Returns the boot count of the device when this document is last updated.
Long	getDurationMillis() Returns the total duration in milliseconds, including additional time added by the user.
Long	getOriginalDurationMillis() Returns the original duration in milliseconds when the Timer was first created.
Long	getRemainingDurationMillis() Returns the amount of time remaining in milliseconds for the Timer relative to its getBaseTimeMillis.
String?	getRingtone() Returns the ringtone as a content URI to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.
Long	getStartTimeMillis() Returns the start time in milliseconds using the currentTimeMillis time base.
Int	getStatus() Returns the current status.
Boolean	shouldVibrate() Returns whether or not to activate the device vibrator when the Timer expires.

Inherited functions

From androidx.appsearch.builtintypes.Thing (Mutable)List<String!> getAlternateNames() Returns an unmodifiable list of aliases, if any, for this item. Long getCreationTimestampMillis() Returns the creation timestamp, in milliseconds since Unix epoch, of this item. String? getDescription() Returns a description of this item. Int getDocumentScore() Returns the intrinsic score (or importance) of this item. Long getDocumentTtlMillis() Returns the time-to-live timestamp, in milliseconds since getCreationTimestampMillis, for this item. String getId() Returns the unique identifier for this item. String? @ExperimentalAppSearchApi getImage() Returns the URL for an image of this item. String? getName() Returns the name of this item. String getNamespace() Returns the namespace (or logical grouping) for this item. (Mutable)List<PotentialAction!> @ExperimentalAppSearchApi getPotentialActions() Returns the actions that can be taken on this object. String? getUrl() Returns the deeplink URL of this item.

Constants

STATUS_EXPIRED

Added in 1.1.0-alpha07

const val STATUS_EXPIRED = 3: Int

The Timer is expired.

STATUS_MISSED

Added in 1.1.0-alpha07

const val STATUS_MISSED = 4: Int

The Timer is missed.

STATUS_PAUSED

Added in 1.1.0-alpha07

const val STATUS_PAUSED = 2: Int

The Timer is paused.

STATUS_RESET

Added in 1.1.0-alpha07

const val STATUS_RESET = 5: Int

The Timer is reset to its initial value.

STATUS_STARTED

Added in 1.1.0-alpha07

const val STATUS_STARTED = 1: Int

The Timer is started.

STATUS_UNKNOWN

Added in 1.1.0-alpha07

const val STATUS_UNKNOWN = 0: Int

The Timer is in an unknown error state.

Public functions

calculateBaseTimeMillis

Added in 1.1.0-alpha07

fun calculateBaseTimeMillis(context: Context): Long

Calculates the base time in milliseconds using the currentTimeMillis time base.

If the boot count retrieved from the context matches getBootCount, then getBaseTimeMillisInElapsedRealtime will be used to calculate the base time in the currentTimeMillis time base. Otherwise return getBaseTimeMillis.

calculateCurrentRemainingDurationMillis

Added in 1.1.0-alpha07

fun calculateCurrentRemainingDurationMillis(context: Context): Long

Calculates the current remaining time in milliseconds.

A negative value may be returned if the Timer is STATUS_MISSED or STATUS_EXPIRED to indicate it has already fired.

Use this method to calculate the remaining time at runtime. Use getRemainingDurationMillis to get the static remaining time stored in the document.

Parameters
context: Context	The app context

calculateExpirationTimeMillis

Added in 1.1.0-alpha07

fun calculateExpirationTimeMillis(context: Context): Long

Calculates the expire time in milliseconds in the currentTimeMillis time base.

MAX_VALUE will be returned if the Timer is STATUS_PAUSED or STATUS_RESET.

A negative value may be returned if the Timer is STATUS_MISSED or STATUS_EXPIRED to indicate it expired in the past.

Parameters
context: Context	The app context

getBaseTimeMillis

Added in 1.1.0-alpha07

fun getBaseTimeMillis(): Long

Returns the point in time that the Timer counts down from, relative to its getRemainingDurationMillis. In milliseconds using the currentTimeMillis time base.

The expire time of the Timer can be calculated using the sum of its base time and remaining time.

Use calculateBaseTimeMillis to get a more accurate base time that accounts for the current boot count of the device.

getBaseTimeMillisInElapsedRealtime

Added in 1.1.0-alpha07

fun getBaseTimeMillisInElapsedRealtime(): Long

Returns the point in time that the Timer counts down from, relative to its getRemainingDurationMillis. In milliseconds using the elapsedRealtime time base.

ElapsedRealtime should only be used if the getBootCount matches the bootCount of the current device. It is used to calculate

The expire time of the Timer can be calculated using the sum of its base time and remaining time.

getBootCount

Added in 1.1.0-alpha07

fun getBootCount(): Int

Returns the boot count of the device when this document is last updated.

The boot count of the device can be accessed from Global Settings. See BOOT_COUNT.

On older APIs where boot count is not available, this value should not be used.

If available, this value is used to calculate calculateExpirationTimeMillis.

getDurationMillis

Added in 1.1.0-alpha07

fun getDurationMillis(): Long

Returns the total duration in milliseconds, including additional time added by the user.

Applications may allow the user to add additional durations. The durationMillis will always return the new updated duration.

getOriginalDurationMillis

Added in 1.1.0-alpha07

fun getOriginalDurationMillis(): Long

Returns the original duration in milliseconds when the Timer was first created.

Applications may allow the user to add additional durations. The originalDurationMillis will always return the original duration before any change has taken place.

getRemainingDurationMillis

Added in 1.1.0-alpha07

fun getRemainingDurationMillis(): Long

Returns the amount of time remaining in milliseconds for the Timer relative to its getBaseTimeMillis.

The expire time of the Timer can be calculated using the sum of its base time and remaining time.

Use this method to get the static remaining time stored in the document. Use calculateCurrentRemainingDurationMillis to calculate the remaining time at runtime.

getRingtone

Added in 1.1.0-alpha07

fun getRingtone(): String?

Returns the ringtone as a content URI to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.

getStartTimeMillis

Added in 1.1.0-alpha07

fun getStartTimeMillis(): Long

Returns the start time in milliseconds using the currentTimeMillis time base.

The start time is the first time that a new Timer, or a Timer that has been reset is started. Pausing and resuming should not change its start time.

getStatus

Added in 1.1.0-alpha07

fun getStatus(): Int

Returns the current status.

Status can be STATUS_UNKNOWN, STATUS_STARTED, STATUS_PAUSED, STATUS_EXPIRED, STATUS_MISSED, or STATUS_RESET.

shouldVibrate

Added in 1.1.0-alpha07

fun shouldVibrate(): Boolean

Returns whether or not to activate the device vibrator when the Timer expires.