package

androidx.appsearch.app

Interfaces

AppSearchSessionProvides a connection to a single AppSearch database.
CapabilitiesA class that encapsulates all features that are only supported with certain combinations of backend and Android API Level.
DocumentClassFactory<T>An interface for factories which can convert between instances of classes annotated with \@Document and instances of GenericDocument.
GlobalSearchSessionProvides a connection to all AppSearch databases the querying application has been granted access to.
SearchResultsEncapsulates results of a search operation.

Classes

AppSearchBatchResult<KeyType, ValueType>Provides results for AppSearch batch operations which encompass multiple documents.
AppSearchBatchResult.Builder<KeyType, ValueType>Builder for AppSearchBatchResult objects.
AppSearchResult<ValueType>Information about the success or failure of an AppSearch call.
AppSearchSchemaThe AppSearch Schema for a particular type of document.
AppSearchSchema.BooleanPropertyConfigConfiguration for a property containing a boolean.
AppSearchSchema.BooleanPropertyConfig.BuilderBuilder for AppSearchSchema.BooleanPropertyConfig.
AppSearchSchema.BuilderBuilder for objects.
AppSearchSchema.BytesPropertyConfigConfiguration for a property containing a byte array.
AppSearchSchema.BytesPropertyConfig.BuilderBuilder for AppSearchSchema.BytesPropertyConfig.
AppSearchSchema.DocumentPropertyConfigConfiguration for a property containing another Document.
AppSearchSchema.DocumentPropertyConfig.BuilderBuilder for AppSearchSchema.DocumentPropertyConfig.
AppSearchSchema.DoublePropertyConfigConfiguration for a property containing a double-precision decimal number.
AppSearchSchema.DoublePropertyConfig.BuilderBuilder for AppSearchSchema.DoublePropertyConfig.
AppSearchSchema.LongPropertyConfigConfiguration for a property containing a 64-bit integer.
AppSearchSchema.LongPropertyConfig.BuilderBuilder for AppSearchSchema.LongPropertyConfig.
AppSearchSchema.PropertyConfigCommon configuration for a single property (field) in a Document.
AppSearchSchema.StringPropertyConfigConfiguration for a property of type String in a Document.
AppSearchSchema.StringPropertyConfig.BuilderBuilder for AppSearchSchema.StringPropertyConfig.
DocumentClassFactoryRegistryA registry which maintains instances of DocumentClassFactory.
GenericDocumentRepresents a document unit.
GenericDocument.Builder<BuilderType>The builder class for GenericDocument.
GetByDocumentIdRequestEncapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.
GetByDocumentIdRequest.BuilderBuilder for GetByDocumentIdRequest objects.
GetSchemaResponseThe response class of AppSearchSession.getSchema()
GetSchemaResponse.BuilderBuilder for GetSchemaResponse objects.
MigratorA migrator class to translate GenericDocument from different version of AppSearchSchema
PackageIdentifierThis class represents a uniquely identifiable package.
PutDocumentsRequestEncapsulates a request to index documents into an AppSearchSession database.
PutDocumentsRequest.BuilderBuilder for PutDocumentsRequest objects.
RemoveByDocumentIdRequestEncapsulates a request to remove documents by namespace and IDs from the AppSearchSession database.
RemoveByDocumentIdRequest.BuilderBuilder for RemoveByDocumentIdRequest objects.
ReportSystemUsageRequestA request to report usage of a document owned by another app from a system UI surface.
ReportSystemUsageRequest.BuilderBuilder for ReportSystemUsageRequest objects.
ReportUsageRequestA request to report usage of a document.
ReportUsageRequest.BuilderBuilder for ReportUsageRequest objects.
SearchResultThis class represents one of the results obtained from an AppSearch query.
SearchResult.BuilderBuilder for SearchResult objects.
SearchResult.MatchInfoThis class represents a match objects for any Snippets that might be present in SearchResults from query.
SearchResult.MatchInfo.BuilderBuilder for SearchResult.MatchInfo objects.
SearchResult.MatchRangeClass providing the position range of matching information.
SearchResultPageThis class represents a page of SearchResults
SearchSpecThis class represents the specification logic for AppSearch.
SearchSpec.BuilderBuilder for objects.
SetSchemaRequestEncapsulates a request to update the schema of an AppSearchSession database.
SetSchemaRequest.BuilderBuilder for SetSchemaRequest objects.
SetSchemaResponseThe response class of AppSearchSession.setSchema(SetSchemaRequest)
SetSchemaResponse.BuilderBuilder for SetSchemaResponse objects.
SetSchemaResponse.MigrationFailureThe class represents a post-migrated GenericDocument that failed to be saved by AppSearchSession.setSchema(SetSchemaRequest).
StorageInfoThe response class of AppSearchSession#getStorageInfo.
StorageInfo.BuilderBuilder for StorageInfo objects.

Annotation Types

AppSearchResult.ResultCodeResult codes from AppSearchSession methods.
AppSearchSchema.PropertyConfig.CardinalityThe cardinality of the property (whether it is required, optional or repeated).
AppSearchSchema.PropertyConfig.DataTypePhysical data-types of the contents of the property.
AppSearchSchema.StringPropertyConfig.IndexingTypeEncapsulates the configurations on how AppSearch should query/index these terms.
AppSearchSchema.StringPropertyConfig.TokenizerTypeConfigures how tokens should be extracted from this property.
SearchSpec.GroupingTypeGrouping type for result limits.
SearchSpec.OrderOrder for query result.
SearchSpec.RankingStrategyRanking Strategy for query result.
SearchSpec.TermMatchTerm Match Type for the query.