Nickname

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.JOIN_SPEC_AND_QUALIFIED_ID)
@Document(name = "builtin:Nickname")
@ExperimentalAppSearchApi
public class Nickname

// Assume that the MobileApplication schema and Nickname schema have been set and settings is
// indexed as a MobileApplication document.

// Create the qualified ID for a settings app.
String settingsAppQualifiedId = DocumentIdUtil.createQualifiedId(
    "android",
    "apps-db",
    "apps",
    "com.android.settings");

// Index the "config" nickname document, linking it to the document for settings.
Nickname configNickname = new Nickname.Builder("configNs", "configId", settingsAppQualifiedId)
    .setAlternateNames(Collections.singletonList("config"))
    .build();

AppSearchBatchResult<String, Void> putResult = appSearchSession.putAsync(
    new PutDocumentsRequest.Builder().addDocuments(configNickname).build()).get();

// Assert the nickname has been indexed
if (!putResult.isSuccess()) {
   return;
}

SearchSpec nestedSearchSpec = new SearchSpec.Builder()
    .addFilterDocumentClass(Nickname.class)
    .build();

JoinSpec joinSpec = new JoinSpec.Builder("referencedQualifiedId")
    .setNestedSearch("config", nestedSearchSpec)
    .build();

SearchSpec searchSpec = new SearchSpec.Builder()
    .addFilterDocumentClass(MobileApplication.class)
    .setJoinSpec(joinSpec)
    .setRankingStrategy("len(this.childrenRankingSignals()) > 0")
    .build();

SearchResults searchResults = appSearchSession.search("", searchSpec);

// This will contain one SearchResult for the settings MobileApplication document.
List<SearchResult> results = searchResults.getNextPageAsync().get();