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

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

Builder for Alarm.

Summary

Public constructors
Builder(alarm: Alarm)

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

Constructor for Alarm.Builder.

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

Builds the Alarm.
T
setBlackoutPeriodEndDate(blackoutPeriodEndDate: String?)

Sets the end time for the blackout period in ISO 8601 format.
T
setBlackoutPeriodStartDate(blackoutPeriodStartDate: String?)

Sets the start date for the blackout period in ISO 8601 format.
T
setDaysOfWeek(
    daysOfWeek: @IntRange(from = Calendar.SUNDAY, to = Calendar.SATURDAY) IntArray<Int>?
)

Sets the scheduled days for repeating.
T
setEnabled(enabled: Boolean)

Sets whether or not the Alarm is active.
T
setHour(hour: @IntRange(from = 0, to = 23) Int)

Sets the hour the Alarm will fire.
T
setMinute(minute: @IntRange(from = 0, to = 59) Int)

Sets the minute the Alarm will fire.
T

Sets the next AlarmInstance.
T
setOriginatingDevice(originatingDevice: Int)

Sets the OriginatingDevice this alarm belongs to.
T
setPreviousInstance(previousInstance: AlarmInstance?)

Sets the previous AlarmInstance.
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 Alarm fires.
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(alarm: Alarm)

Constructor with all the existing values.

Builder

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

Constructor for Alarm.Builder.

Parameters
namespace: String

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

Unique identifier for the Document. See Document.Id.