AppSearchManager Classe

Définition

[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

Héritage

Object

JavaObject

Object

AppSearchManager

Attributs

RegisterAttribute

Remarques

Fournit l’accès à l’index AppSearch centralisé géré par le système.

AppSearch est une bibliothèque de recherche sur appareil hors connexion pour la gestion des données structurées avec :

<API ul><li>pour indexer et récupérer des données via la recherche en texte intégral. <li>API pour les applications pour accorder explicitement l’autorisation d’accès en lecture de leurs données à d’autres applications. <b>Voir : SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>Api pour les applications à choisir ou à ne pas avoir leurs données affichées sur les surfaces de l’interface utilisateur système par le querier global désigné par le système. <b>Voir : SetSchemaRequest.Builder#setSchemaTypeDisplayedBySystem</b></ul>

Les applications créent une base de données en ouvrant un AppSearchSession.

Exemple :

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

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

Après avoir ouvert la session, un schéma doit être défini pour définir la structure organisationnelle des données. Le schéma est défini en appelant AppSearchSession#setSchema. Le schéma est composé d’une collection d’objets AppSearchSchema , dont chacun définit un type unique de données.

Exemple :

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.
                 }
            });

L’unité de base des données dans AppSearch est représentée en tant qu’objet GenericDocument , contenant un ID, un espace de noms, un délai de vie, un score et des propriétés. Un espace de noms organise un groupe logique de documents. Par exemple, un espace de noms peut être créé pour regrouper des documents par compte. Un ID identifie un document unique dans un espace de noms. La combinaison de l’espace de noms et de l’ID identifie de façon unique une GenericDocument dans la base de données.

Une fois le schéma défini, GenericDocument les objets peuvent être placés dans la base de données et indexés en appelant AppSearchSession#put.

Exemple :

// 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.
                 }
            });

La recherche dans la base de données est effectuée en appelant AppSearchSession#search et en fournissant la chaîne de requête à rechercher, ainsi qu’un SearchSpec.

AppSearchSession#getByDocumentId Vous pouvez également appeler pour récupérer des documents par espace de noms et PAR ID.

La suppression de document est effectuée en fonction de l’expiration du délai d’exécution ou de l’appel explicite d’une opération de suppression. Les opérations de suppression peuvent être effectuées par l’espace de noms et l’ID via AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback), ou par requête via AppSearchSession#remove(String, SearchSpec, Executor, Consumer).

Java documentation pour android.app.appsearch.AppSearchManager.

Les parties de cette page sont des modifications basées sur le travail créé et partagé par Android Open Source et utilisées en fonction des termes décrits dans la Creative Commons 2.5 Attribution License.