AppSearchManager Classe

Definição

[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

Herança

Object

JavaObject

Object

AppSearchManager

Atributos

RegisterAttribute

Comentários

Fornece acesso ao índice Centralizado AppSearch mantido pelo sistema.

O AppSearch é uma biblioteca de pesquisa offline no dispositivo para gerenciar dados estruturados com:

<APIs ul><li>para indexar e recuperar dados por meio da pesquisa de texto completo. <li>Uma API para aplicativos concederem explicitamente a permissão de acesso de leitura de seus dados a outros aplicativos. <b>Consulte: SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>Uma API para aplicativos aceitarem ou não ter seus dados exibidos em superfícies de interface do usuário do sistema pelo querier global designado pelo sistema. <b>Consulte: SetSchemaRequest.Builder#setSchemaTypeDisplayedBySystem</b></ul>

Os aplicativos criam um banco de dados abrindo um AppSearchSession.

Exemplo:

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

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

Depois de abrir a sessão, um esquema deve ser definido para definir a estrutura organizacional dos dados. O esquema é definido chamando AppSearchSession#setSchema. O esquema é composto por uma coleção de AppSearchSchema objetos, cada um dos quais define um tipo exclusivo de dados.

Exemplo:

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

A unidade básica de dados no AppSearch é representada como um GenericDocument objeto, contendo uma ID, namespace, vida útil, pontuação e propriedades. Um namespace organiza um grupo lógico de documentos. Por exemplo, um namespace pode ser criado para agrupar documentos por conta. Uma ID identifica um único documento em um namespace. A combinação de namespace e ID identifica exclusivamente um GenericDocument no banco de dados.

Depois que o esquema tiver sido definido, GenericDocument os objetos poderão ser colocados no banco de dados e indexados chamando AppSearchSession#put.

Exemplo:

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

A pesquisa dentro do banco de dados é feita chamando AppSearchSession#search e fornecendo a cadeia de caracteres de consulta a ser pesquisada, bem como um SearchSpec.

Como alternativa, AppSearchSession#getByDocumentId pode ser chamado para recuperar documentos por namespace e ID.

A remoção do documento é feita por expiração de tempo de vida útil ou chamando explicitamente uma operação de remoção. As operações de remoção podem ser feitas por namespace e ID via AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback), ou por consulta via AppSearchSession#remove(String, SearchSpec, Executor, Consumer).

Java documentação para android.app.appsearch.AppSearchManager.

Partes desta página são modificações baseadas no trabalho criado e compartilhado pelo Project Open Source do Open Source e usadas de acordo com os termos descritos na Creative Commons 2.5.