xref: /aosp_15_r20/prebuilts/sdk/35/public/api/framework-appsearch.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b) 
1// Signature format: 2.0
2package android.app.appsearch {
3
4  public final class AppSearchBatchResult<KeyType, ValueType> {
5    method @NonNull public java.util.Map<KeyType,android.app.appsearch.AppSearchResult<ValueType>> getAll();
6    method @NonNull public java.util.Map<KeyType,android.app.appsearch.AppSearchResult<ValueType>> getFailures();
7    method @NonNull public java.util.Map<KeyType,ValueType> getSuccesses();
8    method public boolean isSuccess();
9  }
10
11  public static final class AppSearchBatchResult.Builder<KeyType, ValueType> {
12    ctor public AppSearchBatchResult.Builder();
13    method @NonNull public android.app.appsearch.AppSearchBatchResult<KeyType,ValueType> build();
14    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setFailure(@NonNull KeyType, int, @Nullable String);
15    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setResult(@NonNull KeyType, @NonNull android.app.appsearch.AppSearchResult<ValueType>);
16    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setSuccess(@NonNull KeyType, @Nullable ValueType);
17  }
18
19  public class AppSearchManager {
20    method public void createEnterpriseGlobalSearchSession(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.EnterpriseGlobalSearchSession>>);
21    method public void createGlobalSearchSession(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GlobalSearchSession>>);
22    method public void createSearchSession(@NonNull android.app.appsearch.AppSearchManager.SearchContext, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.AppSearchSession>>);
23  }
24
25  public static final class AppSearchManager.SearchContext {
26    method @NonNull public String getDatabaseName();
27  }
28
29  public static final class AppSearchManager.SearchContext.Builder {
30    ctor public AppSearchManager.SearchContext.Builder(@NonNull String);
31    method @NonNull public android.app.appsearch.AppSearchManager.SearchContext build();
32  }
33
34  public final class AppSearchResult<ValueType> {
35    method @Nullable public String getErrorMessage();
36    method public int getResultCode();
37    method @Nullable public ValueType getResultValue();
38    method public boolean isSuccess();
39    method @NonNull public static <ValueType> android.app.appsearch.AppSearchResult<ValueType> newFailedResult(int, @Nullable String);
40    method @NonNull public static <ValueType> android.app.appsearch.AppSearchResult<ValueType> newSuccessfulResult(@Nullable ValueType);
41    field public static final int RESULT_INTERNAL_ERROR = 2; // 0x2
42    field public static final int RESULT_INVALID_ARGUMENT = 3; // 0x3
43    field public static final int RESULT_INVALID_SCHEMA = 7; // 0x7
44    field public static final int RESULT_IO_ERROR = 4; // 0x4
45    field public static final int RESULT_NOT_FOUND = 6; // 0x6
46    field public static final int RESULT_OK = 0; // 0x0
47    field public static final int RESULT_OUT_OF_SPACE = 5; // 0x5
48    field public static final int RESULT_SECURITY_ERROR = 8; // 0x8
49    field public static final int RESULT_UNKNOWN_ERROR = 1; // 0x1
50  }
51
52  public final class AppSearchSchema implements android.os.Parcelable {
53    method public final int describeContents();
54    method @NonNull public java.util.List<java.lang.String> getParentTypes();
55    method @NonNull public java.util.List<android.app.appsearch.AppSearchSchema.PropertyConfig> getProperties();
56    method @NonNull public String getSchemaType();
57    method public void writeToParcel(@NonNull android.os.Parcel, int);
58    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.AppSearchSchema> CREATOR;
59  }
60
61  public static final class AppSearchSchema.BooleanPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
62  }
63
64  public static final class AppSearchSchema.BooleanPropertyConfig.Builder {
65    ctor public AppSearchSchema.BooleanPropertyConfig.Builder(@NonNull String);
66    method @NonNull public android.app.appsearch.AppSearchSchema.BooleanPropertyConfig build();
67    method @NonNull public android.app.appsearch.AppSearchSchema.BooleanPropertyConfig.Builder setCardinality(int);
68  }
69
70  public static final class AppSearchSchema.Builder {
71    ctor public AppSearchSchema.Builder(@NonNull String);
72    method @NonNull public android.app.appsearch.AppSearchSchema.Builder addParentType(@NonNull String);
73    method @NonNull public android.app.appsearch.AppSearchSchema.Builder addProperty(@NonNull android.app.appsearch.AppSearchSchema.PropertyConfig);
74    method @NonNull public android.app.appsearch.AppSearchSchema build();
75  }
76
77  public static final class AppSearchSchema.BytesPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
78  }
79
80  public static final class AppSearchSchema.BytesPropertyConfig.Builder {
81    ctor public AppSearchSchema.BytesPropertyConfig.Builder(@NonNull String);
82    method @NonNull public android.app.appsearch.AppSearchSchema.BytesPropertyConfig build();
83    method @NonNull public android.app.appsearch.AppSearchSchema.BytesPropertyConfig.Builder setCardinality(int);
84  }
85
86  public static final class AppSearchSchema.DocumentPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
87    method @NonNull public java.util.List<java.lang.String> getIndexableNestedProperties();
88    method @NonNull public String getSchemaType();
89    method public boolean shouldIndexNestedProperties();
90  }
91
92  public static final class AppSearchSchema.DocumentPropertyConfig.Builder {
93    ctor public AppSearchSchema.DocumentPropertyConfig.Builder(@NonNull String, @NonNull String);
94    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedProperties(@NonNull java.lang.String...);
95    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedProperties(@NonNull java.util.Collection<java.lang.String>);
96    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedPropertyPaths(@NonNull android.app.appsearch.PropertyPath...);
97    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedPropertyPaths(@NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
98    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig build();
99    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder setCardinality(int);
100    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder setShouldIndexNestedProperties(boolean);
101  }
102
103  public static final class AppSearchSchema.DoublePropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
104  }
105
106  public static final class AppSearchSchema.DoublePropertyConfig.Builder {
107    ctor public AppSearchSchema.DoublePropertyConfig.Builder(@NonNull String);
108    method @NonNull public android.app.appsearch.AppSearchSchema.DoublePropertyConfig build();
109    method @NonNull public android.app.appsearch.AppSearchSchema.DoublePropertyConfig.Builder setCardinality(int);
110  }
111
112  public static final class AppSearchSchema.LongPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
113    method public int getIndexingType();
114    field public static final int INDEXING_TYPE_NONE = 0; // 0x0
115    field public static final int INDEXING_TYPE_RANGE = 1; // 0x1
116  }
117
118  public static final class AppSearchSchema.LongPropertyConfig.Builder {
119    ctor public AppSearchSchema.LongPropertyConfig.Builder(@NonNull String);
120    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig build();
121    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig.Builder setCardinality(int);
122    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig.Builder setIndexingType(int);
123  }
124
125  public abstract static class AppSearchSchema.PropertyConfig {
126    method public int getCardinality();
127    method @NonNull public String getName();
128    field public static final int CARDINALITY_OPTIONAL = 2; // 0x2
129    field public static final int CARDINALITY_REPEATED = 1; // 0x1
130    field public static final int CARDINALITY_REQUIRED = 3; // 0x3
131  }
132
133  public static final class AppSearchSchema.StringPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
134    method public int getIndexingType();
135    method public int getJoinableValueType();
136    method public int getTokenizerType();
137    field public static final int INDEXING_TYPE_EXACT_TERMS = 1; // 0x1
138    field public static final int INDEXING_TYPE_NONE = 0; // 0x0
139    field public static final int INDEXING_TYPE_PREFIXES = 2; // 0x2
140    field public static final int JOINABLE_VALUE_TYPE_NONE = 0; // 0x0
141    field public static final int JOINABLE_VALUE_TYPE_QUALIFIED_ID = 1; // 0x1
142    field public static final int TOKENIZER_TYPE_NONE = 0; // 0x0
143    field public static final int TOKENIZER_TYPE_PLAIN = 1; // 0x1
144    field public static final int TOKENIZER_TYPE_RFC822 = 3; // 0x3
145    field public static final int TOKENIZER_TYPE_VERBATIM = 2; // 0x2
146  }
147
148  public static final class AppSearchSchema.StringPropertyConfig.Builder {
149    ctor public AppSearchSchema.StringPropertyConfig.Builder(@NonNull String);
150    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig build();
151    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setCardinality(int);
152    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setIndexingType(int);
153    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType(int);
154    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setTokenizerType(int);
155  }
156
157  public final class AppSearchSession implements java.io.Closeable {
158    method public void close();
159    method public void getByDocumentId(@NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
160    method public void getNamespaces(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.Set<java.lang.String>>>);
161    method public void getSchema(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
162    method public void getStorageInfo(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.StorageInfo>>);
163    method public void put(@NonNull android.app.appsearch.PutDocumentsRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,java.lang.Void>);
164    method public void remove(@NonNull android.app.appsearch.RemoveByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,java.lang.Void>);
165    method public void remove(@NonNull String, @NonNull android.app.appsearch.SearchSpec, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
166    method public void reportUsage(@NonNull android.app.appsearch.ReportUsageRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
167    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
168    method public void searchSuggestion(@NonNull String, @NonNull android.app.appsearch.SearchSuggestionSpec, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.List<android.app.appsearch.SearchSuggestionResult>>>);
169    method public void setSchema(@NonNull android.app.appsearch.SetSchemaRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.SetSchemaResponse>>);
170  }
171
172  public interface BatchResultCallback<KeyType, ValueType> {
173    method public void onResult(@NonNull android.app.appsearch.AppSearchBatchResult<KeyType,ValueType>);
174    method public default void onSystemError(@Nullable Throwable);
175  }
176
177  public class EnterpriseGlobalSearchSession {
178    method public void getByDocumentId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
179    method public void getSchema(@NonNull String, @NonNull String, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
180    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
181  }
182
183  public class GenericDocument {
184    ctor protected GenericDocument(@NonNull android.app.appsearch.GenericDocument);
185    method public long getCreationTimestampMillis();
186    method @NonNull public String getId();
187    method public static int getMaxIndexedProperties();
188    method @NonNull public String getNamespace();
189    method @Nullable public Object getProperty(@NonNull String);
190    method public boolean getPropertyBoolean(@NonNull String);
191    method @Nullable public boolean[] getPropertyBooleanArray(@NonNull String);
192    method @Nullable public byte[] getPropertyBytes(@NonNull String);
193    method @Nullable public byte[][] getPropertyBytesArray(@NonNull String);
194    method @Nullable public android.app.appsearch.GenericDocument getPropertyDocument(@NonNull String);
195    method @Nullable public android.app.appsearch.GenericDocument[] getPropertyDocumentArray(@NonNull String);
196    method public double getPropertyDouble(@NonNull String);
197    method @Nullable public double[] getPropertyDoubleArray(@NonNull String);
198    method public long getPropertyLong(@NonNull String);
199    method @Nullable public long[] getPropertyLongArray(@NonNull String);
200    method @NonNull public java.util.Set<java.lang.String> getPropertyNames();
201    method @Nullable public String getPropertyString(@NonNull String);
202    method @Nullable public String[] getPropertyStringArray(@NonNull String);
203    method @NonNull public String getSchemaType();
204    method public int getScore();
205    method public long getTtlMillis();
206  }
207
208  public static class GenericDocument.Builder<BuilderType extends android.app.appsearch.GenericDocument.Builder> {
209    ctor public GenericDocument.Builder(@NonNull String, @NonNull String, @NonNull String);
210    ctor public GenericDocument.Builder(@NonNull android.app.appsearch.GenericDocument);
211    method @NonNull public android.app.appsearch.GenericDocument build();
212    method @NonNull public BuilderType clearProperty(@NonNull String);
213    method @NonNull public BuilderType setCreationTimestampMillis(long);
214    method @NonNull public BuilderType setId(@NonNull String);
215    method @NonNull public BuilderType setNamespace(@NonNull String);
216    method @NonNull public BuilderType setPropertyBoolean(@NonNull String, @NonNull boolean...);
217    method @NonNull public BuilderType setPropertyBytes(@NonNull String, @NonNull byte[]...);
218    method @NonNull public BuilderType setPropertyDocument(@NonNull String, @NonNull android.app.appsearch.GenericDocument...);
219    method @NonNull public BuilderType setPropertyDouble(@NonNull String, @NonNull double...);
220    method @NonNull public BuilderType setPropertyLong(@NonNull String, @NonNull long...);
221    method @NonNull public BuilderType setPropertyString(@NonNull String, @NonNull java.lang.String...);
222    method @NonNull public BuilderType setSchemaType(@NonNull String);
223    method @NonNull public BuilderType setScore(@IntRange(from=0, to=java.lang.Integer.MAX_VALUE) int);
224    method @NonNull public BuilderType setTtlMillis(long);
225  }
226
227  public final class GetByDocumentIdRequest implements android.os.Parcelable {
228    method public final int describeContents();
229    method @NonNull public java.util.Set<java.lang.String> getIds();
230    method @NonNull public String getNamespace();
231    method @NonNull public java.util.Map<java.lang.String,java.util.List<android.app.appsearch.PropertyPath>> getProjectionPaths();
232    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProjections();
233    method public void writeToParcel(@NonNull android.os.Parcel, int);
234    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.GetByDocumentIdRequest> CREATOR;
235    field public static final String PROJECTION_SCHEMA_TYPE_WILDCARD = "*";
236  }
237
238  public static final class GetByDocumentIdRequest.Builder {
239    ctor public GetByDocumentIdRequest.Builder(@NonNull String);
240    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addIds(@NonNull java.lang.String...);
241    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addIds(@NonNull java.util.Collection<java.lang.String>);
242    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addProjection(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
243    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addProjectionPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
244    method @NonNull public android.app.appsearch.GetByDocumentIdRequest build();
245  }
246
247  public final class GetSchemaResponse implements android.os.Parcelable {
248    method public final int describeContents();
249    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.PackageIdentifier> getPubliclyVisibleSchemas();
250    method @NonNull public java.util.Map<java.lang.String,java.util.Set<java.util.Set<java.lang.Integer>>> getRequiredPermissionsForSchemaTypeVisibility();
251    method @NonNull public java.util.Set<java.lang.String> getSchemaTypesNotDisplayedBySystem();
252    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.SchemaVisibilityConfig>> getSchemaTypesVisibleToConfigs();
253    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.PackageIdentifier>> getSchemaTypesVisibleToPackages();
254    method @NonNull public java.util.Set<android.app.appsearch.AppSearchSchema> getSchemas();
255    method @IntRange(from=0) public int getVersion();
256    method public void writeToParcel(@NonNull android.os.Parcel, int);
257    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.GetSchemaResponse> CREATOR;
258  }
259
260  public static final class GetSchemaResponse.Builder {
261    ctor public GetSchemaResponse.Builder();
262    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder addSchema(@NonNull android.app.appsearch.AppSearchSchema);
263    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder addSchemaTypeNotDisplayedBySystem(@NonNull String);
264    method @NonNull public android.app.appsearch.GetSchemaResponse build();
265    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setPubliclyVisibleSchema(@NonNull String, @NonNull android.app.appsearch.PackageIdentifier);
266    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setRequiredPermissionsForSchemaTypeVisibility(@NonNull String, @NonNull java.util.Set<java.util.Set<java.lang.Integer>>);
267    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setSchemaTypeVisibleToConfigs(@NonNull String, @NonNull java.util.Set<android.app.appsearch.SchemaVisibilityConfig>);
268    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setSchemaTypeVisibleToPackages(@NonNull String, @NonNull java.util.Set<android.app.appsearch.PackageIdentifier>);
269    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setVersion(@IntRange(from=0) int);
270  }
271
272  public class GlobalSearchSession implements java.io.Closeable {
273    method public void close();
274    method public void getByDocumentId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
275    method public void getSchema(@NonNull String, @NonNull String, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
276    method public void registerObserverCallback(@NonNull String, @NonNull android.app.appsearch.observer.ObserverSpec, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.observer.ObserverCallback) throws android.app.appsearch.exceptions.AppSearchException;
277    method public void reportSystemUsage(@NonNull android.app.appsearch.ReportSystemUsageRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
278    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
279    method public void unregisterObserverCallback(@NonNull String, @NonNull android.app.appsearch.observer.ObserverCallback) throws android.app.appsearch.exceptions.AppSearchException;
280  }
281
282  public final class JoinSpec implements android.os.Parcelable {
283    method public final int describeContents();
284    method public int getAggregationScoringStrategy();
285    method @NonNull public String getChildPropertyExpression();
286    method public int getMaxJoinedResultCount();
287    method @NonNull public String getNestedQuery();
288    method @NonNull public android.app.appsearch.SearchSpec getNestedSearchSpec();
289    method public void writeToParcel(@NonNull android.os.Parcel, int);
290    field public static final int AGGREGATION_SCORING_AVG_RANKING_SIGNAL = 3; // 0x3
291    field public static final int AGGREGATION_SCORING_MAX_RANKING_SIGNAL = 4; // 0x4
292    field public static final int AGGREGATION_SCORING_MIN_RANKING_SIGNAL = 2; // 0x2
293    field public static final int AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL = 0; // 0x0
294    field public static final int AGGREGATION_SCORING_RESULT_COUNT = 1; // 0x1
295    field public static final int AGGREGATION_SCORING_SUM_RANKING_SIGNAL = 5; // 0x5
296    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.JoinSpec> CREATOR;
297  }
298
299  public static final class JoinSpec.Builder {
300    ctor public JoinSpec.Builder(@NonNull String);
301    method @NonNull public android.app.appsearch.JoinSpec build();
302    method @NonNull public android.app.appsearch.JoinSpec.Builder setAggregationScoringStrategy(int);
303    method @NonNull public android.app.appsearch.JoinSpec.Builder setMaxJoinedResultCount(int);
304    method @NonNull public android.app.appsearch.JoinSpec.Builder setNestedSearch(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
305  }
306
307  public abstract class Migrator {
308    ctor public Migrator();
309    method @NonNull @WorkerThread public abstract android.app.appsearch.GenericDocument onDowngrade(int, int, @NonNull android.app.appsearch.GenericDocument);
310    method @NonNull @WorkerThread public abstract android.app.appsearch.GenericDocument onUpgrade(int, int, @NonNull android.app.appsearch.GenericDocument);
311    method public abstract boolean shouldMigrate(int, int);
312  }
313
314  public class PackageIdentifier {
315    ctor public PackageIdentifier(@NonNull String, @NonNull byte[]);
316    method @NonNull public String getPackageName();
317    method @NonNull public byte[] getSha256Certificate();
318  }
319
320  public class PropertyPath implements java.lang.Iterable<android.app.appsearch.PropertyPath.PathSegment> {
321    ctor public PropertyPath(@NonNull java.util.List<android.app.appsearch.PropertyPath.PathSegment>);
322    ctor public PropertyPath(@NonNull String);
323    method @NonNull public android.app.appsearch.PropertyPath.PathSegment get(int);
324    method @NonNull public java.util.Iterator<android.app.appsearch.PropertyPath.PathSegment> iterator();
325    method public int size();
326  }
327
328  public static class PropertyPath.PathSegment {
329    method @NonNull public static android.app.appsearch.PropertyPath.PathSegment create(@NonNull String, int);
330    method @NonNull public static android.app.appsearch.PropertyPath.PathSegment create(@NonNull String);
331    method public int getPropertyIndex();
332    method @NonNull public String getPropertyName();
333    field public static final int NON_REPEATED_CARDINALITY = -1; // 0xffffffff
334  }
335
336  public final class PutDocumentsRequest {
337    method @NonNull public java.util.List<android.app.appsearch.GenericDocument> getGenericDocuments();
338    method @NonNull public java.util.List<android.app.appsearch.GenericDocument> getTakenActionGenericDocuments();
339  }
340
341  public static final class PutDocumentsRequest.Builder {
342    ctor public PutDocumentsRequest.Builder();
343    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addGenericDocuments(@NonNull android.app.appsearch.GenericDocument...);
344    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addGenericDocuments(@NonNull java.util.Collection<? extends android.app.appsearch.GenericDocument>);
345    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addTakenActionGenericDocuments(@NonNull android.app.appsearch.GenericDocument...) throws android.app.appsearch.exceptions.AppSearchException;
346    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addTakenActionGenericDocuments(@NonNull java.util.Collection<? extends android.app.appsearch.GenericDocument>) throws android.app.appsearch.exceptions.AppSearchException;
347    method @NonNull public android.app.appsearch.PutDocumentsRequest build();
348  }
349
350  public final class RemoveByDocumentIdRequest implements android.os.Parcelable {
351    method public final int describeContents();
352    method @NonNull public java.util.Set<java.lang.String> getIds();
353    method @NonNull public String getNamespace();
354    method public void writeToParcel(@NonNull android.os.Parcel, int);
355    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.RemoveByDocumentIdRequest> CREATOR;
356  }
357
358  public static final class RemoveByDocumentIdRequest.Builder {
359    ctor public RemoveByDocumentIdRequest.Builder(@NonNull String);
360    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest.Builder addIds(@NonNull java.lang.String...);
361    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest.Builder addIds(@NonNull java.util.Collection<java.lang.String>);
362    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest build();
363  }
364
365  public final class ReportSystemUsageRequest {
366    method @NonNull public String getDatabaseName();
367    method @NonNull public String getDocumentId();
368    method @NonNull public String getNamespace();
369    method @NonNull public String getPackageName();
370    method public long getUsageTimestampMillis();
371  }
372
373  public static final class ReportSystemUsageRequest.Builder {
374    ctor public ReportSystemUsageRequest.Builder(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
375    method @NonNull public android.app.appsearch.ReportSystemUsageRequest build();
376    method @NonNull public android.app.appsearch.ReportSystemUsageRequest.Builder setUsageTimestampMillis(long);
377  }
378
379  public final class ReportUsageRequest implements android.os.Parcelable {
380    method public final int describeContents();
381    method @NonNull public String getDocumentId();
382    method @NonNull public String getNamespace();
383    method public long getUsageTimestampMillis();
384    method public void writeToParcel(@NonNull android.os.Parcel, int);
385    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.ReportUsageRequest> CREATOR;
386  }
387
388  public static final class ReportUsageRequest.Builder {
389    ctor public ReportUsageRequest.Builder(@NonNull String, @NonNull String);
390    method @NonNull public android.app.appsearch.ReportUsageRequest build();
391    method @NonNull public android.app.appsearch.ReportUsageRequest.Builder setUsageTimestampMillis(long);
392  }
393
394  public final class SchemaVisibilityConfig implements android.os.Parcelable {
395    method public final int describeContents();
396    method @NonNull public java.util.List<android.app.appsearch.PackageIdentifier> getAllowedPackages();
397    method @Nullable public android.app.appsearch.PackageIdentifier getPubliclyVisibleTargetPackage();
398    method @NonNull public java.util.Set<java.util.Set<java.lang.Integer>> getRequiredPermissions();
399    method public void writeToParcel(@NonNull android.os.Parcel, int);
400    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SchemaVisibilityConfig> CREATOR;
401  }
402
403  public static final class SchemaVisibilityConfig.Builder {
404    ctor public SchemaVisibilityConfig.Builder();
405    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder addAllowedPackage(@NonNull android.app.appsearch.PackageIdentifier);
406    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder addRequiredPermissions(@NonNull java.util.Set<java.lang.Integer>);
407    method @NonNull public android.app.appsearch.SchemaVisibilityConfig build();
408    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder clearAllowedPackages();
409    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder clearRequiredPermissions();
410    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder setPubliclyVisibleTargetPackage(@Nullable android.app.appsearch.PackageIdentifier);
411  }
412
413  public final class SearchResult implements android.os.Parcelable {
414    method public final int describeContents();
415    method @NonNull public String getDatabaseName();
416    method @NonNull public android.app.appsearch.GenericDocument getGenericDocument();
417    method @NonNull public java.util.List<android.app.appsearch.SearchResult> getJoinedResults();
418    method @NonNull public java.util.List<android.app.appsearch.SearchResult.MatchInfo> getMatchInfos();
419    method @NonNull public String getPackageName();
420    method public double getRankingSignal();
421    method public void writeToParcel(@NonNull android.os.Parcel, int);
422    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchResult> CREATOR;
423  }
424
425  public static final class SearchResult.Builder {
426    ctor public SearchResult.Builder(@NonNull String, @NonNull String);
427    method @NonNull public android.app.appsearch.SearchResult.Builder addJoinedResult(@NonNull android.app.appsearch.SearchResult);
428    method @NonNull public android.app.appsearch.SearchResult.Builder addMatchInfo(@NonNull android.app.appsearch.SearchResult.MatchInfo);
429    method @NonNull public android.app.appsearch.SearchResult build();
430    method @NonNull public android.app.appsearch.SearchResult.Builder setGenericDocument(@NonNull android.app.appsearch.GenericDocument);
431    method @NonNull public android.app.appsearch.SearchResult.Builder setRankingSignal(double);
432  }
433
434  public static final class SearchResult.MatchInfo implements android.os.Parcelable {
435    method public final int describeContents();
436    method @NonNull public CharSequence getExactMatch();
437    method @NonNull public android.app.appsearch.SearchResult.MatchRange getExactMatchRange();
438    method @NonNull public String getFullText();
439    method @NonNull public String getPropertyPath();
440    method @NonNull public android.app.appsearch.PropertyPath getPropertyPathObject();
441    method @NonNull public CharSequence getSnippet();
442    method @NonNull public android.app.appsearch.SearchResult.MatchRange getSnippetRange();
443    method @NonNull public CharSequence getSubmatch();
444    method @NonNull public android.app.appsearch.SearchResult.MatchRange getSubmatchRange();
445    method public void writeToParcel(@NonNull android.os.Parcel, int);
446    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchResult.MatchInfo> CREATOR;
447  }
448
449  public static final class SearchResult.MatchInfo.Builder {
450    ctor public SearchResult.MatchInfo.Builder(@NonNull String);
451    method @NonNull public android.app.appsearch.SearchResult.MatchInfo build();
452    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setExactMatchRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
453    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setSnippetRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
454    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setSubmatchRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
455  }
456
457  public static final class SearchResult.MatchRange {
458    ctor public SearchResult.MatchRange(int, int);
459    method public int getEnd();
460    method public int getStart();
461  }
462
463  public class SearchResults implements java.io.Closeable {
464    method public void close();
465    method public void getNextPage(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.List<android.app.appsearch.SearchResult>>>);
466  }
467
468  public final class SearchSpec implements android.os.Parcelable {
469    method public final int describeContents();
470    method @NonNull public String getAdvancedRankingExpression();
471    method @NonNull public java.util.List<java.lang.String> getFilterNamespaces();
472    method @NonNull public java.util.List<java.lang.String> getFilterPackageNames();
473    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterProperties();
474    method @NonNull public java.util.List<java.lang.String> getFilterSchemas();
475    method @Nullable public android.app.appsearch.JoinSpec getJoinSpec();
476    method public int getMaxSnippetSize();
477    method public int getOrder();
478    method @NonNull public java.util.Map<java.lang.String,java.util.List<android.app.appsearch.PropertyPath>> getProjectionPaths();
479    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProjections();
480    method @NonNull public java.util.Map<java.lang.String,java.util.Map<android.app.appsearch.PropertyPath,java.lang.Double>> getPropertyWeightPaths();
481    method @NonNull public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>> getPropertyWeights();
482    method public int getRankingStrategy();
483    method public int getResultCountPerPage();
484    method public int getResultGroupingLimit();
485    method public int getResultGroupingTypeFlags();
486    method @Nullable public String getSearchSourceLogTag();
487    method public int getSnippetCount();
488    method public int getSnippetCountPerProperty();
489    method public int getTermMatch();
490    method public boolean isListFilterHasPropertyFunctionEnabled();
491    method public boolean isListFilterQueryLanguageEnabled();
492    method public boolean isNumericSearchEnabled();
493    method public boolean isVerbatimSearchEnabled();
494    method public void writeToParcel(@NonNull android.os.Parcel, int);
495    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSpec> CREATOR;
496    field public static final int GROUPING_TYPE_PER_NAMESPACE = 2; // 0x2
497    field public static final int GROUPING_TYPE_PER_PACKAGE = 1; // 0x1
498    field public static final int GROUPING_TYPE_PER_SCHEMA = 4; // 0x4
499    field public static final int ORDER_ASCENDING = 1; // 0x1
500    field public static final int ORDER_DESCENDING = 0; // 0x0
501    field @Deprecated public static final String PROJECTION_SCHEMA_TYPE_WILDCARD = "*";
502    field public static final int RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION = 9; // 0x9
503    field public static final int RANKING_STRATEGY_CREATION_TIMESTAMP = 2; // 0x2
504    field public static final int RANKING_STRATEGY_DOCUMENT_SCORE = 1; // 0x1
505    field public static final int RANKING_STRATEGY_JOIN_AGGREGATE_SCORE = 8; // 0x8
506    field public static final int RANKING_STRATEGY_NONE = 0; // 0x0
507    field public static final int RANKING_STRATEGY_RELEVANCE_SCORE = 3; // 0x3
508    field public static final int RANKING_STRATEGY_SYSTEM_USAGE_COUNT = 6; // 0x6
509    field public static final int RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP = 7; // 0x7
510    field public static final int RANKING_STRATEGY_USAGE_COUNT = 4; // 0x4
511    field public static final int RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP = 5; // 0x5
512    field public static final String SCHEMA_TYPE_WILDCARD = "*";
513    field public static final int TERM_MATCH_EXACT_ONLY = 1; // 0x1
514    field public static final int TERM_MATCH_PREFIX = 2; // 0x2
515  }
516
517  public static final class SearchSpec.Builder {
518    ctor public SearchSpec.Builder();
519    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterNamespaces(@NonNull java.lang.String...);
520    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterNamespaces(@NonNull java.util.Collection<java.lang.String>);
521    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPackageNames(@NonNull java.lang.String...);
522    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPackageNames(@NonNull java.util.Collection<java.lang.String>);
523    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterProperties(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
524    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPropertyPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
525    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
526    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
527    method @NonNull public android.app.appsearch.SearchSpec.Builder addProjection(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
528    method @NonNull public android.app.appsearch.SearchSpec.Builder addProjectionPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
529    method @NonNull public android.app.appsearch.SearchSpec build();
530    method @NonNull public android.app.appsearch.SearchSpec.Builder setJoinSpec(@NonNull android.app.appsearch.JoinSpec);
531    method @NonNull public android.app.appsearch.SearchSpec.Builder setListFilterHasPropertyFunctionEnabled(boolean);
532    method @NonNull public android.app.appsearch.SearchSpec.Builder setListFilterQueryLanguageEnabled(boolean);
533    method @NonNull public android.app.appsearch.SearchSpec.Builder setMaxSnippetSize(@IntRange(from=0, to=0x2710) int);
534    method @NonNull public android.app.appsearch.SearchSpec.Builder setNumericSearchEnabled(boolean);
535    method @NonNull public android.app.appsearch.SearchSpec.Builder setOrder(int);
536    method @NonNull public android.app.appsearch.SearchSpec.Builder setPropertyWeightPaths(@NonNull String, @NonNull java.util.Map<android.app.appsearch.PropertyPath,java.lang.Double>);
537    method @NonNull public android.app.appsearch.SearchSpec.Builder setPropertyWeights(@NonNull String, @NonNull java.util.Map<java.lang.String,java.lang.Double>);
538    method @NonNull public android.app.appsearch.SearchSpec.Builder setRankingStrategy(int);
539    method @NonNull public android.app.appsearch.SearchSpec.Builder setRankingStrategy(@NonNull String);
540    method @NonNull public android.app.appsearch.SearchSpec.Builder setResultCountPerPage(@IntRange(from=0, to=0x2710) int);
541    method @NonNull public android.app.appsearch.SearchSpec.Builder setResultGrouping(int, int);
542    method @NonNull public android.app.appsearch.SearchSpec.Builder setSearchSourceLogTag(@NonNull String);
543    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCount(@IntRange(from=0, to=0x2710) int);
544    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCountPerProperty(@IntRange(from=0, to=0x2710) int);
545    method @NonNull public android.app.appsearch.SearchSpec.Builder setTermMatch(int);
546    method @NonNull public android.app.appsearch.SearchSpec.Builder setVerbatimSearchEnabled(boolean);
547  }
548
549  public final class SearchSuggestionResult implements android.os.Parcelable {
550    method public final int describeContents();
551    method @NonNull public String getSuggestedResult();
552    method public void writeToParcel(@NonNull android.os.Parcel, int);
553    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSuggestionResult> CREATOR;
554  }
555
556  public static final class SearchSuggestionResult.Builder {
557    ctor public SearchSuggestionResult.Builder();
558    method @NonNull public android.app.appsearch.SearchSuggestionResult build();
559    method @NonNull public android.app.appsearch.SearchSuggestionResult.Builder setSuggestedResult(@NonNull String);
560  }
561
562  public final class SearchSuggestionSpec implements android.os.Parcelable {
563    method public final int describeContents();
564    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterDocumentIds();
565    method @NonNull public java.util.List<java.lang.String> getFilterNamespaces();
566    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterProperties();
567    method @NonNull public java.util.List<java.lang.String> getFilterSchemas();
568    method public int getMaximumResultCount();
569    method public int getRankingStrategy();
570    method public void writeToParcel(@NonNull android.os.Parcel, int);
571    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSuggestionSpec> CREATOR;
572    field public static final int SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT = 0; // 0x0
573    field public static final int SUGGESTION_RANKING_STRATEGY_NONE = 2; // 0x2
574    field public static final int SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY = 1; // 0x1
575  }
576
577  public static final class SearchSuggestionSpec.Builder {
578    ctor public SearchSuggestionSpec.Builder(@IntRange(from=1) int);
579    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterDocumentIds(@NonNull String, @NonNull java.lang.String...);
580    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterDocumentIds(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
581    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterNamespaces(@NonNull java.lang.String...);
582    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterNamespaces(@NonNull java.util.Collection<java.lang.String>);
583    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterProperties(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
584    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterPropertyPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
585    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
586    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
587    method @NonNull public android.app.appsearch.SearchSuggestionSpec build();
588    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder setRankingStrategy(int);
589  }
590
591  public final class SetSchemaRequest {
592    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.Migrator> getMigrators();
593    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.PackageIdentifier> getPubliclyVisibleSchemas();
594    method @NonNull public java.util.Map<java.lang.String,java.util.Set<java.util.Set<java.lang.Integer>>> getRequiredPermissionsForSchemaTypeVisibility();
595    method @NonNull public java.util.Set<android.app.appsearch.AppSearchSchema> getSchemas();
596    method @NonNull public java.util.Set<java.lang.String> getSchemasNotDisplayedBySystem();
597    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.SchemaVisibilityConfig>> getSchemasVisibleToConfigs();
598    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.PackageIdentifier>> getSchemasVisibleToPackages();
599    method @IntRange(from=1) public int getVersion();
600    method public boolean isForceOverride();
601    field public static final int READ_ASSISTANT_APP_SEARCH_DATA = 6; // 0x6
602    field public static final int READ_CALENDAR = 2; // 0x2
603    field public static final int READ_CONTACTS = 3; // 0x3
604    field public static final int READ_EXTERNAL_STORAGE = 4; // 0x4
605    field public static final int READ_HOME_APP_SEARCH_DATA = 5; // 0x5
606    field public static final int READ_SMS = 1; // 0x1
607  }
608
609  public static final class SetSchemaRequest.Builder {
610    ctor public SetSchemaRequest.Builder();
611    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addRequiredPermissionsForSchemaTypeVisibility(@NonNull String, @NonNull java.util.Set<java.lang.Integer>);
612    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemaTypeVisibleToConfig(@NonNull String, @NonNull android.app.appsearch.SchemaVisibilityConfig);
613    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemas(@NonNull android.app.appsearch.AppSearchSchema...);
614    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemas(@NonNull java.util.Collection<android.app.appsearch.AppSearchSchema>);
615    method @NonNull public android.app.appsearch.SetSchemaRequest build();
616    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearRequiredPermissionsForSchemaTypeVisibility(@NonNull String);
617    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearSchemaTypeVisibleToConfigs(@NonNull String);
618    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setForceOverride(boolean);
619    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setMigrator(@NonNull String, @NonNull android.app.appsearch.Migrator);
620    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setMigrators(@NonNull java.util.Map<java.lang.String,android.app.appsearch.Migrator>);
621    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setPubliclyVisibleSchema(@NonNull String, @Nullable android.app.appsearch.PackageIdentifier);
622    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setSchemaTypeDisplayedBySystem(@NonNull String, boolean);
623    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setSchemaTypeVisibilityForPackage(@NonNull String, boolean, @NonNull android.app.appsearch.PackageIdentifier);
624    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setVersion(@IntRange(from=1) int);
625  }
626
627  public final class SetSchemaResponse implements android.os.Parcelable {
628    method public final int describeContents();
629    method @NonNull public java.util.Set<java.lang.String> getDeletedTypes();
630    method @NonNull public java.util.Set<java.lang.String> getIncompatibleTypes();
631    method @NonNull public java.util.Set<java.lang.String> getMigratedTypes();
632    method @NonNull public java.util.List<android.app.appsearch.SetSchemaResponse.MigrationFailure> getMigrationFailures();
633    method public void writeToParcel(@NonNull android.os.Parcel, int);
634    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SetSchemaResponse> CREATOR;
635  }
636
637  public static final class SetSchemaResponse.Builder {
638    ctor public SetSchemaResponse.Builder();
639    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addDeletedType(@NonNull String);
640    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addDeletedTypes(@NonNull java.util.Collection<java.lang.String>);
641    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addIncompatibleType(@NonNull String);
642    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addIncompatibleTypes(@NonNull java.util.Collection<java.lang.String>);
643    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigratedType(@NonNull String);
644    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigratedTypes(@NonNull java.util.Collection<java.lang.String>);
645    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigrationFailure(@NonNull android.app.appsearch.SetSchemaResponse.MigrationFailure);
646    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigrationFailures(@NonNull java.util.Collection<android.app.appsearch.SetSchemaResponse.MigrationFailure>);
647    method @NonNull public android.app.appsearch.SetSchemaResponse build();
648  }
649
650  public static class SetSchemaResponse.MigrationFailure implements android.os.Parcelable {
651    ctor public SetSchemaResponse.MigrationFailure(@NonNull String, @NonNull String, @NonNull String, @NonNull android.app.appsearch.AppSearchResult<?>);
652    method public final int describeContents();
653    method @NonNull public android.app.appsearch.AppSearchResult<java.lang.Void> getAppSearchResult();
654    method @NonNull public String getDocumentId();
655    method @NonNull public String getNamespace();
656    method @NonNull public String getSchemaType();
657    method public void writeToParcel(@NonNull android.os.Parcel, int);
658    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SetSchemaResponse.MigrationFailure> CREATOR;
659  }
660
661  public final class StorageInfo implements android.os.Parcelable {
662    method public final int describeContents();
663    method public int getAliveDocumentsCount();
664    method public int getAliveNamespacesCount();
665    method public long getSizeBytes();
666    method public void writeToParcel(@NonNull android.os.Parcel, int);
667    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.StorageInfo> CREATOR;
668  }
669
670  public static final class StorageInfo.Builder {
671    ctor public StorageInfo.Builder();
672    method @NonNull public android.app.appsearch.StorageInfo build();
673    method @NonNull public android.app.appsearch.StorageInfo.Builder setAliveDocumentsCount(int);
674    method @NonNull public android.app.appsearch.StorageInfo.Builder setAliveNamespacesCount(int);
675    method @NonNull public android.app.appsearch.StorageInfo.Builder setSizeBytes(long);
676  }
677
678}
679
680package android.app.appsearch.exceptions {
681
682  public class AppSearchException extends java.lang.Exception {
683    ctor public AppSearchException(int);
684    ctor public AppSearchException(int, @Nullable String);
685    ctor public AppSearchException(int, @Nullable String, @Nullable Throwable);
686    method public int getResultCode();
687    method @NonNull public <T> android.app.appsearch.AppSearchResult<T> toAppSearchResult();
688  }
689
690}
691
692package android.app.appsearch.observer {
693
694  public final class DocumentChangeInfo {
695    ctor public DocumentChangeInfo(@NonNull String, @NonNull String, @NonNull String, @NonNull String, @NonNull java.util.Set<java.lang.String>);
696    method @NonNull public java.util.Set<java.lang.String> getChangedDocumentIds();
697    method @NonNull public String getDatabaseName();
698    method @NonNull public String getNamespace();
699    method @NonNull public String getPackageName();
700    method @NonNull public String getSchemaName();
701  }
702
703  public interface ObserverCallback {
704    method public void onDocumentChanged(@NonNull android.app.appsearch.observer.DocumentChangeInfo);
705    method public void onSchemaChanged(@NonNull android.app.appsearch.observer.SchemaChangeInfo);
706  }
707
708  public final class ObserverSpec implements android.os.Parcelable {
709    method public final int describeContents();
710    method @NonNull public java.util.Set<java.lang.String> getFilterSchemas();
711    method public void writeToParcel(@NonNull android.os.Parcel, int);
712    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.observer.ObserverSpec> CREATOR;
713  }
714
715  public static final class ObserverSpec.Builder {
716    ctor public ObserverSpec.Builder();
717    method @NonNull public android.app.appsearch.observer.ObserverSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
718    method @NonNull public android.app.appsearch.observer.ObserverSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
719    method @NonNull public android.app.appsearch.observer.ObserverSpec build();
720  }
721
722  public final class SchemaChangeInfo {
723    ctor public SchemaChangeInfo(@NonNull String, @NonNull String, @NonNull java.util.Set<java.lang.String>);
724    method @NonNull public java.util.Set<java.lang.String> getChangedSchemaNames();
725    method @NonNull public String getDatabaseName();
726    method @NonNull public String getPackageName();
727  }
728
729}
730
731package android.app.appsearch.util {
732
733  public class DocumentIdUtil {
734    method @NonNull public static String createQualifiedId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GenericDocument);
735    method @NonNull public static String createQualifiedId(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
736  }
737
738}
739
740