EnterpriseGlobalSearchSession

Kotlin |Java

public class EnterpriseGlobalSearchSession
extends Object

java.lang.Object
↳	android.app.appsearch.EnterpriseGlobalSearchSession

Provides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to.

This session can be created from any user profile but will only properly return results when created from the main profile. If the user is not the main profile or an associated work profile does not exist, queries will still successfully complete but with empty results.

Schemas must be explicitly tagged enterprise and may require additional permissions to be visible from an enterprise session. Retrieved documents may also have certain fields restricted or modified unlike if they were retrieved directly from GlobalSearchSession on the work profile.

This class is thread safe.

See also:

GlobalSearchSession

Summary

Public methods
`void`	`getByDocumentId(String packageName, String databaseName, GetByDocumentIdRequest request, Executor executor, BatchResultCallback<String, GenericDocument> callback)` Retrieves `GenericDocument` documents, belonging to the specified package name and database name and identified by the namespace and ids in the request, from the `GlobalSearchSession` database.
`void`	`getSchema(String packageName, String databaseName, Executor executor, Consumer<AppSearchResult<GetSchemaResponse>> callback)` Retrieves the collection of schemas most recently successfully provided to `AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer)` for any types belonging to the requested package and database that the caller has been granted access to.
`void`	`openBlobForRead(Set<AppSearchBlobHandle> handles, Executor executor, Consumer<AppSearchResult<OpenBlobForReadResponse>> callback)` Opens a batch of AppSearch Blobs for reading.
`SearchResults`	`search(String queryExpression, SearchSpec searchSpec)` Retrieves documents from all AppSearch databases that the querying application has access to.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getByDocumentId

Added in API level 35
Also in T Extensions 13

public void getByDocumentId (String packageName, 
                String databaseName, 
                GetByDocumentIdRequest request, 
                Executor executor, 
                BatchResultCallback<String, GenericDocument> callback)

Retrieves GenericDocument documents, belonging to the specified package name and database name and identified by the namespace and ids in the request, from the GlobalSearchSession database.

If the package or database doesn't exist or if the calling package doesn't have access, the gets will be handled as failures in an AppSearchBatchResult object in the callback.

Parameters
`packageName`	`String`: the name of the package to get from This value cannot be `null`.
`databaseName`	`String`: the name of the database to get from This value cannot be `null`.
`request`	`GetByDocumentIdRequest`: a request containing a namespace and IDs to get documents for. This value cannot be `null`.
`executor`	`Executor`: Executor on which to invoke the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	`BatchResultCallback`: Callback to receive the pending result of performing this operation. The keys of the returned `AppSearchBatchResult` are the input IDs. The values are the returned `GenericDocument`s on success, or a failed `AppSearchResult` otherwise. IDs that are not found will return a failed `AppSearchResult` with a result code of `AppSearchResult.RESULT_NOT_FOUND`. If an unexpected internal error occurs in the AppSearch service, `BatchResultCallback.onSystemError` will be invoked with a `Throwable`. This value cannot be `null`.

getSchema

Added in API level 35
Also in T Extensions 13

public void getSchema (String packageName, 
                String databaseName, 
                Executor executor, 
                Consumer<AppSearchResult<GetSchemaResponse>> callback)

Retrieves the collection of schemas most recently successfully provided to AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer) for any types belonging to the requested package and database that the caller has been granted access to.

If the requested package/database combination does not exist or the caller has not been granted access to it, then an empty GetSchemaResponse will be returned.

Parameters
`packageName`	`String`: the package that owns the requested `AppSearchSchema` instances. This value cannot be `null`.
`databaseName`	`String`: the database that owns the requested `AppSearchSchema` instances. This value cannot be `null`.
`executor`	`Executor`: Executor on which to invoke the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	`Consumer`: The pending `GetSchemaResponse` containing the schemas that the caller has access to or an empty GetSchemaResponse if the request package and database does not exist, has not set a schema or contains no schemas that are accessible to the caller. This value cannot be `null`.

openBlobForRead

Added in API level 36
Also in T Extensions 17

public void openBlobForRead (Set<AppSearchBlobHandle> handles, 
                Executor executor, 
                Consumer<AppSearchResult<OpenBlobForReadResponse>> callback)

Opens a batch of AppSearch Blobs for reading.

See AppSearchSession.openBlobForRead for a general description when a blob is for read.

The returned OpenBlobForReadResponse must be closed after use to avoid resource leaks. Failing to close it will result in system file descriptor exhaustion.

Parameters
`handles`	`Set`: The `AppSearchBlobHandle`s that identifies the blobs. This value cannot be `null`.
`executor`	`Executor`: Executor on which to invoke the callback. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`callback`	`Consumer`: Callback to receive the `OpenBlobForReadResponse`. This value cannot be `null`.

See also:

GenericDocument.Builder.setPropertyBlobHandle(String, AppSearchBlobHandle)

search

Added in API level 35
Also in T Extensions 13

public SearchResults search (String queryExpression, 
                SearchSpec searchSpec)

Retrieves documents from all AppSearch databases that the querying application has access to.

Applications can be granted access to documents by specifying SetSchemaRequest.Builder.setSchemaTypeVisibilityForPackage(String, boolean, PackageIdentifier) when building a schema.

Document access can also be granted to system UIs by specifying SetSchemaRequest.Builder.setSchemaTypeDisplayedBySystem(String, boolean) when building a schema.

See AppSearchSession.search for a detailed explanation on forming a query string.

This method is lightweight. The heavy work will be done in SearchResults.getNextPage(Executor, Consumer).

Parameters
`queryExpression`	`String`: query string to search. This value cannot be `null`.
`searchSpec`	`SearchSpec`: spec for setting document filters, adding projection, setting term match type, etc. This value cannot be `null`.

Returns
`SearchResults`	a `SearchResults` object for retrieved matched documents. This value cannot be `null`.