ClickAction.Builder

@Document.BuilderProducer
class ClickAction.Builder

Builder for ClickAction.

Summary

Public constructors
Builder(clickAction: ClickAction)

Constructs ClickAction.Builder by copying existing values from the given ClickAction.
Builder(namespace: String, id: String, actionTimestampMillis: Long)

Constructor for ClickAction.Builder.

Public functions
ClickAction

Builds a ClickAction.
TakenAction

For AppSearch annotation processor requirement only.
T
setDocumentTtlMillis(documentTtlMillis: Long)

Sets the time-to-live (TTL) of the TakenAction document as a duration in milliseconds.
T
setQuery(query: String?)

Sets the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult on which the user clicked.
T
setReferencedQualifiedId(referencedQualifiedId: String?)

Sets the qualified id of the androidx.appsearch.app.SearchResult document that the user takes action on.
T
setResultRankGlobal(resultRankGlobal: Int)

Sets the global rank of the androidx.appsearch.app.SearchResult document.
T
setResultRankInBlock(resultRankInBlock: Int)

Sets the rank of the androidx.appsearch.app.SearchResult document among the user-defined block.
T
setTimeStayOnResultMillis(timeStayOnResultMillis: Long)

Sets the time in milliseconds that user stays on the androidx.appsearch.app.SearchResult document after clicking it.

Public constructors

Builder

Added in 1.1.0
Builder(clickAction: ClickAction)

Constructs ClickAction.Builder by copying existing values from the given ClickAction.

Parameters
clickAction: ClickAction

an existing ClickAction object.

Builder

Added in 1.1.0
Builder(namespace: String, id: String, actionTimestampMillis: Long)

Constructor for ClickAction.Builder.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.
id: String

Unique identifier for the Document. See Document.Id.
actionTimestampMillis: Long

The timestamp when the user took the action, in milliseconds since Unix epoch.

Public functions

build

Added in 1.1.0
fun build(): ClickAction

Builds a ClickAction.

build

Added in 1.1.0
fun build(): TakenAction

For AppSearch annotation processor requirement only. The client should never call it since it is impossible to instantiate an abstract class.

Throws
java.lang.UnsupportedOperationException

setDocumentTtlMillis

Added in 1.1.0
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

Added in 1.1.0
fun setQuery(query: String?): T

Sets the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult on which the user clicked.

setReferencedQualifiedId

Added in 1.1.0
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

Added in 1.1.0
fun setResultRankGlobal(resultRankGlobal: Int): T

Sets the global rank of the androidx.appsearch.app.SearchResult document.

See also
getResultRankGlobal

setResultRankInBlock

Added in 1.1.0
fun setResultRankInBlock(resultRankInBlock: Int): T

Sets the rank of the androidx.appsearch.app.SearchResult document among the user-defined block.

See also
getResultRankInBlock

setTimeStayOnResultMillis

Added in 1.1.0
fun setTimeStayOnResultMillis(timeStayOnResultMillis: Long): T

Sets the time in milliseconds that user stays on the androidx.appsearch.app.SearchResult document after clicking it.