AlarmInstance.Builder

Artifact: androidx.appsearch:appsearch-builtin-types

Added in 1.1.0

Kotlin |Java

@Document.BuilderProducer
public final class AlarmInstance.Builder extends AlarmInstance.BuilderBase

java.lang.Object
↳	androidx.appsearch.builtintypes.Thing.BuilderBase
	↳	androidx.appsearch.builtintypes.AlarmInstance.BuilderBase
		↳	androidx.appsearch.builtintypes.AlarmInstance.Builder

Builder for AlarmInstance.

Summary

Public constructors
`Builder(@NonNull AlarmInstance alarmInstance)` Constructor for `AlarmInstance.Builder` with all the existing values.
`Builder( @NonNull String namespace, @NonNull String id, @NonNull String scheduledTime )` Constructor for `AlarmInstance.Builder`.

Inherited methods

From androidx.appsearch.builtintypes.AlarmInstance.BuilderBase

`@NonNull AlarmInstance`	`build()` Builds the `AlarmInstance`.
`@NonNull T`	`setSnoozeDurationMillis(long snoozeDurationMillis)` Sets the length of time in milliseconds the `AlarmInstance` will remain snoozed before it fires again.
`@NonNull T`	`setStatus(int status)` Sets the current status.

From androidx.appsearch.builtintypes.Thing.BuilderBase

`@NonNull T`	`addAlternateName(@NonNull String alternateName)` Adds an alias for the item.
`@NonNull T`	`@ExperimentalAppSearchApi addPotentialAction(@NonNull PotentialAction newPotentialAction)` Add a new action to the list of potential actions for this document.
`@NonNull Thing`	`build()` Builds a `Thing` object.
`@NonNull T`	`clearAlternateNames()` Clears the aliases, if any, for the item.
`@NonNull T`	`@ExperimentalAppSearchApi clearPotentialActions()` Clear all the potential actions for this document.
`void`	`resetIfBuilt()` If built, make a copy of previous data for every field so that the builder can be reused.
`@NonNull T`	`setAlternateNames(@Nullable List<String> alternateNames)` Sets a list of aliases for the item.
`@NonNull T`	`setCreationTimestampMillis(long creationTimestampMillis)` Sets the creation timestamp for the current AppSearch entity, in milliseconds using the `currentTimeMillis` time base.
`@NonNull T`	`setDescription(@Nullable String description)` Sets the description for the item.
`@NonNull T`	`setDocumentScore(int documentScore)` Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using `RANKING_STRATEGY_DOCUMENT_SCORE`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
`@NonNull T`	`@ExperimentalAppSearchApi setImage(@Nullable String image)` Sets the URL for an image of the item.
`@NonNull T`	`setName(@Nullable String name)` Sets the name of the item.
`@NonNull T`	`@ExperimentalAppSearchApi setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)` Sets a list of potential actions for this document.
`@NonNull T`	`setUrl(@Nullable String url)` Sets the deeplink URL of the item.

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull AlarmInstance alarmInstance)

Constructor for AlarmInstance.Builder with all the existing values.

Builder

Added in 1.1.0

public Builder(
    @NonNull String namespace,
    @NonNull String id,
    @NonNull String scheduledTime
)

Constructor for AlarmInstance.Builder.

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the Document. See `Document.Id`.
`@NonNull String scheduledTime`	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.