PlatformStorage.SearchContext.Builder

class PlatformStorage.SearchContext.Builder


Builder for SearchContext objects.

Summary

Public constructors

Builder(context: Context, databaseName: String)

Creates a SearchContext.Builder instance.

Public functions

PlatformStorage.SearchContext

Builds a SearchContext instance.

PlatformStorage.SearchContext.Builder

Sets the worker executor associated with AppSearchSession.

Public constructors

Builder

Added in 1.1.0-alpha04
Builder(context: Context, databaseName: String)

Creates a SearchContext.Builder instance.

AppSearchSession will create or open a database under the given name.

Databases with different names are fully separate with distinct schema types, namespaces, and documents.

The database name cannot contain '/'.

The database name will be visible to all system UI or third-party applications that have been granted access to any of the database's documents (for example, using setSchemaTypeVisibilityForPackage).

Parameters
databaseName: String

The name of the database.

Throws
java.lang.IllegalArgumentException

if the databaseName contains '/'.

Public functions

build

Added in 1.1.0-alpha04
fun build(): PlatformStorage.SearchContext

Builds a SearchContext instance.

setWorkerExecutor

Added in 1.1.0-alpha04
fun setWorkerExecutor(executor: Executor): PlatformStorage.SearchContext.Builder

Sets the worker executor associated with AppSearchSession.

If an executor is not provided, the AppSearch default executor will be used.

Parameters
executor: Executor

the worker executor used to run heavy background tasks.