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，可明確授權其資料的讀取權限給其他應用程式。 < >詳見：SetSchemaRequest.Builder#setSchemaTypeVisibilityForPackage</b><li>一個應用程式可選擇是否讓其資料由系統指定的全域查詢者顯示於系統介面表面的 API。 <b>參見： 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 中基本的資料單位以物件表示 GenericDocument ，包含 ID、命名空間、壽命、分數與屬性。 命名空間組織一組邏輯文件。 例如，可以建立一個命名空間，以依每個帳號分組文件。 ID 用來識別命名空間內的單一文件。 命名空間與 ID 的組合能在資料庫中唯一識別 a 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 檢索文件。

文件移除可以透過存活時間到期或明確呼叫移除操作來完成。 移除操作可透過命名空間與 ID AppSearchSession#remove(RemoveByDocumentIdRequest, Executor, BatchResultCallback)執行，或透過查詢 AppSearchSession#remove(String, SearchSpec, Executor, Consumer)執行。

Java 文件 android.app.appsearch.AppSearchManager。

本頁部分內容為基於 Open Source Project 所創建與分享的作品，並依授權條款所描述的使用進行修改。