DismissAction.Builder


@Document.BuilderProducer
public final class DismissAction.Builder extends DismissAction.BuilderBase


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.

Inherited methods

From androidx.appsearch.usagereporting.DismissAction.BuilderBase
@NonNull DismissAction

Builds an DismissAction.

@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.

From androidx.appsearch.usagereporting.TakenAction.BuilderBase
@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.

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.