DismissAction.Builder

@Document.BuilderProducer
public final class DismissAction.Builder

Builder for DismissAction.

Summary

Protected fields
long
int
long
final String
final String

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 T
setDocumentTtlMillis(long documentTtlMillis)

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

Sets the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult which impressed the user.
@NonNull DismissAction.Builder
setReferencedQualifiedId(@Nullable String referencedQualifiedId)

Sets the qualified id of the androidx.appsearch.app.SearchResult document that the user takes action on.
@NonNull DismissAction.Builder
setResultRankGlobal(int resultRankGlobal)

Sets the global rank of the androidx.appsearch.app.SearchResult document.
@NonNull DismissAction.Builder
setResultRankInBlock(int resultRankInBlock)

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

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-alpha07
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-alpha07
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-alpha07
public @NonNull DismissAction build()

Builds an DismissAction.

setDocumentTtlMillis

Added in 1.1.0-alpha07
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-alpha07
public @NonNull DismissAction.Builder setQuery(@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-alpha07
public @NonNull DismissAction.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-alpha07
public @NonNull DismissAction.Builder setResultRankGlobal(int resultRankGlobal)

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

See also
getResultRankGlobal

setResultRankInBlock

Added in 1.1.0-alpha07
public @NonNull DismissAction.Builder setResultRankInBlock(int resultRankInBlock)

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

See also
getResultRankInBlock