DismissAction.Builder
@Document.BuilderProducer
class DismissAction.Builder
Builder for DismissAction.
Summary
Public constructors |
|---|
Builder(dismissAction: DismissAction)Constructs |
|
Constructor for |
Public functions |
|
|---|---|
DismissAction |
build()Builds an |
TakenAction |
build()For AppSearch annotation processor requirement only. |
T |
setDocumentTtlMillis(documentTtlMillis: Long)Sets the time-to-live (TTL) of the |
T |
Sets the user-entered search input (without any operators or rewriting) that yielded the |
T |
setReferencedQualifiedId(referencedQualifiedId: String?)Sets the qualified id of the |
T |
setResultRankGlobal(resultRankGlobal: Int)Sets the global rank of the |
T |
setResultRankInBlock(resultRankInBlock: Int)Sets the rank of the |
Public constructors
Builder
Builder(dismissAction: DismissAction)
Constructs DismissAction.Builder by copying existing values from the given DismissAction.
| Parameters | |
|---|---|
dismissAction: DismissAction |
an existing |
Builder
Builder(namespace: String, id: String, actionTimestampMillis: Long)
Constructor for DismissAction.Builder.
| Parameters | |
|---|---|
namespace: String |
Namespace for the Document. See |
id: String |
Unique identifier for the Document. See |
actionTimestampMillis: Long |
The timestamp when the user took the action, in milliseconds since Unix epoch. |
Public functions
build
fun build(): TakenAction
For AppSearch annotation processor requirement only. The client should never call it since it is impossible to instantiate an abstract class.
setDocumentTtlMillis
fun setDocumentTtlMillis(documentTtlMillis: Long): T
Sets the time-to-live (TTL) of the TakenAction document as a duration in milliseconds.
The document will be automatically deleted when the TTL expires (since getActionTimestampMillis).
The default TTL for TakenAction document is 60 days.
See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.
setQuery
fun setQuery(query: String?): T
Sets the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult which impressed the user.
setReferencedQualifiedId
fun setReferencedQualifiedId(referencedQualifiedId: String?): T
Sets the qualified id of the androidx.appsearch.app.SearchResult document that the user takes action on.
A qualified id is a string generated by package, database, namespace, and document id. See createQualifiedId for more details.
setResultRankGlobal
fun setResultRankGlobal(resultRankGlobal: Int): T
Sets the global rank of the androidx.appsearch.app.SearchResult document.
| See also | |
|---|---|
getResultRankGlobal |
setResultRankInBlock
fun setResultRankInBlock(resultRankInBlock: Int): T
Sets the rank of the androidx.appsearch.app.SearchResult document among the user-defined block.
| See also | |
|---|---|
getResultRankInBlock |