# AlarmInstance.BuilderBase 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/AlarmInstance.java+class:androidx.appsearch.builtintypes.AlarmInstance.BuilderBase) Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02) *** ** * ** *** ``` @ExperimentalAppSearchApi class AlarmInstance.BuilderBase?> : Thing.BuilderBase ```
|---|---|---| | [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.AlarmInstance.BuilderBase](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase) | Known direct subclasses [AlarmInstance.Builder](https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.Builder) |---|---| | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance`. | *** ** * ** *** ## Summary | ### Public constructors | |---| | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase#BuilderBase(androidx.appsearch.builtintypes.AlarmInstance)(alarmInstance: https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance)` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase` with all the existing values. | | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase#BuilderBase(java.lang.String,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, scheduledTime: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase`. | | ### Public functions | |---|---| | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance` | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase#build()()` Builds the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance`. | | `T` | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase#setSnoozeDurationMillis(long)(snoozeDurationMillis: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Sets the length of time in milliseconds the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance` will remain snoozed before it fires again. | | `T` | `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase#setStatus(int)(status: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Sets the current status. | ### 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. `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)(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?)` 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)( 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? )` 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. ## Public constructors ### BuilderBase Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02) ``` BuilderBase(alarmInstance: AlarmInstance) ``` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase` with all the existing values. | Parameters | |---|---| | `alarmInstance: https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance` | The existing `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance` to copy values from. | ### BuilderBase Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02) ``` BuilderBase(namespace: String, id: String, scheduledTime: String) ``` Constructor for `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance.BuilderBase`. | 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`. | | `scheduledTime: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The time that this is expected to fire in ISO 8601 format. E.g.: 2022-01-14T00:00:00. Scheduled time should be timezone independent. | ## Public functions ### build ``` fun build(): AlarmInstance ``` Builds the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance`. ### setSnoozeDurationMillis Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02) ``` fun setSnoozeDurationMillis(snoozeDurationMillis: Long): T ``` Sets the length of time in milliseconds the `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance` will remain snoozed before it fires again. If not set, or set to -1, then it does not support snoozing. ### setStatus Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02) ``` fun setStatus(status: Int): T ``` Sets the current status. Status can be either `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_UNKNOWN()`, `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_SCHEDULED()`, `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_FIRING()`, `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_DISMISSED()`, `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_SNOOZED()`, or `https://developer.android.com/reference/kotlin/androidx/appsearch/builtintypes/AlarmInstance#STATUS_MISSED()`.