Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.app.appsearch.SearchResult.Builder

Builder for SearchResult objects.

Summary

Public constructors
`Builder(packageName: String, databaseName: String)` Constructs a new builder for `SearchResult` objects.

Public methods
SearchResult.Builder	`addInformationalRankingSignal(rankingSignal: Double)` Adds the informational ranking signal of the matched document in this SearchResult.
SearchResult.Builder	`addJoinedResult(joinedResult: SearchResult)` Adds a `SearchResult` that was joined by the `JoinSpec`.
SearchResult.Builder	`addMatchInfo(matchInfo: SearchResult.MatchInfo)` Adds another match to this SearchResult.
SearchResult	`build()` Constructs a new `SearchResult`.
SearchResult.Builder	`setGenericDocument(document: GenericDocument)` Sets the document which matched.
SearchResult.Builder	`setParentTypeMap(parentTypeMap: MutableMap<String!, MutableList<String!>!>)` Sets the map from schema type names to the list of their parent types.
SearchResult.Builder	`setRankingSignal(rankingSignal: Double)` Sets the ranking signal of the matched document in this SearchResult.

Public constructors

Builder

Added in API level 31

Builder(
    packageName: String, 
    databaseName: String)

Constructs a new builder for SearchResult objects.

Parameters
`packageName`	String: the package name the matched document belongs to This value cannot be `null`.
`databaseName`	String: the database name the matched document belongs to. This value cannot be `null`.

Public methods

addInformationalRankingSignal

Added in T Extensions 16

fun addInformationalRankingSignal(rankingSignal: Double): SearchResult.Builder

Adds the informational ranking signal of the matched document in this SearchResult.

Return
`SearchResult.Builder`	This value cannot be `null`.

addJoinedResult

Added in API level 34
Also in T Extensions 7

fun addJoinedResult(joinedResult: SearchResult): SearchResult.Builder

Adds a SearchResult that was joined by the JoinSpec.

Parameters
`joinedResult`	SearchResult: The joined SearchResult to add. This value cannot be `null`.

Return
`SearchResult.Builder`	This value cannot be `null`.

addMatchInfo

Added in API level 31

fun addMatchInfo(matchInfo: SearchResult.MatchInfo): SearchResult.Builder

Adds another match to this SearchResult.

Parameters
`matchInfo`	SearchResult.MatchInfo: This value cannot be `null`.

Return
`SearchResult.Builder`	This value cannot be `null`.

build

Added in API level 31

fun build(): SearchResult

Constructs a new SearchResult.

Return
`SearchResult`	This value cannot be `null`.

setGenericDocument

Added in API level 31

fun setGenericDocument(document: GenericDocument): SearchResult.Builder

Sets the document which matched.

Parameters
`document`	GenericDocument: This value cannot be `null`.

Return
`SearchResult.Builder`	This value cannot be `null`.

setParentTypeMap

Added in API level Baklava

fun setParentTypeMap(parentTypeMap: MutableMap<String!, MutableList<String!>!>): SearchResult.Builder

Sets the map from schema type names to the list of their parent types.

The map should include entries for the GenericDocument's own type and all of the nested documents' types.

Child types must appear before parent types in each list. Otherwise, the GenericDocument's toDocumentClass method (an AndroidX-only API) may not correctly identify the most concrete type. This could lead to unintended deserialization into a more general type instead of a more specific type.

Parent types should include transitive parents.

Parameters
`parentTypeMap`	MutableMap<String!, MutableList<String!>!>: This value cannot be `null`.

Return
`SearchResult.Builder`	This value cannot be `null`.

setRankingSignal

Added in API level 31

fun setRankingSignal(rankingSignal: Double): SearchResult.Builder

Sets the ranking signal of the matched document in this SearchResult.

Return
`SearchResult.Builder`	This value cannot be `null`.