ActionAccumulator
@ExperimentalAppSearchApi
class ActionAccumulator
Base class that accumulates SearchAction and ClickAction documents and stores them into AppSearch, either immediately or after a timeout.
| See also | |
|---|---|
ClickAction |
|
SearchAction |
|
TakenAction |
Summary
Public functions |
|
|---|---|
Unit |
Cancels timers and so we can test initialization/shutdown. |
java-static ListenableFuture<ActionAccumulator!> |
createAsync(Factory method to create an ActionAccumulator. |
File |
Returns the cache file to use for on-disk caching. |
ListenableFuture<AppSearchBatchResult<String!, Void!>!> |
reportActionAsync(takenAction: TakenAction)Reports a |
ListenableFuture<AppSearchBatchResult<String!, Void!>!> |
Saves the documents in the cache to AppSearch and deletes the cache file. |
Public functions
cancelTimer
@VisibleForTesting
fun cancelTimer(): Unit
Cancels timers and so we can test initialization/shutdown. This simulates closing the app using the ActionAccumulator
createAsync
java-static fun createAsync(
context: Context,
appSearchSession: AppSearchSession,
executor: Executor
): ListenableFuture<ActionAccumulator!>
Factory method to create an ActionAccumulator.
Initializing and using the ActionAccumulator requires that the provided AppSearchSession has a database where SearchAction and ClickAction are set.
| Throws | |
|---|---|
java.util.concurrent.ExecutionException |
if either |
getCacheFile
@VisibleForTesting
fun getCacheFile(): File
Returns the cache file to use for on-disk caching.
reportActionAsync
fun reportActionAsync(takenAction: TakenAction): ListenableFuture<AppSearchBatchResult<String!, Void!>!>
Reports a TakenAction and restarts the flush timer.
saveDocumentsToAppSearchAsync
fun saveDocumentsToAppSearchAsync(): ListenableFuture<AppSearchBatchResult<String!, Void!>!>
Saves the documents in the cache to AppSearch and deletes the cache file.