AppSearchManager Klasse

Definition

[Android.Runtime.Register("android/app/appsearch/AppSearchManager", ApiSince=31, DoNotGenerateAcw=true)]
public class AppSearchManager : Java.Lang.Object

[<Android.Runtime.Register("android/app/appsearch/AppSearchManager", ApiSince=31, DoNotGenerateAcw=true)>]
type AppSearchManager = class
    inherit Object

Vererbung

Object

JavaObject

Object

AppSearchManager

Attribute

RegisterAttribute

Hinweise

Bietet Zugriff auf den zentralisierten AppSearch-Index, der vom System verwaltet wird.

AppSearch ist eine Offline-, Gerätesuchbibliothek zum Verwalten strukturierter Daten mit:

<ul><li>APIs zum Indizieren und Abrufen von Daten über die Volltextsuche. <li>Eine API für Anwendungen, die explizit Lesezugriffsberechtigungen für ihre Daten für andere Anwendungen erteilen. <b>Siehe: SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>Eine API für Anwendungen, die ihre Daten auf System-UI-Oberflächen von der vom System festgelegten globalen Querier angezeigt oder nicht angezeigt werden sollen. <b>Siehe: SetSchemaRequest.Builder#setSchemaTypeDisplayedBySystem</b></ul>

Anwendungen erstellen eine Datenbank durch Öffnen einer AppSearchSession.

Beispiel:

AppSearchManager appSearchManager = context.getSystemService(AppSearchManager.class);

            AppSearchManager.SearchContext searchContext = new AppSearchManager.SearchContext.Builder().
               setDatabaseName(dbName).build());
            appSearchManager.createSearchSession(searchContext, mExecutor, appSearchSessionResult -> {
                 mAppSearchSession = appSearchSessionResult.getResultValue();
            });

Nach dem Öffnen der Sitzung muss ein Schema festgelegt werden, um die Organisationsstruktur der Daten zu definieren. Das Schema wird durch Aufrufen AppSearchSession#setSchemafestgelegt. Das Schema besteht aus einer Auflistung von AppSearchSchema Objekten, die jeweils einen eindeutigen Datentyp definieren.

Beispiel:

AppSearchSchema emailSchemaType = new AppSearchSchema.Builder("Email")
                .addProperty(new StringPropertyConfig.Builder("subject")
                   .setCardinality(PropertyConfig.CARDINALITY_OPTIONAL)
                   .setIndexingType(PropertyConfig.INDEXING_TYPE_PREFIXES)
                   .setTokenizerType(PropertyConfig.TOKENIZER_TYPE_PLAIN)
               .build()
            ).build();

            SetSchemaRequest request = new SetSchemaRequest.Builder().addSchema(emailSchemaType).build();
            mAppSearchSession.set(request, mExecutor, appSearchResult -> {
                 if (appSearchResult.isSuccess()) {
                      // Schema has been successfully set.
                 }
            });

Die Grundlegende Dateneinheit in AppSearch wird als GenericDocument Objekt dargestellt, das eine ID, einen Namespace, eine Zeit-zu-Live-Bewertung und -Eigenschaften enthält. Ein Namespace organisiert eine logische Gruppe von Dokumenten. Beispielsweise kann ein Namespace erstellt werden, um Dokumente pro Konto zu gruppieren. Eine ID identifiziert ein einzelnes Dokument in einem Namespace. Die Kombination aus Namespace und ID identifiziert eine GenericDocument in der Datenbank eindeutig.

Nachdem das Schema festgelegt wurde, GenericDocument können Objekte in die Datenbank eingefügt und durch Aufrufen AppSearchSession#putindiziert werden.

Beispiel:

// Although for this example we use GenericDocument directly, we recommend extending
            // GenericDocument to create specific types (i.e. Email) with specific setters/getters.
            GenericDocument email = new GenericDocument.Builder<>(NAMESPACE, ID, EMAIL_SCHEMA_TYPE)
                .setPropertyString(“subject”, EMAIL_SUBJECT)
                .setScore(EMAIL_SCORE)
                .build();

            PutDocumentsRequest request = new PutDocumentsRequest.Builder().addGenericDocuments(email)
                .build();
            mAppSearchSession.put(request, mExecutor, appSearchBatchResult -&gt; {
                 if (appSearchBatchResult.isSuccess()) {
                      // All documents have been successfully indexed.
                 }
            });

Die Suche innerhalb der Datenbank erfolgt durch Aufrufen AppSearchSession#search und Bereitstellen der abfragezeichenfolge, nach der gesucht werden soll, sowie einer SearchSpec.

AppSearchSession#getByDocumentId Alternativ können Dokumente nach Namespace und ID abgerufen werden.

Das Entfernen von Dokumenten erfolgt entweder nach Ablaufzeit oder explizitem Aufrufen eines Entfernungsvorgangs. Entfernte Vorgänge können durch Namespace und ID über AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback)oder durch Abfrage erfolgen AppSearchSession#remove(String, SearchSpec, Executor, Consumer).

Java Dokumentation für android.app.appsearch.AppSearchManager.

Teile dieser Seite sind Änderungen auf der Grundlage von Arbeiten, die von der Android Open Source Project erstellt und gemeinsam verwendet und gemäß den in der 2.5 Attribution License beschriebenen Begriffen verwendet werden.