ClickAction.Builder

Added in 1.1.0

Kotlin |Java

@Document.BuilderProducer
public final class ClickAction.Builder

Builder for ClickAction.

Summary

Protected fields
`long`	`mActionTimestampMillis`
`int`	`mActionType`
`long`	`mDocumentTtlMillis`
`final String`	`mId`
`final String`	`mNamespace`

Public constructors
`Builder(@NonNull ClickAction clickAction)` Constructs `ClickAction.Builder` by copying existing values from the given `ClickAction`.
`Builder( @NonNull String namespace, @NonNull String id, long actionTimestampMillis )` Constructor for `ClickAction.Builder`.

Public methods
`@NonNull ClickAction`	`build()` Builds a `ClickAction`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) of the `TakenAction` document as a duration in milliseconds.
`@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.
`@NonNull ClickAction.Builder`	`setReferencedQualifiedId(@Nullable String referencedQualifiedId)` Sets the qualified id of the `androidx.appsearch.app.SearchResult` document that the user takes action on.
`@NonNull ClickAction.Builder`	`setResultRankGlobal(int resultRankGlobal)` Sets the global rank of the `androidx.appsearch.app.SearchResult` document.
`@NonNull ClickAction.Builder`	`setResultRankInBlock(int resultRankInBlock)` Sets the rank of the `androidx.appsearch.app.SearchResult` document among the user-defined block.
`@NonNull ClickAction.Builder`	`setTimeStayOnResultMillis(long timeStayOnResultMillis)` Sets the time in milliseconds that user stays on the `androidx.appsearch.app.SearchResult` document after clicking it.

Protected fields

mActionTimestampMillis

protected long mActionTimestampMillis

mActionType

protected int mActionType

mDocumentTtlMillis

protected long mDocumentTtlMillis

mId

protected final String mId

mNamespace

protected final String mNamespace

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull ClickAction clickAction)

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

Parameters
`@NonNull ClickAction clickAction`	an existing `ClickAction` object.

Builder

Added in 1.1.0

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

Constructor for ClickAction.Builder.

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the Document. See `Document.Id`.
`long actionTimestampMillis`	The timestamp when the user took the action, in milliseconds since Unix epoch.

Public methods

build

Added in 1.1.0

public @NonNull ClickAction build()

Builds a ClickAction.

setDocumentTtlMillis

Added in 1.1.0

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.

setQuery

Added in 1.1.0

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.

setReferencedQualifiedId

Added in 1.1.0

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.

setResultRankGlobal

Added in 1.1.0

public @NonNull ClickAction.Builder setResultRankGlobal(int resultRankGlobal)

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

See also
`getResultRankGlobal`

setResultRankInBlock

Added in 1.1.0

public @NonNull ClickAction.Builder setResultRankInBlock(int resultRankInBlock)

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

See also
`getResultRankInBlock`

setTimeStayOnResultMillis

Added in 1.1.0

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.