mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-10-17 07:23:08 +01:00
b8a2190168
* 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>
48 lines
2.2 KiB
C#
48 lines
2.2 KiB
C#
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace SpotifyAPI.Web
|
|
{
|
|
/// <summary>
|
|
/// Endpoints for retrieving information about one or more episodes from the Spotify catalog.
|
|
/// </summary>
|
|
public interface IEpisodesClient
|
|
{
|
|
/// <summary>
|
|
/// Get Spotify catalog information for a single episode identified by its unique Spotify ID.
|
|
/// </summary>
|
|
/// <param name="episodeId">The Spotify ID for the episode.</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-get-an-episode
|
|
/// </remarks>
|
|
/// <returns></returns>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
|
|
Task<FullEpisode> Get(string episodeId, CancellationToken cancel = default);
|
|
|
|
/// <summary>
|
|
/// Get Spotify catalog information for a single episode identified by its unique Spotify ID.
|
|
/// </summary>
|
|
/// <param name="episodeId">The Spotify ID for the episode.</param>
|
|
/// <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-get-an-episode
|
|
/// </remarks>
|
|
/// <returns></returns>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
|
|
Task<FullEpisode> Get(string episodeId, EpisodeRequest request, CancellationToken cancel = default);
|
|
|
|
/// <summary>
|
|
/// Get Spotify catalog information for several episodes based on their Spotify IDs.
|
|
/// </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-get-multiple-episodes
|
|
/// </remarks>
|
|
/// <returns></returns>
|
|
Task<EpisodesResponse> GetSeveral(EpisodesRequest request, CancellationToken cancel = default);
|
|
}
|
|
}
|