TakenAction

Kotlin |Java

@Document(name = "builtin:TakenAction")
@ExperimentalAppSearchApi
public abstract class TakenAction

Known direct subclasses

`ClickAction`	`ClickAction` is a built-in AppSearch document type that contains different metrics.
`DismissAction`	`DismissAction` is a built-in AppSearch document type that contains different metrics.
`ImpressionAction`	`ImpressionAction` is a built-in AppSearch document type that contains different metrics.
`SearchAction`	`SearchAction` is a built-in AppSearch document type that contains different metrics.

TakenAction is an abstract class which holds common fields of other AppSearch built-in action types (e.g. SearchAction, ClickAction).

Clients can report the user's actions by creating concrete actions with addTakenActions API.

Summary

Public methods
`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.
`@NonNull String`	`getId()` Returns the unique identifier of the `TakenAction`.
`@NonNull String`	`getNamespace()` Returns the namespace of the `TakenAction`.

public long getActionTimestampMillis()

Returns the timestamp when the user took the action, in milliseconds since Unix epoch.

The action timestamp will be used together with getDocumentTtlMillis as the document retention.

public long getDocumentTtlMillis()

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

public @NonNull String getId()

Returns the unique identifier of the TakenAction.

public @NonNull String getNamespace()

Returns the namespace of the TakenAction.