Alarm.Builder
@Document.BuilderProducer
class Alarm.Builder
Builder for Alarm.
Summary
Public constructors |
|---|
|
Constructor with all the existing values. |
|
Constructor for |
Public functions |
|
|---|---|
T |
addAlternateName(alternateName: String)Adds an alias for the item. |
T |
@ExperimentalAppSearchApiAdd a new action to the list of potential actions for this document. |
Alarm |
build()Builds the |
Thing |
build()Builds a |
T |
Clears the aliases, if any, for the item. |
T |
Clear all the potential actions for this document. |
T |
setAlternateNames(alternateNames: (Mutable)List<String!>?)Sets a list of aliases for the item. |
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 |
setCreationTimestampMillis(creationTimestampMillis: Long)Sets the creation timestamp for the current AppSearch entity, in milliseconds using the |
T |
setDaysOfWeek(Sets the scheduled days for repeating. |
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 |
T |
setDocumentTtlMillis(documentTtlMillis: Long)Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds. |
T |
setEnabled(enabled: Boolean)Sets whether or not the |
T |
Sets the hour the |
T |
@ExperimentalAppSearchApiSets the URL for an image of the item. |
T |
Sets the minute the |
T |
Sets the name of the item. |
T |
setNextInstance(nextInstance: AlarmInstance?)Sets the next |
T |
setOriginatingDevice(originatingDevice: Int)Sets the |
T |
@ExperimentalAppSearchApiSets a list of potential actions for this document. |
T |
setPreviousInstance(previousInstance: AlarmInstance?)Sets the previous |
T |
setRingtone(ringtone: String?)Sets the content URI for the ringtone to be played, or |
T |
setShouldVibrate(shouldVibrate: Boolean)Sets whether or not to activate the device vibrator when the |
T |
Sets the deeplink URL of the item. |
Protected properties |
|
|---|---|
(Mutable)List<String!>! |
|
String! |
|
String! |
|
Long |
|
IntArray<Int>! |
|
String! |
|
Int |
|
Long |
|
Boolean |
|
Int |
|
String! |
|
String! |
|
Int |
|
String! |
|
String! |
|
AlarmInstance! |
|
Int |
|
(Mutable)List<PotentialAction!>! |
|
AlarmInstance! |
|
String! |
|
Boolean |
|
String! |
Public constructors
Builder
Builder(namespace: String, id: String)
Constructor for Alarm.Builder.
| Parameters | |
|---|---|
namespace: String |
Namespace for the Document. See |
id: String |
Unique identifier for the Document. See |
Public functions
addAlternateName
fun addAlternateName(alternateName: String): T
Adds an alias for the item.
addPotentialAction
@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T
Add a new action to the list of potential actions for this document.
clearAlternateNames
fun clearAlternateNames(): T
Clears the aliases, if any, for the item.
clearPotentialActions
@ExperimentalAppSearchApi
fun clearPotentialActions(): T
Clear all the potential actions for this document.
setAlternateNames
fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T
Sets a list of aliases for the item.
setBlackoutPeriodEndDate
fun setBlackoutPeriodEndDate(blackoutPeriodEndDate: String?): T
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
fun setBlackoutPeriodStartDate(blackoutPeriodStartDate: String?): T
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.
setCreationTimestampMillis
fun setCreationTimestampMillis(creationTimestampMillis: Long): T
Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.
This timestamp refers to the creation time of the AppSearch entity, not when the document is written into AppSearch.
If not set, then the current timestamp will be used.
See androidx.appsearch.annotation.Document.CreationTimestampMillis for more information on creation timestamp.
setDaysOfWeek
fun setDaysOfWeek(
daysOfWeek: @IntRange(from = Calendar.SUNDAY, to = Calendar.SATURDAY) IntArray?
): T
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.
setDescription
fun setDescription(description: String?): T
Sets the description for the item.
setDocumentScore
fun setDocumentScore(documentScore: Int): T
Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.
See androidx.appsearch.annotation.Document.Score for more information on score.
setDocumentTtlMillis
fun setDocumentTtlMillis(documentTtlMillis: Long): T
Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
The document will be automatically deleted when the TTL expires.
If not set, then the document will never expire.
See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.
setEnabled
fun setEnabled(enabled: Boolean): T
Sets whether or not the Alarm is active.
setHour
fun setHour(hour: @IntRange(from = 0, to = 23) Int): T
Sets the hour the Alarm will fire.
Hours are specified by integers from 0 to 23.
setImage
@ExperimentalAppSearchApi
fun setImage(image: String?): T
Sets the URL for an image of the item.
setMinute
fun setMinute(minute: @IntRange(from = 0, to = 59) Int): T
Sets the minute the Alarm will fire.
Minutes are specified by integers from 0 to 59.
setNextInstance
fun setNextInstance(nextInstance: AlarmInstance?): T
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
fun setOriginatingDevice(originatingDevice: Int): T
Sets the OriginatingDevice this alarm belongs to.
setPotentialActions
@ExperimentalAppSearchApi
fun setPotentialActions(
newPotentialActions: (Mutable)List<PotentialAction!>?
): T
Sets a list of potential actions for this document.
setPreviousInstance
fun setPreviousInstance(previousInstance: AlarmInstance?): T
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
fun setRingtone(ringtone: String?): T
Sets the content URI for the ringtone to be played, or VALUE_RINGTONE_SILENT if no ringtone will be played.
setShouldVibrate
fun setShouldVibrate(shouldVibrate: Boolean): T
Sets whether or not to activate the device vibrator when the Alarm fires.
setUrl
fun setUrl(url: String?): T
Sets the deeplink URL of the item.
If this item can be displayed by any system UI surface, or can be read by another Android package, through one of the androidx.appsearch.app.SetSchemaRequest.Builder methods, this url should act as a deeplink into the activity that can open it. Callers should be able to construct an ACTION_VIEW intent with the url as the setData to view the item inside your application.
See Allowing Other Apps to Start Your Activity for more details on how to make activities in your app open for use by other apps by defining intent filters.