ActionAccumulator
@ExperimentalAppSearchApi
public 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 methods |
|
|---|---|
void |
Cancels timers and so we can test initialization/shutdown. |
static @NonNull ListenableFuture<ActionAccumulator> |
createAsync(Factory method to create an ActionAccumulator. |
@NonNull File |
Returns the cache file to use for on-disk caching. |
@NonNull ListenableFuture<AppSearchBatchResult<String, Void>> |
reportActionAsync(@NonNull TakenAction takenAction)Reports a |
@NonNull ListenableFuture<AppSearchBatchResult<String, Void>> |
Saves the documents in the cache to AppSearch and deletes the cache file. |
Public methods
cancelTimer
@VisibleForTesting
public void cancelTimer()
Cancels timers and so we can test initialization/shutdown. This simulates closing the app using the ActionAccumulator
createAsync
public static @NonNull ListenableFuture<ActionAccumulator> createAsync(
@NonNull Context context,
@NonNull AppSearchSession appSearchSession,
@NonNull Executor executor
)
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
public @NonNull File getCacheFile()
Returns the cache file to use for on-disk caching.
reportActionAsync
public @NonNull ListenableFuture<AppSearchBatchResult<String, Void>> reportActionAsync(@NonNull TakenAction takenAction)
Reports a TakenAction and restarts the flush timer.
saveDocumentsToAppSearchAsync
public @NonNull ListenableFuture<AppSearchBatchResult<String, Void>> saveDocumentsToAppSearchAsync()
Saves the documents in the cache to AppSearch and deletes the cache file.