ClickAction.Builder
@Document.BuilderProducer
class ClickAction.Builder
Builder for ClickAction.
Summary
Public constructors |
|---|
Builder(clickAction: ClickAction)Constructs |
|
Constructor for |
Public functions |
|
|---|---|
ClickAction |
build()Builds a |
T |
setDocumentTtlMillis(documentTtlMillis: Long)Sets the time-to-live (TTL) of the |
ClickAction.Builder |
Sets the user-entered search input (without any operators or rewriting) that yielded the |
ClickAction.Builder |
setReferencedQualifiedId(referencedQualifiedId: String?)Sets the qualified id of the |
ClickAction.Builder |
setResultRankGlobal(resultRankGlobal: Int)Sets the global rank of the |
ClickAction.Builder |
setResultRankInBlock(resultRankInBlock: Int)Sets the rank of the |
ClickAction.Builder |
setTimeStayOnResultMillis(timeStayOnResultMillis: Long)Sets the time in milliseconds that user stays on the |
Public constructors
Builder
Builder(clickAction: ClickAction)
Constructs ClickAction.Builder by copying existing values from the given ClickAction.
| Parameters | |
|---|---|
clickAction: ClickAction |
an existing |
Builder
Builder(namespace: String, id: String, actionTimestampMillis: Long)
Constructor for ClickAction.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
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?): ClickAction.Builder
Sets the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult on which the user clicked.
setReferencedQualifiedId
fun setReferencedQualifiedId(referencedQualifiedId: String?): ClickAction.Builder
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): ClickAction.Builder
Sets the global rank of the androidx.appsearch.app.SearchResult document.
| See also | |
|---|---|
getResultRankGlobal |
setResultRankInBlock
fun setResultRankInBlock(resultRankInBlock: Int): ClickAction.Builder
Sets the rank of the androidx.appsearch.app.SearchResult document among the user-defined block.
| See also | |
|---|---|
getResultRankInBlock |
setTimeStayOnResultMillis
fun setTimeStayOnResultMillis(timeStayOnResultMillis: Long): ClickAction.Builder
Sets the time in milliseconds that user stays on the androidx.appsearch.app.SearchResult document after clicking it.