Added in API level 31

Builder


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

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

SearchResult.Builder

Adds a SearchResult that was joined by the JoinSpec.

SearchResult.Builder

Adds another match to this SearchResult.

SearchResult

Constructs a new SearchResult.

SearchResult.Builder

Sets the document which matched.

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

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

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.

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.