SearchResult

Kotlin |Java

class SearchResult : Parcelable

kotlin.Any
↳	android.app.appsearch.SearchResult

This class represents one of the results obtained from an AppSearch query.

This allows clients to obtain:

The document which matched, using getGenericDocument
Information about which properties in the document matched, and "snippet" information containing textual summaries of the document's matches, using getMatchInfos

"Snippet" refers to a substring of text from the content of document that is returned as a part of search result.

Summary

Nested classes
	`Builder` Builder for `SearchResult` objects.
	`MatchInfo` This class represents match objects for any snippets that might be present in `SearchResults` from a query.
	`MatchRange` Class providing the position range of matching information.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
String	`getDatabaseName()` Contains the database name that stored the `GenericDocument`.
GenericDocument	`getGenericDocument()` Contains the matching `GenericDocument`.
MutableList<SearchResult!>	`getJoinedResults()` Gets a list of `SearchResult` joined from the join operation.
MutableList<SearchResult.MatchInfo!>	`getMatchInfos()` Returns a list of `MatchInfo`s providing information about how the document in `getGenericDocument` matched the query.
String	`getPackageName()` Contains the package name of the app that stored the `GenericDocument`.
Double	`getRankingSignal()` Returns the ranking signal of the `GenericDocument`, according to the ranking strategy set in `SearchSpec.Builder#setRankingStrategy(int)`.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<SearchResult!>	`CREATOR`

Public methods

getDatabaseName

Added in API level 31

fun getDatabaseName(): String

Contains the database name that stored the GenericDocument.

Return
`String`	Name of the database within which the document is stored This value cannot be `null`.

getGenericDocument

Added in API level 31

fun getGenericDocument(): GenericDocument

Contains the matching GenericDocument.

Return
`GenericDocument`	Document object which matched the query. This value cannot be `null`.

getJoinedResults

Added in API level 34

fun getJoinedResults(): MutableList<SearchResult!>

Gets a list of SearchResult joined from the join operation.

These joined documents match the outer document as specified in the JoinSpec with parentPropertyExpression and childPropertyExpression. They are ordered according to the JoinSpec#getNestedSearchSpec, and as many SearchResults as specified by android.app.appsearch.JoinSpec#getMaxJoinedResultCount will be returned. If no JoinSpec was specified, this returns an empty list.

This method is inefficient to call repeatedly, as new SearchResult objects are created each time.

Return
`MutableList<SearchResult!>`	a List of SearchResults containing joined documents. This value cannot be `null`.

getMatchInfos

Added in API level 31

fun getMatchInfos(): MutableList<SearchResult.MatchInfo!>

Returns a list of MatchInfos providing information about how the document in getGenericDocument matched the query.

Return
`MutableList<SearchResult.MatchInfo!>`	List of matches based on `SearchSpec`. If snippeting is disabled using `android.app.appsearch.SearchSpec.Builder#setSnippetCount` or `android.app.appsearch.SearchSpec.Builder#setSnippetCountPerProperty`, for all results after that value, this method returns an empty list. This value cannot be `null`.

getPackageName

Added in API level 31

fun getPackageName(): String

Contains the package name of the app that stored the GenericDocument.

Return
`String`	Package name that stored the document This value cannot be `null`.

getRankingSignal

Added in API level 31

fun getRankingSignal(): Double

Returns the ranking signal of the GenericDocument, according to the ranking strategy set in SearchSpec.Builder#setRankingStrategy(int).

The meaning of the ranking signal and its value is determined by the selected ranking strategy:

SearchSpec#RANKING_STRATEGY_NONE - this value will be 0
SearchSpec#RANKING_STRATEGY_DOCUMENT_SCORE - the value returned by calling GenericDocument#getScore() on the document returned by getGenericDocument()
SearchSpec#RANKING_STRATEGY_CREATION_TIMESTAMP - the value returned by calling GenericDocument#getCreationTimestampMillis() on the document returned by getGenericDocument()
SearchSpec#RANKING_STRATEGY_RELEVANCE_SCORE - an arbitrary double value where a higher value means more relevant
SearchSpec#RANKING_STRATEGY_USAGE_COUNT - the number of times usage has been reported for the document returned by getGenericDocument()
SearchSpec#RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP - the timestamp of the most recent usage that has been reported for the document returned by getGenericDocument()

Return
`Double`	Ranking signal of the document

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35

static val CREATOR: Parcelable.Creator<SearchResult!>