SearchResult.Builder

Kotlin |Java

class SearchResult.Builder

Builder for SearchResult objects.

Summary

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

Public functions
`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`	`setDocument(document: Any)` Sets the document which matched.
`SearchResult.Builder`	`setGenericDocument(document: GenericDocument)` Sets the document which matched.
`SearchResult.Builder`	`setRankingSignal(rankingSignal: Double)` Sets the ranking signal of the matched document in this SearchResult.

Builder(packageName: String, databaseName: String)

Constructs a new builder for SearchResult objects.

Parameters
`packageName: String`	the package name the matched document belongs to
`databaseName: String`	the database name the matched document belongs to.

fun addInformationalRankingSignal(rankingSignal: Double): SearchResult.Builder

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

fun addJoinedResult(joinedResult: SearchResult): SearchResult.Builder

Adds a SearchResult that was joined by the JoinSpec.

Parameters
`joinedResult: SearchResult`	The joined SearchResult to add.

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

Adds another match to this SearchResult.

fun build(): SearchResult

Constructs a new SearchResult.

fun setDocument(document: Any): SearchResult.Builder

Sets the document which matched.

Parameters
`document: Any`	An instance of a class annotated with `androidx.appsearch.annotation.Document`.

Throws
`androidx.appsearch.exceptions.AppSearchException`	if an error occurs converting a document class into a `GenericDocument`.

fun setGenericDocument(document: GenericDocument): SearchResult.Builder

Sets the document which matched.

fun setRankingSignal(rankingSignal: Double): SearchResult.Builder

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