AppSearchSession.GetByDocumentId Method

Definition

Gets GenericDocument objects by document IDs in a namespace from the AppSearchSession database.

[Android.Runtime.Register("getByDocumentId", "(Landroid/app/appsearch/GetByDocumentIdRequest;Ljava/util/concurrent/Executor;Landroid/app/appsearch/BatchResultCallback;)V", "", ApiSince=31)]
public void GetByDocumentId(Android.App.AppSearch.GetByDocumentIdRequest request, Java.Util.Concurrent.IExecutor executor, Android.App.AppSearch.IBatchResultCallback callback);
[<Android.Runtime.Register("getByDocumentId", "(Landroid/app/appsearch/GetByDocumentIdRequest;Ljava/util/concurrent/Executor;Landroid/app/appsearch/BatchResultCallback;)V", "", ApiSince=31)>]
member this.GetByDocumentId : Android.App.AppSearch.GetByDocumentIdRequest * Java.Util.Concurrent.IExecutor * Android.App.AppSearch.IBatchResultCallback -> unit

Parameters

request
GetByDocumentIdRequest

a request containing a namespace and IDs to get documents for.

executor
IExecutor

Executor on which to invoke the callback.

callback
IBatchResultCallback

Callback to receive the pending result of performing this operation. The keys of the AppSearchBatchResult represent the input document IDs from the GetByDocumentIdRequest object. The values are either the corresponding GenericDocument object for the ID on success, or an AppSearchResult object on failure. For example, if an ID is not found, the value for that ID will be set to an AppSearchResult object with result code: AppSearchResult#RESULT_NOT_FOUND. If an unexpected internal error occurs in the AppSearch service, BatchResultCallback#onSystemError will be invoked with a Throwable.

Attributes

Remarks

Gets GenericDocument objects by document IDs in a namespace from the AppSearchSession database.

Java documentation for android.app.appsearch.AppSearchSession.getByDocumentId(android.app.appsearch.GetByDocumentIdRequest, java.util.concurrent.Executor, android.app.appsearch.BatchResultCallback<java.lang.String, android.app.appsearch.GenericDocument>).

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