Added in API level 31

android.app.appsearch

Interfaces

BatchResultCallback<KeyType, ValueType> The callback interface to return AppSearchBatchResult. 

Classes

AppSearchBatchResult<KeyType, ValueType> Provides results for AppSearch batch operations which encompass multiple documents. 
AppSearchBatchResult.Builder<KeyType, ValueType> Builder for AppSearchBatchResult objects. 
AppSearchBlobHandle An identifier to represent a blob in AppSearch. 
AppSearchManager Provides access to the centralized AppSearch index maintained by the system. 
AppSearchManager.SearchContext Contains information about how to create the search session. 
AppSearchManager.SearchContext.Builder Builder for SearchContext objects. 
AppSearchResult<ValueType> Information about the success or failure of an AppSearch call. 
AppSearchSchema The AppSearch Schema for a particular type of document. 
AppSearchSchema.BlobHandlePropertyConfig Configuration for a property of type AppSearchBlobHandle in a Document. 
AppSearchSchema.BlobHandlePropertyConfig.Builder Builder for BlobHandlePropertyConfig. 
AppSearchSchema.BooleanPropertyConfig Configuration for a property containing a boolean. 
AppSearchSchema.BooleanPropertyConfig.Builder Builder for BooleanPropertyConfig. 
AppSearchSchema.Builder Builder for objects. 
AppSearchSchema.BytesPropertyConfig Configuration for a property containing a byte array. 
AppSearchSchema.BytesPropertyConfig.Builder Builder for BytesPropertyConfig. 
AppSearchSchema.DocumentPropertyConfig Configuration for a property containing another Document. 
AppSearchSchema.DocumentPropertyConfig.Builder Builder for DocumentPropertyConfig. 
AppSearchSchema.DoublePropertyConfig Configuration for a property containing a double-precision decimal number. 
AppSearchSchema.DoublePropertyConfig.Builder Builder for DoublePropertyConfig. 
AppSearchSchema.EmbeddingPropertyConfig Configuration for a property of type EmbeddingVector in a Document. 
AppSearchSchema.EmbeddingPropertyConfig.Builder Builder for EmbeddingPropertyConfig. 
AppSearchSchema.LongPropertyConfig Configuration for a property containing a 64-bit integer. 
AppSearchSchema.LongPropertyConfig.Builder Builder for LongPropertyConfig. 
AppSearchSchema.PropertyConfig Common configuration for a single property (field) in a Document. 
AppSearchSchema.StringPropertyConfig Configuration for a property of type String in a Document. 
AppSearchSchema.StringPropertyConfig.Builder Builder for StringPropertyConfig. 
AppSearchSession Provides a connection to a single AppSearch database. 
CommitBlobResponse The response to provide batch operation results of AppSearchSession.commitBlob. 
EmbeddingVector Embeddings are vector representations of data, such as text, images, and audio, which can be generated by machine learning models and used for semantic search. 
EnterpriseGlobalSearchSession Provides a connection to all enterprise (work profile) AppSearch databases the querying application has been granted access to. 
GenericDocument Represents a document unit. 
GenericDocument.Builder<BuilderType extends GenericDocument.Builder<BuilderType>> The builder class for GenericDocument. 
GetByDocumentIdRequest Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database. 
GetByDocumentIdRequest.Builder Builder for GetByDocumentIdRequest objects. 
GetSchemaResponse The response class of AppSearchSession.getSchema 
GetSchemaResponse.Builder Builder for GetSchemaResponse objects. 
GlobalSearchSession Provides a connection to all AppSearch databases the querying application has been granted access to. 
JoinSpec This class represents the specifications for the joining operation in search. 
JoinSpec.Builder Builder for objects. 
Migrator A migrator class to translate GenericDocument from different version of AppSearchSchema

Make non-backwards-compatible changes will delete all stored documents in old schema. 

OpenBlobForReadResponse The response to provide batch operation results of AppSearchSession.openBlobForRead. 
OpenBlobForWriteResponse The response to provide batch operation results of AppSearchSession.openBlobForWrite. 
PackageIdentifier This class represents a uniquely identifiable package. 
PropertyPath Represents a property path returned from searching the AppSearch Database. 
PropertyPath.PathSegment A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property. 
PutDocumentsRequest Encapsulates a request to index documents into an AppSearchSession database. 
PutDocumentsRequest.Builder Builder for PutDocumentsRequest objects. 
RemoveBlobResponse Results of AppSearchSession.removeBlob, containing the outcome of the removal of each handles. 
RemoveByDocumentIdRequest Encapsulates a request to remove documents by namespace and IDs from the AppSearchSession database. 
RemoveByDocumentIdRequest.Builder Builder for RemoveByDocumentIdRequest objects. 
ReportSystemUsageRequest A request to report usage of a document owned by another app from a system UI surface. 
ReportSystemUsageRequest.Builder Builder for ReportSystemUsageRequest objects. 
ReportUsageRequest A request to report usage of a document. 
ReportUsageRequest.Builder Builder for ReportUsageRequest objects. 
SchemaVisibilityConfig A class to hold a all necessary Visibility information corresponding to the same schema. 
SchemaVisibilityConfig.Builder The builder class of SchemaVisibilityConfig. 
SearchResult This class represents one of the results obtained from an AppSearch query. 
SearchResult.Builder Builder for SearchResult objects. 
SearchResult.EmbeddingMatchInfo This class represents match objects for any snippets that might be present in SearchResults from an embedding query. 
SearchResult.MatchInfo This class represents match objects for any snippets that might be present in SearchResults from a query. 
SearchResult.MatchInfo.Builder Builder for MatchInfo objects. 
SearchResult.MatchRange Class providing the position range of a text match information. 
SearchResult.TextMatchInfo This class represents match objects for any text match snippets that might be present in SearchResults from a string query. 
SearchResults Encapsulates results of a search operation. 
SearchSpec This class represents the specification logic for AppSearch. 
SearchSpec.Builder Builder for objects. 
SearchSuggestionResult The result class of the AppSearchSession.searchSuggestion. 
SearchSuggestionResult.Builder The Builder class of SearchSuggestionResult. 
SearchSuggestionSpec This class represents the specification logic for AppSearch. 
SearchSuggestionSpec.Builder Builder for objects. 
SetBlobVisibilityRequest Request to configure the visibility settings of blobs in AppSearch. 
SetBlobVisibilityRequest.Builder Builder for SetBlobVisibilityRequest objects. 
SetSchemaRequest Encapsulates a request to update the schema of an AppSearchSession database. 
SetSchemaRequest.Builder Builder for SetSchemaRequest objects. 
SetSchemaResponse The response class of AppSearchSession.setSchema 
SetSchemaResponse.Builder Builder for SetSchemaResponse objects. 
SetSchemaResponse.MigrationFailure The class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession.setSchema. 
StorageInfo The response class of AppSearchSession#getStorageInfo. 
StorageInfo.Builder Builder for StorageInfo objects.