Android Studio
Added in API level 31
Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SearchResult

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:

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

See also:

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

Fields

public static final Creator<SearchResult> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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

Fields

CREATOR

Added in API level 35
Also in T Extensions 13 
public static final Creator<SearchResult> CREATOR

Public methods

describeContents

Added in API level 35 
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

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 or 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 
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:

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 the following: