Language

SearchSpec.Builder.SetJoinSpec(JoinSpec) Method

Definition

Specifies which documents to join with, and how to join.

[Android.Runtime.Register("setJoinSpec", "(Landroid/app/appsearch/JoinSpec;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=34)]
public Android.App.AppSearch.SearchSpec.Builder SetJoinSpec(Android.App.AppSearch.JoinSpec joinSpec);
[<Android.Runtime.Register("setJoinSpec", "(Landroid/app/appsearch/JoinSpec;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=34)>]
member this.SetJoinSpec : Android.App.AppSearch.JoinSpec -> Android.App.AppSearch.SearchSpec.Builder

Parameters

joinSpec
JoinSpec

a specification on how to perform the Join operation. This value cannot be null.

Returns

Attributes

Remarks

Specifies which documents to join with, and how to join. If the ranking strategy is SearchSpec.RANKING_STRATEGY_JOIN_AGGREGATE_SCORE, and the JoinSpec is null, build() will throw an AppSearchException.

Android reference for android.app.appsearch.SearchSpec.Builder.setJoinSpec.

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