@ExperimentalAppSearchApi
public class Alarm.BuilderBase<T extends Alarm.BuilderBase<T>> extends Thing.BuilderBase

java.lang.Object
   ↳ androidx.appsearch.builtintypes.Thing.BuilderBase
     ↳ androidx.appsearch.builtintypes.Alarm.BuilderBase
Known direct subclasses
Alarm.Builder

Builder for Alarm.

Summary

Public constructors

Constructor for Alarm.BuilderBase with all the existing values.

Constructor for Alarm.BuilderBase.

Public methods
@NonNull Alarm

Builds the Alarm.
@NonNull T
setBlackoutPeriodEndDate(@Nullable String blackoutPeriodEndDate)

Sets the end time for the blackout period in ISO 8601 format.
@NonNull T
setBlackoutPeriodStartDate(@Nullable String blackoutPeriodStartDate)

Sets the start date for the blackout period in ISO 8601 format.
@NonNull T
setDaysOfWeek(
    @IntRange(from = Calendar.SUNDAY, to = Calendar.SATURDAY) @Nullable int[] daysOfWeek
)

Sets the scheduled days for repeating.
@NonNull T
setEnabled(boolean enabled)

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

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

Sets the minute the Alarm will fire.
@NonNull T

Sets the next AlarmInstance.
@NonNull T
setOriginatingDevice(int originatingDevice)

Sets the OriginatingDevice this alarm belongs to.
@NonNull T

Sets the previous AlarmInstance.
@NonNull T

Sets the content URI for the ringtone to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.
@NonNull T
setShouldVibrate(boolean shouldVibrate)

Sets whether or not to activate the device vibrator when the Alarm fires.

Inherited methods
From androidx.appsearch.builtintypes.Thing.BuilderBase
@NonNull T

Adds an alias for the item.
@NonNull T

Add a new action to the list of potential actions for this document.
@NonNull T

Clears the aliases, if any, for the item.
@NonNull T

Clear all the potential actions for this document.
void

If built, make a copy of previous data for every field so that the builder can be reused.
@NonNull T

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

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

Sets the URL for an image of the item.
@NonNull T

Sets the name of the item.
@NonNull T

Sets a list of potential actions for this document.
@NonNull T

Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02
public BuilderBase(@NonNull Alarm alarm)

Constructor for Alarm.BuilderBase with all the existing values.

Parameters
@NonNull Alarm alarm

The existing Alarm to copy values from.

BuilderBase

public BuilderBase(@NonNull String namespace, @NonNull String id)

Constructor for Alarm.BuilderBase.

Parameters
@NonNull String namespace

Namespace for the Document. See Document.Namespace.
@NonNull String id

Unique identifier for the Document. See Document.Id.

Public methods

build

public @NonNull Alarm build()

Builds the Alarm.

setBlackoutPeriodEndDate

Added in 1.2.0-alpha02
public @NonNull T setBlackoutPeriodEndDate(@Nullable String blackoutPeriodEndDate)

Sets the end time for the blackout period in ISO 8601 format. E.g.: 2022-01-14

A blackout period means the Alarm will not fire during this period.

If not set, then it indicates that the blackout period has no end time.

If neither blackoutPeriodStartDate and blackoutPeriodEndDate are set, then the blackout period is not defined.

setBlackoutPeriodStartDate

Added in 1.2.0-alpha02
public @NonNull T setBlackoutPeriodStartDate(@Nullable String blackoutPeriodStartDate)

Sets the start date for the blackout period in ISO 8601 format. E.g.: 2022-01-14

A blackout period means the Alarm will not fire during this period.

If not set, then it indicates that the blackout period has no start time.

If neither blackoutPeriodStartDate and blackoutPeriodEndDate are set, then the blackout period is not defined.

setDaysOfWeek

public @NonNull T setDaysOfWeek(
    @IntRange(from = Calendar.SUNDAY, to = Calendar.SATURDAY) @Nullable int[] daysOfWeek
)

Sets the scheduled days for repeating.

Days of the week can be MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.

If not set, or if the list is empty, then the Alarm does not repeat.

setEnabled

Added in 1.2.0-alpha02
public @NonNull T setEnabled(boolean enabled)

Sets whether or not the Alarm is active.

setHour

Added in 1.2.0-alpha02
public @NonNull T setHour(@IntRange(from = 0, to = 23) int hour)

Sets the hour the Alarm will fire.

Hours are specified by integers from 0 to 23.

setMinute

Added in 1.2.0-alpha02
public @NonNull T setMinute(@IntRange(from = 0, to = 59) int minute)

Sets the minute the Alarm will fire.

Minutes are specified by integers from 0 to 59.

setNextInstance

Added in 1.2.0-alpha02
public @NonNull T setNextInstance(@Nullable AlarmInstance nextInstance)

Sets the next AlarmInstance.

The next AlarmInstance is the immediate future instance that is scheduled to fire. If not set, then there are no future instances.

See AlarmInstance.

setOriginatingDevice

Added in 1.2.0-alpha02
public @NonNull T setOriginatingDevice(int originatingDevice)

Sets the OriginatingDevice this alarm belongs to.

setPreviousInstance

Added in 1.2.0-alpha02
public @NonNull T setPreviousInstance(@Nullable AlarmInstance previousInstance)

Sets the previous AlarmInstance.

The previous AlarmInstance is most recent past instance that was fired. If not set, then there are no past instances.

See AlarmInstance.

setRingtone

Added in 1.2.0-alpha02
public @NonNull T setRingtone(@Nullable String ringtone)

Sets the content URI for the ringtone to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.

setShouldVibrate

Added in 1.2.0-alpha02
public @NonNull T setShouldVibrate(boolean shouldVibrate)

Sets whether or not to activate the device vibrator when the Alarm fires.