Android.App.AppSearch Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides schemas, documents, queries, and access settings for AppSearch databases.
Classes
| Name | Description |
|---|---|
| AppSearchAccount |
Encapsulates a |
| AppSearchAccount.Builder |
The builder class for |
| AppSearchBatchResult |
Provides results for AppSearch batch operations which encompass multiple documents. |
| AppSearchBatchResult.Builder |
Builder for |
| AppSearchBlobHandle |
An identifier to represent a blob in AppSearch. |
| AppSearchBlobHandle.InterfaceConsts |
Provides the inherited parcel flags for AppSearchBlobHandle. |
| 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 |
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 |
| 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 |
| 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 |
| AppSearchSchema.EmbeddingPropertyConfig.Builder |
Builder for EmbeddingPropertyConfig. |
| AppSearchSchema.InterfaceConsts |
Provides the inherited parcel flags for AppSearchSchema. |
| 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 |
| CommitBlobResponse.InterfaceConsts |
Provides the inherited parcel flags for CommitBlobResponse. |
| 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. |
| EmbeddingVector.InterfaceConsts |
Provides the inherited parcel flags for EmbeddingVector. |
| 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 |
The builder class for |
| GetByDocumentIdRequest |
Encapsulates a request to retrieve documents by namespace and IDs from the |
| GetByDocumentIdRequest.Builder |
Builder for |
| GetByDocumentIdRequest.InterfaceConsts |
Provides the inherited parcel flags for GetByDocumentIdRequest. |
| GetSchemaResponse |
The response class of |
| GetSchemaResponse.Builder |
Builder for |
| GetSchemaResponse.InterfaceConsts |
Provides the inherited parcel flags for GetSchemaResponse. |
| 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 |
| JoinSpec.InterfaceConsts |
Provides the inherited parcel flags for JoinSpec. |
| Migrator |
A migrator class to translate |
| OpenBlobForReadResponse |
The response to provide batch operation results of |
| OpenBlobForReadResponse.InterfaceConsts |
Provides the inherited parcel flags for OpenBlobForReadResponse. |
| OpenBlobForWriteResponse |
The response to provide batch operation results of |
| OpenBlobForWriteResponse.InterfaceConsts |
Provides the inherited parcel flags for OpenBlobForWriteResponse. |
| 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 |
| PutDocumentsRequest.Builder |
Builder for |
| RemoveBlobResponse |
Results of |
| RemoveBlobResponse.InterfaceConsts |
Provides the inherited parcel flags for RemoveBlobResponse. |
| RemoveByDocumentIdRequest |
Encapsulates a request to remove documents by namespace and IDs from the |
| RemoveByDocumentIdRequest.Builder |
Builder for |
| RemoveByDocumentIdRequest.InterfaceConsts |
Provides the inherited parcel flags for RemoveByDocumentIdRequest. |
| ReportSystemUsageRequest |
A request to report usage of a document owned by another app from a system UI surface. |
| ReportSystemUsageRequest.Builder |
Builder for |
| ReportUsageRequest |
A request to report usage of a document. |
| ReportUsageRequest.Builder |
Builder for |
| ReportUsageRequest.InterfaceConsts |
Provides the inherited parcel flags for ReportUsageRequest. |
| SchemaVisibilityConfig |
A class to hold a all necessary Visibility information corresponding to the same schema. |
| SchemaVisibilityConfig.Builder |
The builder class of |
| SchemaVisibilityConfig.InterfaceConsts |
Provides the inherited parcel flags for SchemaVisibilityConfig. |
| SearchResult |
This class represents one of the results obtained from an AppSearch query. |
| SearchResult.Builder |
Builder for |
| SearchResult.EmbeddingMatchInfo |
This class represents match objects for any snippets that might be present in |
| SearchResult.EmbeddingMatchInfo.InterfaceConsts |
Provides the inherited parcel flags for SearchResult.EmbeddingMatchInfo. |
| SearchResult.InterfaceConsts |
Provides the inherited parcel flags for SearchResult. |
| SearchResult.MatchInfo |
This class represents match objects for any snippets that might be present in |
| SearchResult.MatchInfo.Builder |
Builder for MatchInfo objects. |
| SearchResult.MatchInfo.InterfaceConsts |
Provides the inherited parcel flags for SearchResult.MatchInfo. |
| SearchResult.MatchRange |
Class providing the position range of a text match information. |
| SearchResult.MatchRange.InterfaceConsts |
Provides the inherited parcel flags for SearchResult.MatchRange. |
| SearchResult.TextMatchInfo |
This class represents match objects for any text match snippets that might be present in
|
| SearchResult.TextMatchInfo.InterfaceConsts |
Provides the inherited parcel flags for SearchResult.TextMatchInfo. |
| SearchResults |
Encapsulates results of a search operation. |
| SearchSpec |
This class represents the specification logic for AppSearch. |
| SearchSpec.Builder |
Builder for |
| SearchSpec.InterfaceConsts |
Provides the inherited parcel flags for SearchSpec. |
| SearchSuggestionResult |
The result class of the |
| SearchSuggestionResult.Builder |
The Builder class of |
| SearchSuggestionResult.InterfaceConsts |
Provides the inherited parcel flags for SearchSuggestionResult. |
| SearchSuggestionSpec |
This class represents the specification logic for AppSearch. |
| SearchSuggestionSpec.Builder |
Builder for |
| SearchSuggestionSpec.InterfaceConsts |
Provides the inherited parcel flags for SearchSuggestionSpec. |
| SetBlobVisibilityRequest |
Request to configure the visibility settings of blobs in AppSearch. |
| SetBlobVisibilityRequest.Builder |
Builder for |
| SetSchemaRequest |
Encapsulates a request to update the schema of an |
| SetSchemaRequest.Builder |
Builder for |
| SetSchemaResponse |
The response class of |
| SetSchemaResponse.Builder |
Builder for |
| SetSchemaResponse.InterfaceConsts |
Provides the inherited parcel flags for SetSchemaResponse. |
| SetSchemaResponse.MigrationFailure |
The class represents a post-migrated |
| SetSchemaResponse.MigrationFailure.InterfaceConsts |
Provides the inherited parcel flags for SetSchemaResponse.MigrationFailure. |
| StorageInfo |
The response class of |
| StorageInfo.Builder |
Builder for |
| StorageInfo.InterfaceConsts |
Provides the inherited parcel flags for StorageInfo. |
Interfaces
| Name | Description |
|---|---|
| IBatchResultCallback |
The callback interface to return |
Enums
| Name | Description |
|---|---|
| AppSearchIndexingType |
Selects indexing for embedding properties. |
| AppSearchQuantizationType |
Selects quantization for embedding properties. |
| AppSearchResultCode |
Identifies the outcome of an AppSearch operation. |
| AppSearchSchemaDeletePropagationType |
Selects deletion propagation for a joinable string property. |
| Cardinality |
Specifies how many values a schema property can contain. |
| EmbeddingSearchMetricType |
Selects the metric used for embedding comparisons. |
| GroupingType |
Selects the identities used to group search results. |
| IndexingType |
Selects term indexing for string properties. |
| JoinSpecAggregationScoring |
Selects how joined results contribute to a ranking signal. |
| LongPropertyConfigIndexingType |
Selects indexing for integer properties. |
| RankingStrategy |
Selects the ranking signal used to order search results. |
| SchemaRequestPermissions |
Identifies permission conditions for schema visibility. |
| SearchOrder |
Selects ascending or descending result order. |
| SearchTermMatch |
Selects how query terms match indexed terms. |
| StringPropertyJoinableValueType |
Selects whether string values can be used as join keys. |
| SuggestionRankingStrategy |
Selects how search suggestions are ranked. |
| TokenizerType |
Selects how a string property is split into indexed tokens. |
Remarks
Use search sessions to store and retrieve documents. Request builders specify schema changes, document operations, search filters, and visibility conditions.