AppSearchManager クラス

定義

[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

継承

Object

JavaObject

Object

AppSearchManager

属性

RegisterAttribute

注釈

システムによって管理される一元化された AppSearch インデックスへのアクセスを提供します。

AppSearch は、以下を特徴とする構造化データを管理するためのオフラインのオンデバイス検索ライブラリです。

<ul><li>API を使用して、フルテキスト検索を使用してデータのインデックスを作成および取得します。 <li>アプリケーションがデータの読み取りアクセス許可を他のアプリケーションに明示的に付与するための API。 <b>See: SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>システム指定グローバル クエリによってシステム UI サーフェイスにデータを表示することをオプトインまたはオプトアウトするためのアプリケーション用 API。 <b>See: SetSchemaRequest.Builder#setSchemaTypeDisplayedBySystem</b></ul>

アプリケーションは、 AppSearchSessionを開いてデータベースを作成します。

例：

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

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

セッションを開いた後、データの組織構造を定義するためにスキーマを設定する必要があります。 スキーマは、 AppSearchSession#setSchemaを呼び出すことによって設定されます。 スキーマは AppSearchSchema オブジェクトのコレクションで構成され、それぞれが一意のデータ型を定義します。

例：

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

AppSearch のデータの基本単位は、ID、名前空間、有効期間、スコア、およびプロパティを含む GenericDocument オブジェクトとして表されます。 名前空間は、ドキュメントの論理グループを整理します。 たとえば、アカウントごとにドキュメントをグループ化する名前空間を作成できます。 ID は、名前空間内の 1 つのドキュメントを識別します。 名前空間と ID の組み合わせは、データベース内の GenericDocument を一意に識別します。

スキーマが設定されたら、 GenericDocument オブジェクトをデータベースに格納し、 AppSearchSession#putを呼び出してインデックスを作成できます。

例：

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

データベース内で検索を行うには、 AppSearchSession#search を呼び出し、検索するクエリ文字列と SearchSpecを指定します。

または、 AppSearchSession#getByDocumentId を呼び出して、名前空間と ID でドキュメントを取得することもできます。

ドキュメントの削除は、有効期限が切れるか、明示的に削除操作を呼び出すことによって行われます。 削除操作は、 AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback)経由の名前空間と ID、または AppSearchSession#remove(String, SearchSpec, Executor, Consumer) を使用したクエリによって実行できます。

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。