AlarmInstance.Builder
@Document.BuilderProducer
class AlarmInstance.Builder
Builder for AlarmInstance.
Summary
Public constructors |
|---|
Builder(alarmInstance: AlarmInstance)Constructor for |
|
Constructor for |
Public functions |
|
|---|---|
T |
addAlternateName(alternateName: String)Adds an alias for the item. |
T |
addPotentialAction(newPotentialAction: PotentialAction)Add a new action to the list of potential actions for this document. |
AlarmInstance |
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 |
setCreationTimestampMillis(creationTimestampMillis: Long)Sets the creation timestamp for the current AppSearch entity, in milliseconds using the |
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 |
Sets the URL for an image of the item. |
T |
Sets the name of the item. |
T |
setPotentialActions(Sets a list of potential actions for this document. |
T |
setSnoozeDurationMillis(snoozeDurationMillis: Long)Sets the length of time in milliseconds the |
T |
Sets the current status. |
T |
Sets the deeplink URL of the item. |
Protected properties |
|
|---|---|
(Mutable)List<String!>! |
|
Long |
|
String! |
|
Int |
|
Long |
|
String! |
|
String! |
|
String! |
|
String! |
|
(Mutable)List<PotentialAction!>! |
|
String! |
|
Long |
|
Int |
|
String! |
Public constructors
Builder
Builder(alarmInstance: AlarmInstance)
Constructor for AlarmInstance.Builder with all the existing values.
Builder
Builder(namespace: String, id: String, scheduledTime: String)
Constructor for AlarmInstance.Builder.
| Parameters | |
|---|---|
namespace: String |
Namespace for the Document. See |
id: String |
Unique identifier for the Document. See |
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. |
Public functions
addAlternateName
fun addAlternateName(alternateName: String): T
Adds an alias for the item.
addPotentialAction
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
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.
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.
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.
setImage
fun setImage(image: String?): T
Sets the URL for an image of the item.
setPotentialActions
fun setPotentialActions(
newPotentialActions: (Mutable)List<PotentialAction!>?
): T
Sets a list of potential actions for this document.
setSnoozeDurationMillis
fun setSnoozeDurationMillis(snoozeDurationMillis: Long): T
Sets the length of time in milliseconds the AlarmInstance will remain snoozed before it fires again.
If not set, or set to -1, then it does not support snoozing.
setStatus
fun setStatus(status: Int): T
Sets the current status.
Status can be either STATUS_UNKNOWN, STATUS_SCHEDULED, STATUS_FIRING, STATUS_DISMISSED, STATUS_SNOOZED, or STATUS_MISSED.
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.