Spotify.NET/SpotifyAPI.Web/Clients/Interfaces/ISearchClient.cs
Sascha Kiefer b8a2190168
feat: allow to pass cancellation token to requests (#813)
* feat: implements markets API

* fix: use correct constructor name

* feat: allow to pass a cancellation token

* pass cancellation token

* pass cancellation token only >NETSTANDARD2_1

Co-authored-by: Jonas Dellinger <jonas@dellinger.dev>
2022-11-18 12:30:09 +01:00

24 lines
799 B
C#

using System.Threading;
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// Search Endpoints
/// </summary>
public interface ISearchClient
{
/// <summary>
/// Get Spotify Catalog information about albums, artists, playlists,
/// tracks, shows or episodes that match a keyword string.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-search
/// </remarks>
/// <returns></returns>
Task<SearchResponse> Item(SearchRequest request, CancellationToken cancel = default);
}
}