AlarmInstance.Builder
@Document.BuilderProducer
public final class AlarmInstance.Builder
Builder for AlarmInstance.
Summary
Protected fields |
|
|---|---|
List<String> |
|
long |
|
String |
|
int |
|
long |
|
final String |
|
String |
|
String |
|
final String |
|
List<PotentialAction> |
|
final String |
|
long |
|
int |
|
String |
Public constructors |
|---|
Builder(@NonNull AlarmInstance alarmInstance)Constructor for |
|
Constructor for |
Public methods |
|
|---|---|
@NonNull T |
addAlternateName(@NonNull String alternateName)Adds an alias for the item. |
@NonNull T |
@ExperimentalAppSearchApiAdd a new action to the list of potential actions for this document. |
@NonNull AlarmInstance |
build()Builds the |
@NonNull Thing |
build()Builds a |
@NonNull T |
Clears the aliases, if any, for the item. |
@NonNull T |
Clear all the potential actions for this document. |
@NonNull T |
setAlternateNames(@Nullable List<String> alternateNames)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 |
@NonNull T |
setDescription(@Nullable String description)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 |
@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 |
@ExperimentalAppSearchApiSets a list of potential actions for this document. |
@NonNull T |
setSnoozeDurationMillis(long snoozeDurationMillis)Sets the length of time in milliseconds the |
@NonNull T |
setStatus(int status)Sets the current status. |
@NonNull T |
Sets the deeplink URL of the item. |
Protected fields
Public constructors
Builder
public Builder(@NonNull AlarmInstance alarmInstance)
Constructor for AlarmInstance.Builder with all the existing values.
Builder
public Builder(
@NonNull String namespace,
@NonNull String id,
@NonNull String scheduledTime
)
Constructor for AlarmInstance.Builder.
| Parameters | |
|---|---|
@NonNull String namespace |
Namespace for the Document. See |
@NonNull String id |
Unique identifier for the Document. See |
@NonNull String scheduledTime |
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 methods
addAlternateName
public @NonNull T addAlternateName(@NonNull String alternateName)
Adds an alias for the item.
addPotentialAction
@ExperimentalAppSearchApi
public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)
Add a new action to the list of potential actions for this document.
clearAlternateNames
public @NonNull T clearAlternateNames()
Clears the aliases, if any, for the item.
clearPotentialActions
@ExperimentalAppSearchApi
public @NonNull T clearPotentialActions()
Clear all the potential actions for this document.
setAlternateNames
public @NonNull T setAlternateNames(@Nullable List<String> alternateNames)
Sets a list of aliases for the item.
setCreationTimestampMillis
public @NonNull T setCreationTimestampMillis(long creationTimestampMillis)
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
public @NonNull T setDescription(@Nullable String description)
Sets the description for the item.
setDocumentScore
public @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.
See androidx.appsearch.annotation.Document.Score for more information on score.
setDocumentTtlMillis
public @NonNull T setDocumentTtlMillis(long documentTtlMillis)
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
@ExperimentalAppSearchApi
public @NonNull T setImage(@Nullable String image)
Sets the URL for an image of the item.
setPotentialActions
@ExperimentalAppSearchApi
public @NonNull T setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)
Sets a list of potential actions for this document.
setSnoozeDurationMillis
public @NonNull T setSnoozeDurationMillis(long snoozeDurationMillis)
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
public @NonNull T setStatus(int status)
Sets the current status.
Status can be either STATUS_UNKNOWN, STATUS_SCHEDULED, STATUS_FIRING, STATUS_DISMISSED, STATUS_SNOOZED, or STATUS_MISSED.
setUrl
public @NonNull T setUrl(@Nullable String url)
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.