Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SearchResult

Kotlin |Java

public final class SearchResult
extends Object implements Parcelable

java.lang.Object
↳	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.

See also:

SearchResults

Summary

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

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SearchResult>`	`CREATOR`

Public methods
`String`	`getDatabaseName()` Contains the database name that stored the `GenericDocument`.
`GenericDocument`	`getGenericDocument()` Contains the matching `GenericDocument`.
`List<Double>`	`getInformationalRankingSignals()` Returns the informational ranking signals of the `GenericDocument`, according to the expressions added in `SearchSpec.Builder.addInformationalRankingExpressions`.
`List<SearchResult>`	`getJoinedResults()` Gets a list of `SearchResult` joined from the join operation.
`List<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`.
`Map<String, List<String>>`	`getParentTypeMap()` Returns the map from schema type names to the list of their parent types.
`double`	`getRankingSignal()` Returns the ranking signal of the `GenericDocument`, according to the ranking strategy set in `SearchSpec.Builder.setRankingStrategy(int)`.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in T Extensions 13

public static final Creator<SearchResult> CREATOR

Public methods

getDatabaseName

Added in API level 31

public String getDatabaseName ()

Contains the database name that stored the GenericDocument.

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

getGenericDocument

Added in API level 31

public GenericDocument getGenericDocument ()

Contains the matching GenericDocument.

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

getInformationalRankingSignals

Added in API level 36
Also in T Extensions 16

public List<Double> getInformationalRankingSignals ()

Returns the informational ranking signals of the GenericDocument, according to the expressions added in SearchSpec.Builder.addInformationalRankingExpressions.

Returns
`List<Double>`	This value cannot be `null`.

getJoinedResults

Added in API level 34
Also in T Extensions 7

public List<SearchResult> getJoinedResults ()

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 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.

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

getMatchInfos

Added in API level 31

public List<SearchResult.MatchInfo> getMatchInfos ()

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

Returns
`List<SearchResult.MatchInfo>`	List of matches based on `SearchSpec`. If snippeting is disabled using `SearchSpec.Builder.setSnippetCount(int)` or `SearchSpec.Builder.setSnippetCountPerProperty(int)`, for all results after that value, this method returns an empty list. This value cannot be `null`.

getPackageName

Added in API level 31

public String getPackageName ()

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

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

getParentTypeMap

Added in API level 36
Also in T Extensions 17

public Map<String, List<String>> getParentTypeMap ()

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

The map includes entries for the GenericDocument's own type and all of the nested documents' types. Child types are guaranteed to appear before parent types in each list.

Parent types include transitive parents.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

Returns
`Map<String, List<String>>`	This value cannot be `null`.

getRankingSignal

Added in API level 31

public double getRankingSignal ()

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()

Returns
`double`	Ranking signal of the document

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

SearchResult

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

getDatabaseName

getGenericDocument

getInformationalRankingSignals

getJoinedResults

getMatchInfos

getPackageName

getParentTypeMap

getRankingSignal

writeToParcel