AlarmInstance.Builder

@Document.BuilderProducer
class AlarmInstance.Builder : AlarmInstance.BuilderBase

kotlin.Any
   ↳ androidx.appsearch.builtintypes.Thing.BuilderBase
     ↳ androidx.appsearch.builtintypes.AlarmInstance.BuilderBase
       ↳ androidx.appsearch.builtintypes.AlarmInstance.Builder

Builder for AlarmInstance.

Summary

Public constructors
Builder(alarmInstance: AlarmInstance)

Constructor for AlarmInstance.Builder with all the existing values.
Builder(namespace: String, id: String, scheduledTime: String)

Constructor for AlarmInstance.Builder.

Inherited functions
From androidx.appsearch.builtintypes.AlarmInstance.BuilderBase
AlarmInstance

Builds the AlarmInstance.
T
setSnoozeDurationMillis(snoozeDurationMillis: Long)

Sets the length of time in milliseconds the AlarmInstance will remain snoozed before it fires again.
T
setStatus(status: Int)

Sets the current status.
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.
Thing

Builds a Thing object.
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

Builder

Added in 1.1.0
Builder(alarmInstance: AlarmInstance)

Constructor for AlarmInstance.Builder with all the existing values.

Builder

Added in 1.1.0
Builder(namespace: String, id: String, scheduledTime: String)

Constructor for AlarmInstance.Builder.

Parameters
namespace: String

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

Unique identifier for the Document. See Document.Id.
scheduledTime: String

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.