GlobalSearchSession

interface GlobalSearchSession : ReadOnlyGlobalSearchSession, Closeable

Provides a connection to all AppSearch databases the querying application has been granted access to.

In addition to the querying methods available in ReadOnlyGlobalSearchSession, this interface may support write operations such as reportSystemUsageAsync.

All implementations of this interface must be thread safe.

See also
AppSearchSession

Summary

Public functions
Unit

Closes the GlobalSearchSession.
ListenableFuture<OpenBlobForReadResponse!>
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_BLOB_HANDLE)
openBlobForReadAsync(handles: (Mutable)Set<AppSearchBlobHandle!>)

Opens a batch of AppSearch Blobs for reading.
ListenableFuture<Void!>

Reports that a particular document has been used from a system surface.

Inherited functions
From androidx.appsearch.app.ReadOnlyGlobalSearchSession
ListenableFuture<AppSearchBatchResult<String!, GenericDocument!>!>
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.GLOBAL_SEARCH_SESSION_GET_BY_ID)
getByDocumentIdAsync(
    packageName: String,
    databaseName: String,
    request: GetByDocumentIdRequest
)

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.
Features

Returns the Features to check for the availability of certain features for this session.
ListenableFuture<GetSchemaResponse!>
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.GLOBAL_SEARCH_SESSION_GET_SCHEMA)
getSchemaAsync(packageName: String, databaseName: String)

Retrieves the collection of schemas most recently successfully provided to setSchemaAsync for any types belonging to the requested package and database that the caller has been granted access to.
Unit
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.GLOBAL_SEARCH_SESSION_REGISTER_OBSERVER_CALLBACK)
registerObserverCallback(
    targetPackageName: String,
    spec: ObserverSpec,
    executor: Executor,
    observer: ObserverCallback
)

Adds an ObserverCallback to monitor changes within the databases owned by targetPackageName if they match the given androidx.appsearch.observer.ObserverSpec.
SearchResults
search(queryExpression: String, searchSpec: SearchSpec)

Retrieves documents from all AppSearch databases that the querying application has access to.
Unit
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.GLOBAL_SEARCH_SESSION_REGISTER_OBSERVER_CALLBACK)
unregisterObserverCallback(
    targetPackageName: String,
    observer: ObserverCallback
)

Removes previously registered ObserverCallback instances from the system.

Public functions

close

Added in 1.1.0
fun close(): Unit

Closes the GlobalSearchSession.

openBlobForReadAsync

Added in 1.1.0
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_BLOB_HANDLE)
fun openBlobForReadAsync(handles: (Mutable)Set<AppSearchBlobHandle!>): ListenableFuture<OpenBlobForReadResponse!>

Opens a batch of AppSearch Blobs for reading.

See openBlobForReadAsync for a general description when a blob is open 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: (Mutable)Set<AppSearchBlobHandle!>

The AppSearchBlobHandles that identifies the blobs.
Returns
ListenableFuture<OpenBlobForReadResponse!>

a response containing the readable file descriptors.
See also
setPropertyBlobHandle

reportSystemUsageAsync

Added in 1.1.0
fun reportSystemUsageAsync(request: ReportSystemUsageRequest): ListenableFuture<Void!>

Reports that a particular document has been used from a system surface.

See reportUsageAsync for a general description of document usage, as well as an API that can be used by the app itself.

Usage reported via this method is accounted separately from usage reported via reportUsageAsync and may be accessed using the constants RANKING_STRATEGY_SYSTEM_USAGE_COUNT and RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP.

Returns
ListenableFuture<Void!>

The pending result of performing this operation which resolves to null on success. The pending result will be completed with an androidx.appsearch.exceptions.AppSearchException with a code of RESULT_SECURITY_ERROR if this API is invoked by an app which is not part of the system.