Language

JoinSpec.Builder.SetNestedSearch(String, SearchSpec) Method

Definition

Sets the query and the SearchSpec for the documents being joined.

[Android.Runtime.Register("setNestedSearch", "(Ljava/lang/String;Landroid/app/appsearch/SearchSpec;)Landroid/app/appsearch/JoinSpec$Builder;", "", ApiSince=34)]
public Android.App.AppSearch.JoinSpec.Builder SetNestedSearch(string nestedQuery, Android.App.AppSearch.SearchSpec nestedSearchSpec);
[<Android.Runtime.Register("setNestedSearch", "(Ljava/lang/String;Landroid/app/appsearch/SearchSpec;)Landroid/app/appsearch/JoinSpec$Builder;", "", ApiSince=34)>]
member this.SetNestedSearch : string * Android.App.AppSearch.SearchSpec -> Android.App.AppSearch.JoinSpec.Builder

Parameters

nestedQuery
String
nestedSearchSpec
SearchSpec

Returns

Attributes

Remarks

Sets the query and the SearchSpec for the documents being joined. This will score and rank the joined documents as well as filter the joined documents. If SearchSpec.RANKING_STRATEGY_JOIN_AGGREGATE_SCORE is set in the outer SearchSpec, the resulting signals will be used to rank the parent documents. Note that the aggregation strategy also needs to be set with JoinSpec.Builder.setAggregationScoringStrategy, otherwise the default will be JoinSpec.AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL, which will just use the parent documents ranking signal. If this method is never called, JoinSpec.getNestedQuery will return an empty string, meaning we will join with every possible document that matches the equality constraints and hasn't been filtered out by the type or namespace filters.

Android reference for android.app.appsearch.JoinSpec.Builder.setNestedSearch.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to