# Timer.Builder

Artifact: [androidx.appsearch:appsearch-builtin-types](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/builtintypes/Timer.java+class:androidx.appsearch.builtintypes.Timer.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
@Document.BuilderProducer
class Timer.Builder : Timer.BuilderBase<Timer.Builder!>
```

<br />

|---|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) ||||
| ↳ | [androidx.appsearch.builtintypes.Thing.BuilderBase](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase) |||
|   | ↳ | [androidx.appsearch.builtintypes.Timer.BuilderBase](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase)\<[Timer.Builder](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder)!\> ||
|   |   | ↳ | [androidx.appsearch.builtintypes.Timer.Builder](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder) |

*** ** * ** ***

Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder#Builder(androidx.appsearch.builtintypes.Timer)(timer: https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer)` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder` with all the existing values. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder#Builder(java.lang.String,java.lang.String)(namespace: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder`. |

### Inherited functions

From [androidx.appsearch.builtintypes.Thing.BuilderBase](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase) `T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#addAlternateName(java.lang.String)(alternateName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`

Adds an alias for the item.
`T` `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#addPotentialAction(androidx.appsearch.builtintypes.PotentialAction)(newPotentialAction: https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/PotentialAction)`

Add a new action to the list of potential actions for this document.
`https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#build()()`

Builds a `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing` object.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#clearAlternateNames()()`

Clears the aliases, if any, for the item.
`T` `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#clearPotentialActions()()`

Clear all the potential actions for this document.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#resetIfBuilt()()`

If built, make a copy of previous data for every field so that the builder can be reused.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setAlternateNames(java.util.List<java.lang.String>)(alternateNames: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>?)`

Sets a list of aliases for the item.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setCreationTimestampMillis(long)(creationTimestampMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the `https://developer.android.com/reference/java/lang/System.html#currentTimeMillis()` time base.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setDescription(java.lang.String)(description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)`

Sets the description for the item.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setDocumentScore(int)(documentScore: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSpec#RANKING_STRATEGY_DOCUMENT_SCORE()`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setDocumentTtlMillis(long)(documentTtlMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
`T` `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setImage(java.lang.String)(image: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)`

Sets the URL for an image of the item.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setName(java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)`

Sets the name of the item.
`T` `@https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setPotentialActions(java.util.List<androidx.appsearch.builtintypes.PotentialAction>)(
newPotentialActions: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/PotentialAction!>?
)`

Sets a list of potential actions for this document.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Thing.BuilderBase#setUrl(java.lang.String)(url: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)`

Sets the deeplink URL of the item.
From [androidx.appsearch.builtintypes.Timer.BuilderBase](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase) `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#build()()`

Builds the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBaseTimeMillis(long)(baseTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the point in time that the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` counts down from, relative to its `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRemainingDurationMillis(long)`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBaseTimeMillis(long,long,int)(
baseTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html,
baseTimeMillisInElapsedRealtime: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html,
bootCount: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html
)`

Sets the point in time that the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` counts down from, relative to its `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRemainingDurationMillis(long)`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBaseTimeMillis(android.content.Context,long,long)(
context: https://developer.android.com/reference/android/content/Context.html,
baseTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html,
baseTimeMillisInElapsedRealtime: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

Sets the point in time that the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` counts down from, relative to its `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRemainingDurationMillis(long)`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBaseTimeMillisInElapsedRealtime(long)(
baseTimeMillisInElapsedRealtime: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html
)`

Sets the point in time that the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` counts down from, relative to its `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRemainingDurationMillis(long)`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBootCount(int)(bootCount: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Sets the boot count of the device.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setDurationMillis(long)(durationMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the total duration in milliseconds, including additional time added by the user.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setOriginalDurationMillis(long)(originalDurationMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the original duration in milliseconds when the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` was first created.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRemainingDurationMillis(long)(remainingDurationMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the amount of time remaining in milliseconds for the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` relative to its `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setBaseTimeMillis(long,long,int)`.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setRingtone(java.lang.String)(ringtone: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)`

Sets the content URI for the ringtone to be played, or `https://developer.android.com/reference/android/provider/AlarmClock.html#VALUE_RINGTONE_SILENT` if no ringtone will be played.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setShouldVibrate(boolean)(shouldVibrate: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`

Sets whether or not to activate the device vibrator when the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer` expires.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setStartTimeMillis(long)(startTimeMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`

Sets the start time in milliseconds using the `https://developer.android.com/reference/java/lang/System.html#currentTimeMillis()` time base.
`T` `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.BuilderBase#setStatus(int)(status: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Sets the current status.

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
Builder(timer: Timer)
```

Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder` with all the existing values.

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
Builder(namespace: String, id: String)
```

Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/Timer.Builder`.

| Parameters |
|---|---|
| `namespace: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | Namespace for the Document. See `https://developer.android.com/reference/kotlin/androidx/appsearch/annotation/Document.Namespace`. |
| `id: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | Unique identifier for the Document. See `https://developer.android.com/reference/kotlin/androidx/appsearch/annotation/Document.Id`. |