PlatformStorage.SearchContext.Builder
class PlatformStorage.SearchContext.Builder
Builder for SearchContext objects.
Summary
Public constructors |
|---|
|
Creates a |
Public functions |
|
|---|---|
PlatformStorage.SearchContext |
build()Builds a |
PlatformStorage.SearchContext.Builder |
setWorkerExecutor(executor: Executor)Sets the worker executor associated with |
Public constructors
Builder
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
fun build(): PlatformStorage.SearchContext
Builds a SearchContext instance.
setWorkerExecutor
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. |