@ExperimentalAppSearchApi
class Timer.BuilderBase<T : Timer.BuilderBase<T!>?> : Thing.BuilderBase

kotlin.Any
   ↳ androidx.appsearch.builtintypes.Thing.BuilderBase
     ↳ androidx.appsearch.builtintypes.Timer.BuilderBase
Known direct subclasses
Timer.Builder

Builder for Timer.

Summary

Public constructors

Constructor for Timer.BuilderBase with all the existing values.
BuilderBase(namespace: String, id: String)

Constructor for Timer.BuilderBase.

Public functions
Timer

Builds the Timer.
T
setBaseTimeMillis(baseTimeMillis: Long)

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
T
setBaseTimeMillis(
    baseTimeMillis: Long,
    baseTimeMillisInElapsedRealtime: Long,
    bootCount: Int
)

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
T
setBaseTimeMillis(
    context: Context,
    baseTimeMillis: Long,
    baseTimeMillisInElapsedRealtime: Long
)

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
T
setBaseTimeMillisInElapsedRealtime(
    baseTimeMillisInElapsedRealtime: Long
)

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
T
setBootCount(bootCount: Int)

Sets the boot count of the device.
T
setDurationMillis(durationMillis: Long)

Sets the total duration in milliseconds, including additional time added by the user.
T
setOriginalDurationMillis(originalDurationMillis: Long)

Sets the original duration in milliseconds when the Timer was first created.
T
setRemainingDurationMillis(remainingDurationMillis: Long)

Sets the amount of time remaining in milliseconds for the Timer relative to its setBaseTimeMillis.
T
setRingtone(ringtone: String?)

Sets the content URI for the ringtone to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.
T
setShouldVibrate(shouldVibrate: Boolean)

Sets whether or not to activate the device vibrator when the Timer expires.
T
setStartTimeMillis(startTimeMillis: Long)

Sets the start time in milliseconds using the currentTimeMillis time base.
T
setStatus(status: Int)

Sets the current status.

Inherited functions
From androidx.appsearch.builtintypes.Thing.BuilderBase
T
addAlternateName(alternateName: String)

Adds an alias for the item.
T

Add a new action to the list of potential actions for this document.
T

Clears the aliases, if any, for the item.
T

Clear all the potential actions for this document.
Unit

If built, make a copy of previous data for every field so that the builder can be reused.
T
setAlternateNames(alternateNames: (Mutable)List<String!>?)

Sets a list of aliases for the item.
T
setCreationTimestampMillis(creationTimestampMillis: Long)

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.
T
setDescription(description: String?)

Sets the description for the item.
T
setDocumentScore(documentScore: Int)

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.
T
setDocumentTtlMillis(documentTtlMillis: Long)

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
T

Sets the URL for an image of the item.
T
setName(name: String?)

Sets the name of the item.
T

Sets a list of potential actions for this document.
T
setUrl(url: String?)

Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(timer: Timer)

Constructor for Timer.BuilderBase with all the existing values.

Parameters
timer: Timer

The existing Timer to copy values from.

BuilderBase

BuilderBase(namespace: String, id: String)

Constructor for Timer.BuilderBase.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.
id: String

Unique identifier for the Document. See Document.Id.

Public functions

build

fun build(): Timer

Builds the Timer.

setBaseTimeMillis

Added in 1.2.0-alpha02
fun setBaseTimeMillis(baseTimeMillis: Long): T

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

setBaseTimeMillis

Added in 1.2.0-alpha02
fun setBaseTimeMillis(
    baseTimeMillis: Long,
    baseTimeMillisInElapsedRealtime: Long,
    bootCount: Int
): T

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.

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

Base time should be sampled in both the currentTimeMillis and elapsedRealtime time base. In addition, the boot count of the device is needed to check if the elapsedRealtime time base is valid.

Parameters
baseTimeMillis: Long

The base time in milliseconds using the currentTimeMillis time base.
baseTimeMillisInElapsedRealtime: Long

The base time in milliseconds using the elapsedRealtime time base.
bootCount: Int

The current boot count of the device. See BOOT_COUNT.

setBaseTimeMillis

Added in 1.2.0-alpha02
fun setBaseTimeMillis(
    context: Context,
    baseTimeMillis: Long,
    baseTimeMillisInElapsedRealtime: Long
): T

Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.

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

See setBaseTimeMillis.

Parameters
context: Context

The app context used to fetch boot count.
baseTimeMillis: Long

The base time in milliseconds using the currentTimeMillis time base.
baseTimeMillisInElapsedRealtime: Long

The base time in milliseconds using the elapsedRealtime time base.

setBaseTimeMillisInElapsedRealtime

Added in 1.2.0-alpha02
fun setBaseTimeMillisInElapsedRealtime(
    baseTimeMillisInElapsedRealtime: Long
): T

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

setBootCount

Added in 1.2.0-alpha02
fun setBootCount(bootCount: Int): T

Sets the boot count of the device.

setDurationMillis

Added in 1.2.0-alpha02
fun setDurationMillis(durationMillis: Long): T

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

setOriginalDurationMillis

Added in 1.2.0-alpha02
fun setOriginalDurationMillis(originalDurationMillis: Long): T

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

setRemainingDurationMillis

Added in 1.2.0-alpha02
fun setRemainingDurationMillis(remainingDurationMillis: Long): T

Sets the amount of time remaining in milliseconds for the Timer relative to its setBaseTimeMillis.

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

setRingtone

Added in 1.2.0-alpha02
fun setRingtone(ringtone: String?): T

Sets the content URI for the ringtone to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.

setShouldVibrate

Added in 1.2.0-alpha02
fun setShouldVibrate(shouldVibrate: Boolean): T

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

setStartTimeMillis

Added in 1.2.0-alpha02
fun setStartTimeMillis(startTimeMillis: Long): T

Sets 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.

setStatus

Added in 1.2.0-alpha02
fun setStatus(status: Int): T

Sets the current status.

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