Interface ISearch
Provides various search-related activities.
Inherited Members
Namespace: StrixMusic.Sdk.AppModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface ISearch : ISearchBase, IAppModel, IMerged<ICoreSearch>, IEquatable<ICoreSearch>, IMerged
Remarks
Instances of this class may contain data merged from one or more sources.
Properties
| Improve this Doc View SourceSearchHistory
Contains items that the user has recently selected from the search results.
Declaration
ISearchHistory? SearchHistory { get; }
Property Value
Type | Description |
---|---|
ISearchHistory |
Methods
| Improve this Doc View SourceGetRecentSearchQueries(CancellationToken)
Gets the recent search queries.
Declaration
IAsyncEnumerable<ISearchQuery> GetRecentSearchQueries(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
IAsyncEnumerable<ISearchQuery> | The recent search queries. |
GetSearchResultsAsync(string, CancellationToken)
Gets search results for a given query.
Declaration
Task<ISearchResults> GetSearchResultsAsync(string query, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | query | The search query. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task<ISearchResults> | A task representing the async operation. Value is ISearchResults. |