SearchAction

Artifact: androidx.appsearch:appsearch

View Source

Added in 1.1.0-alpha04

---

Kotlin |Java

@Document(name = "builtin:SearchAction")
class SearchAction : TakenAction

kotlin.Any
↳	androidx.appsearch.usagereporting.TakenAction
	↳	androidx.appsearch.usagereporting.SearchAction

---

SearchAction is a built-in AppSearch document type that contains different metrics.

• Clients can report the user's search actions.
• Usually SearchAction is reported together with ClickAction, since the user clicks on androidx.appsearch.app.SearchResult documents after searching.

In order to use this document type, the client must explicitly set this schema type via addDocumentClasses.

Since SearchAction is an AppSearch document, the client can handle deletion via removeAsync or document time-to-live (TTL). The default TTL is 60 days.

Summary

Nested types
@Document.BuilderProducer class SearchAction.Builder Builder for SearchAction.

Public functions
Int	getFetchedResultCount() Returns total number of results fetched from AppSearch by the client in this SearchAction.
String?	getQuery() Returns the user-entered search input (without any operators or rewriting).

Inherited functions

From androidx.appsearch.usagereporting.TakenAction Long getActionTimestampMillis() Returns the timestamp when the user took the action, in milliseconds since Unix epoch. Long getDocumentTtlMillis() Returns the time-to-live (TTL) of the TakenAction document as a duration in milliseconds. String getId() Returns the unique identifier of the TakenAction. String getNamespace() Returns the namespace of the TakenAction.

Public functions

getFetchedResultCount

Added in 1.1.0-alpha04

fun getFetchedResultCount(): Int

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

If unset, then it will be set to -1 to mark invalid.

getQuery

Added in 1.1.0-alpha04

fun getQuery(): String?

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