AppSearchSession.RemoveBlob Method

Definition

Removes the blob data from AppSearch.

[Android.Runtime.Register("removeBlob", "(Ljava/util/Set;Ljava/util/concurrent/Executor;Ljava/util/function/Consumer;)V", "", ApiSince=36)]
public void RemoveBlob(System.Collections.Generic.ICollection<Android.App.AppSearch.AppSearchBlobHandle> handles, Java.Util.Concurrent.IExecutor executor, Java.Util.Functions.IConsumer callback);
[<Android.Runtime.Register("removeBlob", "(Ljava/util/Set;Ljava/util/concurrent/Executor;Ljava/util/function/Consumer;)V", "", ApiSince=36)>]
member this.RemoveBlob : System.Collections.Generic.ICollection<Android.App.AppSearch.AppSearchBlobHandle> * Java.Util.Concurrent.IExecutor * Java.Util.Functions.IConsumer -> unit

Parameters

handles
ICollection<AppSearchBlobHandle>

The AppSearchBlobHandles that identifies the blobs.

executor
IExecutor

Executor on which to invoke the callback.

callback
IConsumer

Callback to receive the CommitBlobResponse.

Attributes

Remarks

Removes the blob data from AppSearch.

After this call, the blob data is removed immediately and cannot be recovered. It will not accessible via #openBlobForRead. #openBlobForWrite could reopen and rewrite it.

This API can be used to remove pending blob data and committed blob data.

Removing a committed blob data that is still referenced by documents will leave those documents with no readable blob content. It is highly recommended to let AppSearch control the blob data's life cycle. AppSearch automatically recycles orphaned and pending blob data. The default time to recycle pending and orphan blob file is 1 week. A blob file will be considered as an orphan if no GenericDocument references it. If you want to remove a committed blob data, you should remove the reference documents first.

Java documentation for android.app.appsearch.AppSearchSession.removeBlob(java.util.Set<android.app.appsearch.AppSearchBlobHandle>, java.util.concurrent.Executor, java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.RemoveBlobResponse>>).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to