TakenAction.BuilderBase

Kotlin |Java

@ExperimentalAppSearchApi
class TakenAction.BuilderBase<T : TakenAction.BuilderBase<T!>?>

Known direct subclasses

`ClickAction.BuilderBase`	Builder for `ClickAction`.
`DismissAction.BuilderBase`	Builder for `DismissAction`.
`ImpressionAction.BuilderBase`	Builder for `ImpressionAction`.
`SearchAction.BuilderBase`	Builder for `SearchAction`.

Known indirect subclasses

`ClickAction.Builder`	Builder for `ClickAction`.
`DismissAction.Builder`	Builder for `DismissAction`.
`ImpressionAction.Builder`	Builder for `ImpressionAction`.
`SearchAction.Builder`	Builder for `SearchAction`.

Builder for TakenAction.

Summary

Public constructors
`BuilderBase(takenAction: TakenAction)` Constructs `TakenAction.BuilderBase` by copying existing values from the given `TakenAction`.
`BuilderBase( namespace: String, id: String, actionTimestampMillis: Long, actionType: Int )` Constructs `TakenAction.BuilderBase` with given `namespace`, `id`, `actionTimestampMillis` and `actionType`.

Public functions
`TakenAction`	`build()` For AppSearch annotation processor requirement only.
`T`	`setDocumentTtlMillis(documentTtlMillis: Long)` Sets the time-to-live (TTL) of the `TakenAction` document as a duration in milliseconds.

BuilderBase(takenAction: TakenAction)

Constructs TakenAction.BuilderBase by copying existing values from the given TakenAction.

Parameters
`takenAction: TakenAction`	an existing `TakenAction` object.

BuilderBase(
    namespace: String,
    id: String,
    actionTimestampMillis: Long,
    actionType: Int
)

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

Parameters
`namespace: String`	The namespace of the `TakenAction` document.
`id: String`	The id of the `TakenAction` document.
`actionTimestampMillis: Long`	The timestamp when the user took the action, in milliseconds since Unix epoch.
`actionType: Int`	The action type enum of the Document.

fun build(): TakenAction

For AppSearch annotation processor requirement only. The client should never call it since it is impossible to instantiate an abstract class.

Throws
`java.lang.UnsupportedOperationException`

fun setDocumentTtlMillis(documentTtlMillis: Long): T

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.