AppSearchManager Clase

Definición

[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

Herencia

Object

JavaObject

Object

AppSearchManager

Atributos

RegisterAttribute

Comentarios

Proporciona acceso al índice centralizado de AppSearch mantenido por el sistema.

AppSearch es una biblioteca de búsqueda sin conexión en el dispositivo para administrar datos estructurados con características:

<UL><LI>API para indexar y recuperar datos a través de la búsqueda de texto completo. <li>Una API para que las aplicaciones concedan explícitamente permiso de acceso de lectura de sus datos a otras aplicaciones. <b>Consulte: SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>Una API para que las aplicaciones opten o no por tener sus datos mostrados en las superficies de la interfaz de usuario del sistema por el querier global designado por el sistema. <b>Ver: SetSchemaRequest.Builder#setSchemaTypeDisplayedBySystem</b></ul>

Las aplicaciones crean una base de datos abriendo un AppSearchSession.

Ejemplo:

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

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

Después de abrir la sesión, se debe establecer un esquema para definir la estructura organizativa de los datos. El esquema se establece llamando a AppSearchSession#setSchema. El esquema se compone de una colección de AppSearchSchema objetos, cada uno de los cuales define un tipo único de datos.

Ejemplo:

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

La unidad básica de datos de AppSearch se representa como un objeto , que contiene un GenericDocument identificador, un espacio de nombres, un período de vida, una puntuación y propiedades. Un espacio de nombres organiza un grupo lógico de documentos. Por ejemplo, se puede crear un espacio de nombres para agrupar documentos por cuenta. Un identificador identifica un único documento dentro de un espacio de nombres. La combinación de espacio de nombres e identificador identifica de forma única un elemento GenericDocument en la base de datos.

Una vez establecido el esquema, GenericDocument los objetos se pueden colocar en la base de datos e indexados llamando a AppSearchSession#put.

Ejemplo:

// 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 búsqueda en la base de datos se realiza mediante una llamada AppSearchSession#search a y proporciona la cadena de consulta para buscar, así como un SearchSpec.

Como alternativa, AppSearchSession#getByDocumentId se puede llamar a para recuperar documentos por espacio de nombres e identificador.

La eliminación de documentos se realiza mediante expiración de período de vida o llamando explícitamente a una operación de eliminación. Las operaciones de eliminación se pueden realizar mediante el espacio de nombres y el identificador a través AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback)de , o mediante consulta a través AppSearchSession#remove(String, SearchSpec, Executor, Consumer)de .

Java documentación para android.app.appsearch.AppSearchManager.

Las partes de esta página son modificaciones basadas en el trabajo creado y compartido por el Android y se usan según los términos descritos en creative Creative Commons 2.5 Attribution License.