Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c8cc7844 authored by Alexander Dorokhine's avatar Alexander Dorokhine Committed by Android (Google) Code Review
Browse files

Merge "Unhide SearchResult and SearchSpec APIs."

parents ca4b13a6 d6dcb74f
Loading
Loading
Loading
Loading
+54 −0
Original line number Diff line number Diff line
@@ -85,5 +85,59 @@ package android.app.appsearch {
    method @NonNull public BuilderType setTtlMillis(long);
  }

  public final class SearchResult {
    method @NonNull public android.app.appsearch.GenericDocument getDocument();
    method @NonNull public java.util.List<android.app.appsearch.SearchResult.MatchInfo> getMatches();
  }

  public static final class SearchResult.MatchInfo {
    method @NonNull public CharSequence getExactMatch();
    method @NonNull public android.app.appsearch.SearchResult.MatchRange getExactMatchPosition();
    method @NonNull public String getFullText();
    method @NonNull public String getPropertyPath();
    method @NonNull public CharSequence getSnippet();
    method @NonNull public android.app.appsearch.SearchResult.MatchRange getSnippetPosition();
  }

  public static final class SearchResult.MatchRange {
    method public int getEnd();
    method public int getStart();
  }

  public final class SearchSpec {
    method public int getMaxSnippetSize();
    method @NonNull public java.util.List<java.lang.String> getNamespaces();
    method public int getOrder();
    method public int getRankingStrategy();
    method public int getResultCountPerPage();
    method @NonNull public java.util.List<java.lang.String> getSchemaTypes();
    method public int getSnippetCount();
    method public int getSnippetCountPerProperty();
    method public int getTermMatch();
    field public static final int ORDER_ASCENDING = 1; // 0x1
    field public static final int ORDER_DESCENDING = 0; // 0x0
    field public static final int RANKING_STRATEGY_CREATION_TIMESTAMP = 2; // 0x2
    field public static final int RANKING_STRATEGY_DOCUMENT_SCORE = 1; // 0x1
    field public static final int RANKING_STRATEGY_NONE = 0; // 0x0
    field public static final int TERM_MATCH_EXACT_ONLY = 1; // 0x1
    field public static final int TERM_MATCH_PREFIX = 2; // 0x2
  }

  public static final class SearchSpec.Builder {
    ctor public SearchSpec.Builder();
    method @NonNull public android.app.appsearch.SearchSpec.Builder addNamespace(@NonNull java.lang.String...);
    method @NonNull public android.app.appsearch.SearchSpec.Builder addNamespace(@NonNull java.util.Collection<java.lang.String>);
    method @NonNull public android.app.appsearch.SearchSpec.Builder addSchemaType(@NonNull java.lang.String...);
    method @NonNull public android.app.appsearch.SearchSpec.Builder addSchemaType(@NonNull java.util.Collection<java.lang.String>);
    method @NonNull public android.app.appsearch.SearchSpec build();
    method @NonNull public android.app.appsearch.SearchSpec.Builder setMaxSnippetSize(@IntRange(from=0, to=android.app.appsearch.SearchSpec.MAX_SNIPPET_SIZE_LIMIT) int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setOrder(int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setRankingStrategy(int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setResultCountPerPage(@IntRange(from=0, to=android.app.appsearch.SearchSpec.MAX_NUM_PER_PAGE) int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCount(@IntRange(from=0, to=android.app.appsearch.SearchSpec.MAX_SNIPPET_COUNT) int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCountPerProperty(@IntRange(from=0, to=android.app.appsearch.SearchSpec.MAX_SNIPPET_PER_PROPERTY_COUNT) int);
    method @NonNull public android.app.appsearch.SearchSpec.Builder setTermMatch(int);
  }

}
+0 −1
Original line number Diff line number Diff line
@@ -41,7 +41,6 @@ import java.util.Objects;
 * part of search result.
 *
 * @see SearchResults
 * @hide
 */
public final class SearchResult {
    /** @hide */
+0 −1
Original line number Diff line number Diff line
@@ -37,7 +37,6 @@ import java.util.List;
/**
 * This class represents the specification logic for AppSearch. It can be used to set the type of
 * search, like prefix or exact only or apply filters to search for a specific schema type only etc.
 * @hide
 */
// TODO(sidchhabra) : AddResultSpec fields for Snippets etc.
public final class SearchSpec {