Timer.Builder
class Timer.Builder
Builder for Timer.
Summary
Public constructors |
|---|
|
Constructor for |
|
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. |
Timer |
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 |
setBaseTimeMillis(Sets the point in time that the |
T |
setBaseTimeMillis(Sets the point in time that the |
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 |
setDurationMillis(durationMillis: Long)Sets the total duration in milliseconds, including additional time added by the user. |
T |
@ExperimentalAppSearchApiSets the URL for an image of the item. |
T |
Sets the name of the item. |
T |
setOriginalDurationMillis(originalDurationMillis: Long)Sets the original duration in milliseconds when the |
T |
@ExperimentalAppSearchApiSets a list of potential actions for this document. |
T |
setRemainingDurationMillis(remainingDurationMillis: Long)Sets the amount of time remaining in milliseconds for the |
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 |
setStartTimeMillis(startTimeMillis: Long)Sets the start time in milliseconds using the |
T |
Sets the current status. |
T |
Sets the deeplink URL of the item. |
Protected properties |
|
|---|---|
(Mutable)List<String!>! |
|
Long |
|
Long |
|
Int |
|
Long |
|
String! |
|
Int |
|
Long |
|
Long |
|
String! |
|
String! |
|
String! |
|
String! |
|
Long |
|
(Mutable)List<PotentialAction!>! |
|
Long |
|
String! |
|
Boolean |
|
Long |
|
Int |
|
String! |
Public constructors
Builder
Builder(timer: Timer)
Constructor for Timer.Builder with all the existing values.
Builder
Builder(namespace: String, id: String)
Constructor for Timer.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.
setBaseTimeMillis
fun setBaseTimeMillis(
baseTimeMillis: Long,
baseTimeMillisInElapsedRealtime: Long,
bootCount: Int
): T
Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
The expire time of the Timer can be calculated using the sum of its base time and remaining time.
Base time should be sampled in both the currentTimeMillis and elapsedRealtime time base. In addition, the boot count of the device is needed to check if the elapsedRealtime time base is valid.
| Parameters | |
|---|---|
baseTimeMillis: Long |
The base time in milliseconds using the |
baseTimeMillisInElapsedRealtime: Long |
The base time in milliseconds using the |
bootCount: Int |
The current boot count of the device. See |
setBaseTimeMillis
fun setBaseTimeMillis(
context: Context,
baseTimeMillis: Long,
baseTimeMillisInElapsedRealtime: Long
): T
Sets the point in time that the Timer counts down from, relative to its setRemainingDurationMillis.
The expire time of the Timer can be calculated using the sum of its base time and remaining time.
See setBaseTimeMillis.
| Parameters | |
|---|---|
context: Context |
The app context used to fetch boot count. |
baseTimeMillis: Long |
The base time in milliseconds using the |
baseTimeMillisInElapsedRealtime: Long |
The base time in milliseconds using the |
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.
setDurationMillis
fun setDurationMillis(durationMillis: Long): T
Sets the total duration in milliseconds, including additional time added by the user.
setImage
@ExperimentalAppSearchApi
fun setImage(image: String?): T
Sets the URL for an image of the item.
setOriginalDurationMillis
fun setOriginalDurationMillis(originalDurationMillis: Long): T
Sets the original duration in milliseconds when the Timer was first created.
setPotentialActions
@ExperimentalAppSearchApi
fun setPotentialActions(
newPotentialActions: (Mutable)List<PotentialAction!>?
): T
Sets a list of potential actions for this document.
setRemainingDurationMillis
fun setRemainingDurationMillis(remainingDurationMillis: Long): T
Sets the amount of time remaining in milliseconds for the Timer relative to its setBaseTimeMillis.
The expire time of the Timer can be calculated using the sum of its base time and remaining time.
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 Timer expires.
setStartTimeMillis
fun setStartTimeMillis(startTimeMillis: Long): T
Sets the start time in milliseconds using the currentTimeMillis time base.
The start time is the first time that a new Timer, or a Timer that has been reset is started. Pausing and resuming should not change its start time.
setStatus
fun setStatus(status: Int): T
Sets the current status.
Status can be STATUS_UNKNOWN, STATUS_STARTED, STATUS_PAUSED, STATUS_EXPIRED, STATUS_MISSED, or STATUS_RESET.
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.