SearchAction.BuilderBase

Kotlin |Java

@ExperimentalAppSearchApi
public class SearchAction.BuilderBase<T extends SearchAction.BuilderBase<T>> extends TakenAction.BuilderBase

java.lang.Object
↳	androidx.appsearch.usagereporting.TakenAction.BuilderBase
	↳	androidx.appsearch.usagereporting.SearchAction.BuilderBase

Known direct subclasses

SearchAction.Builder

Builder for SearchAction.

Summary

Public constructors
`BuilderBase(@NonNull SearchAction searchAction)` Constructor for `SearchAction.BuilderBase` with all the existing values.
`BuilderBase( @NonNull String namespace, @NonNull String id, long actionTimestampMillis )` Constructs `SearchAction.BuilderBase` with given `namespace`, `id`, and `actionTimestampMillis`.
`BuilderBase( @NonNull String namespace, @NonNull String id, long actionTimestampMillis, int actionType )` Constructs `SearchAction.BuilderBase` with given `namespace`, `id`, `actionTimestampMillis` and `actionType`.

Public methods
`@NonNull SearchAction`	`build()` Builds a `SearchAction`.
`@NonNull T`	`setFetchedResultCount(int fetchedResultCount)` Sets total number of results fetched from AppSearch by the client in this `SearchAction`.
`@NonNull T`	`setQuery(@Nullable String query)` Sets the user-entered search input (without any operators or rewriting).

@NonNull T

setDocumentTtlMillis(long documentTtlMillis)

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

public BuilderBase(@NonNull SearchAction searchAction)

Constructor for SearchAction.BuilderBase with all the existing values.

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

Constructs SearchAction.BuilderBase with given namespace, id, and actionTimestampMillis.

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 BuilderBase(
    @NonNull String namespace,
    @NonNull String id,
    long actionTimestampMillis,
    int actionType
)

Constructs SearchAction.BuilderBase with given namespace, id, actionTimestampMillis and actionType.

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.
`int actionType`	Action type enum for the Document. See `TakenAction.ActionType`.

public @NonNull SearchAction build()

public @NonNull T setFetchedResultCount(int fetchedResultCount)

Sets total number of results fetched from AppSearch by the client in this SearchAction.

See also
`getFetchedResultCount`

public @NonNull T setQuery(@Nullable String query)

Sets the user-entered search input (without any operators or rewriting).