mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-10-17 15:33:09 +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>
73 lines
3.4 KiB
C#
73 lines
3.4 KiB
C#
using System.Threading;
|
||
using System.Threading.Tasks;
|
||
|
||
namespace SpotifyAPI.Web
|
||
{
|
||
/// <summary>
|
||
/// Endpoints for retrieving information about one or more albums from the Spotify catalog.
|
||
/// </summary>
|
||
public interface IAlbumsClient
|
||
{
|
||
/// <summary>
|
||
/// Get Spotify catalog information for multiple albums identified by 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-albums
|
||
/// </remarks>
|
||
/// <returns></returns>
|
||
Task<AlbumsResponse> GetSeveral(AlbumsRequest request, CancellationToken cancel = default);
|
||
|
||
/// <summary>
|
||
/// Get Spotify catalog information for a single album.
|
||
/// </summary>
|
||
/// <param name="albumId">The Spotify ID of the album.</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-album
|
||
/// </remarks>
|
||
/// <returns></returns>
|
||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
|
||
Task<FullAlbum> Get(string albumId, CancellationToken cancel = default);
|
||
|
||
/// <summary>
|
||
/// Get Spotify catalog information for a single album.
|
||
/// </summary>
|
||
/// <param name="albumId">The Spotify ID of the album.</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-album
|
||
/// </remarks>
|
||
/// <returns></returns>
|
||
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
|
||
Task<FullAlbum> Get(string albumId, AlbumRequest request, CancellationToken cancel = default);
|
||
|
||
/// <summary>
|
||
/// Get Spotify catalog information about an album’s tracks.
|
||
/// Optional parameters can be used to limit the number of tracks returned.
|
||
/// </summary>
|
||
/// <param name="albumId">The Spotify ID of the album.</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-albums-tracks
|
||
/// </remarks>
|
||
/// <returns></returns>
|
||
Task<Paging<SimpleTrack>> GetTracks(string albumId, CancellationToken cancel = default);
|
||
|
||
/// <summary>
|
||
/// Get Spotify catalog information about an album’s tracks.
|
||
/// Optional parameters can be used to limit the number of tracks returned.
|
||
/// </summary>
|
||
/// <param name="albumId">The Spotify ID of the album.</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-albums-tracks
|
||
/// </remarks>
|
||
/// <returns></returns>
|
||
Task<Paging<SimpleTrack>> GetTracks(string albumId, AlbumTracksRequest request, CancellationToken cancel = default);
|
||
}
|
||
}
|