SearchResult.Builder
Stay organized with collections
Save and categorize content based on your preferences.
Public Constructor Summary
Inherited Method Summary
From class java.lang.Object
Public Methods
Parameters
joinedResult
The joined SearchResult to add.
Adds another match to this SearchResult.
Sets the document which matched.
public SearchResult.Builder
setRankingSignal
(double
rankingSignal)
Sets the ranking signal of the matched document in this SearchResult.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eSearchResult.Builder\u003c/code\u003e is used to construct \u003ccode\u003eSearchResult\u003c/code\u003e objects, representing the results of an AppSearch query.\u003c/p\u003e\n"],["\u003cp\u003eIt allows you to specify the package and database name of the matched document, add information about document matches, and include joined results from related documents.\u003c/p\u003e\n"],["\u003cp\u003eYou can set the matched document itself and its ranking signal within the search results.\u003c/p\u003e\n"],["\u003cp\u003eFinally, the \u003ccode\u003ebuild()\u003c/code\u003e method creates the immutable \u003ccode\u003eSearchResult\u003c/code\u003e instance from the builder.\u003c/p\u003e\n"]]],[],null,["# SearchResult.Builder\n\npublic static final class **SearchResult.Builder** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nBuilder for [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult)\nobjects. \n\n### Public Constructor Summary\n\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#Builder(java.lang.String,%20java.lang.String))([String](//developer.android.com/reference/java/lang/String.html) packageName, [String](//developer.android.com/reference/java/lang/String.html) databaseName) Constructs a new builder for [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult) objects. |\n\n### Public Method Summary\n\n|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder) | [addJoinedResult](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#addJoinedResult(com.google.android.gms.appsearch.SearchResult))([SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult) joinedResult) Adds a [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult) that was joined by the [JoinSpec](/android/reference/com/google/android/gms/appsearch/JoinSpec). |\n| [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder) | [addMatchInfo](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#addMatchInfo(com.google.android.gms.appsearch.SearchResult.MatchInfo))([SearchResult.MatchInfo](/android/reference/com/google/android/gms/appsearch/SearchResult.MatchInfo) matchInfo) Adds another match to this SearchResult. |\n| [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult) | [build](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#build())() Constructs a new [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult). |\n| [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder) | [setGenericDocument](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#setGenericDocument(com.google.android.gms.appsearch.GenericDocument))([GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument) document) Sets the document which matched. |\n| [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder) | [setRankingSignal](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder#setRankingSignal(double))(double rankingSignal) Sets the ranking signal of the matched document in this SearchResult. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public **Builder** ([String](//developer.android.com/reference/java/lang/String.html) packageName, [String](//developer.android.com/reference/java/lang/String.html) databaseName)\n\nConstructs a new builder for [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult)\nobjects. \n\n##### Parameters\n\n| packageName | the package name the matched document belongs to |\n| databaseName | the database name the matched document belongs to. |\n|--------------|----------------------------------------------------|\n\nPublic Methods\n--------------\n\n#### public [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder)\n**addJoinedResult** ([SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult) joinedResult)\n\nAdds a [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult)\nthat was joined by the [JoinSpec](/android/reference/com/google/android/gms/appsearch/JoinSpec). \n\n##### Parameters\n\n| joinedResult | The joined SearchResult to add. |\n|--------------|---------------------------------|\n\n#### public [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder)\n**addMatchInfo** ([SearchResult.MatchInfo](/android/reference/com/google/android/gms/appsearch/SearchResult.MatchInfo) matchInfo)\n\nAdds another match to this SearchResult. \n\n#### public [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult)\n**build** ()\n\nConstructs a new [SearchResult](/android/reference/com/google/android/gms/appsearch/SearchResult). \n\n#### public [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder)\n**setGenericDocument** ([GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument) document)\n\nSets the document which matched. \n\n#### public [SearchResult.Builder](/android/reference/com/google/android/gms/appsearch/SearchResult.Builder)\n**setRankingSignal** (double rankingSignal)\n\nSets the ranking signal of the matched document in this SearchResult."]]
