DismissAction.Builder


@Document.BuilderProducer
public final class DismissAction.Builder


Builder for DismissAction.

Summary

Public constructors

Builder(@NonNull DismissAction dismissAction)

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

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

Constructor for DismissAction.Builder.

Public methods

@NonNull DismissAction

Builds an DismissAction.

@NonNull TakenAction

For AppSearch annotation processor requirement only.

@NonNull T
setDocumentTtlMillis(long documentTtlMillis)

Sets the time-to-live (TTL) of the TakenAction document as a duration in milliseconds.

@NonNull T

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

@NonNull T
setReferencedQualifiedId(@Nullable String referencedQualifiedId)

Sets the qualified id of the androidx.appsearch.app.SearchResult document that the user takes action on.

@NonNull T
setResultRankGlobal(int resultRankGlobal)

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

@NonNull T
setResultRankInBlock(int resultRankInBlock)

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

Protected fields

mQuery

protected String mQuery

mReferencedQualifiedId

protected String mReferencedQualifiedId

mResultRankGlobal

protected int mResultRankGlobal

mResultRankInBlock

protected int mResultRankInBlock

Public constructors

Builder

Added in 1.1.0
public Builder(@NonNull DismissAction dismissAction)

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

Parameters
@NonNull DismissAction dismissAction

an existing DismissAction object.

Builder

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

Constructor for DismissAction.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 DismissAction build()

Builds an DismissAction.

build

Added in 1.1.0
public @NonNull TakenAction build()

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

setDocumentTtlMillis

Added in 1.1.0
public @NonNullsetDocumentTtlMillis(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 @NonNullsetQuery(@Nullable String query)

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

setReferencedQualifiedId

Added in 1.1.0
public @NonNullsetReferencedQualifiedId(@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 @NonNullsetResultRankGlobal(int resultRankGlobal)

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

setResultRankInBlock

Added in 1.1.0
public @NonNullsetResultRankInBlock(int resultRankInBlock)

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