ClickAction.Builder

protected long mActionTimestampMillis

protected int mActionType

protected long mDocumentTtlMillis

protected final String mId

protected final String mNamespace

public Builder(@NonNull ClickAction clickAction)

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

public Builder(
    @NonNull String namespace,
    @NonNull String id,
    long actionTimestampMillis
)

Constructor for ClickAction.Builder.

public @NonNull ClickAction build()

Builds a ClickAction.

public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

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.

public @NonNull ClickAction.Builder setQuery(@Nullable String query)

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

public @NonNull ClickAction.Builder setReferencedQualifiedId(@Nullable String referencedQualifiedId)

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.

public @NonNull ClickAction.Builder setResultRankGlobal(int resultRankGlobal)

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

public @NonNull ClickAction.Builder setResultRankInBlock(int resultRankInBlock)

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

public @NonNull ClickAction.Builder setTimeStayOnResultMillis(long timeStayOnResultMillis)

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