Spotify.NET/SpotifyAPI.Web/Clients/Interfaces/IArtistsClient.cs

86 lines
4.1 KiB
C#
Raw Normal View History

using System.Threading;
2020-05-08 10:10:53 +01:00
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// Endpoints for retrieving information about one or more artists from the Spotify catalog.
/// </summary>
2020-05-08 10:10:53 +01:00
public interface IArtistsClient
{
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information for several artists based on their Spotify IDs.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-multiple-artists
/// </remarks>
/// <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>
2020-05-28 15:30:17 +01:00
/// <returns></returns>
Task<ArtistsResponse> GetSeveral(ArtistsRequest request, CancellationToken cancel = default);
2020-05-08 10:10:53 +01:00
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information for a single artist identified by their unique Spotify ID.
/// </summary>
/// <param name="artistId">The Spotify ID of the artist.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
2020-05-28 15:30:17 +01:00
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artist
/// </remarks>
/// <returns></returns>
2020-05-08 15:39:00 +01:00
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullArtist> Get(string artistId, CancellationToken cancel = default);
2020-05-08 10:10:53 +01:00
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information about an artists albums.
/// Optional parameters can be specified in the query string to filter and sort the response.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
2020-05-28 15:30:17 +01:00
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-albums
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAlbum>> GetAlbums(string artistId, CancellationToken cancel = default);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information about an artists albums.
/// Optional parameters can be specified in the query string to filter and sort the response.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist.</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>
2020-05-28 15:30:17 +01:00
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-albums
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAlbum>> GetAlbums(string artistId, ArtistsAlbumsRequest request, CancellationToken cancel = default);
2020-05-08 10:10:53 +01:00
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information about an artists top tracks by country.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist</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>
2020-05-28 15:30:17 +01:00
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-top-tracks
/// </remarks>
/// <returns></returns>
Task<ArtistsTopTracksResponse> GetTopTracks(string artistId, ArtistsTopTracksRequest request, CancellationToken cancel = default);
2020-05-08 10:10:53 +01:00
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get Spotify catalog information about artists similar to a given artist.
/// Similarity is based on analysis of the Spotify communitys listening history.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
2020-05-28 15:30:17 +01:00
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-related-artists
/// </remarks>
/// <returns></returns>
Task<ArtistsRelatedArtistsResponse> GetRelatedArtists(string artistId, CancellationToken cancel = default);
2020-05-08 10:10:53 +01:00
}
}