SearchResult.Builder

public static final class SearchResult.Builder
extends Object

java.lang.Object
   ↳ android.app.appsearch.SearchResult.Builder


Builder for SearchResult objects.

Summary

Public constructors

Builder(String packageName, String databaseName)

Constructs a new builder for SearchResult objects.

Public methods

SearchResult.Builder addJoinedResult(SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

SearchResult.Builder addMatchInfo(SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

SearchResult build()

Constructs a new SearchResult.

SearchResult.Builder setGenericDocument(GenericDocument document)

Sets the document which matched.

SearchResult.Builder setRankingSignal(double rankingSignal)

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

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder (String packageName, 
                String databaseName)

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

addJoinedResult

Added in API level 34
public SearchResult.Builder addJoinedResult (SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

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

Returns
SearchResult.Builder This value cannot be null.

addMatchInfo

Added in API level 31
public SearchResult.Builder addMatchInfo (SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

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

Returns
SearchResult.Builder This value cannot be null.

build

Added in API level 31
public SearchResult build ()

Constructs a new SearchResult.

Returns
SearchResult This value cannot be null.

setGenericDocument

Added in API level 31
public SearchResult.Builder setGenericDocument (GenericDocument document)

Sets the document which matched.

Parameters
document GenericDocument: This value cannot be null.

Returns
SearchResult.Builder This value cannot be null.

setRankingSignal

Added in API level 31
public SearchResult.Builder setRankingSignal (double rankingSignal)

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

Parameters
rankingSignal double

Returns
SearchResult.Builder This value cannot be null.