Spotify.NET/SpotifyAPI.Web/Clients/Interfaces/IPersonalizationClient.cs
2020-05-31 16:57:58 +02:00

49 lines
1.8 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// Endpoints for retrieving information about the users listening habits.
/// </summary>
public interface IPersonalizationClient
{
/// <summary>
/// Get the current users top tracks based on calculated affinity.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-top-artists-and-tracks
/// </remarks>
/// <returns></returns>
Task<Paging<FullTrack>> GetTopTracks();
/// <summary>
/// Get the current users top tracks based on calculated affinity.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-top-artists-and-tracks
/// </remarks>
/// <returns></returns>
Task<Paging<FullTrack>> GetTopTracks(PersonalizationTopRequest request);
/// <summary>
/// Get the current users top artists based on calculated affinity.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-top-artists-and-tracks
/// </remarks>
/// <returns></returns>
Task<Paging<FullArtist>> GetTopArtists();
/// <summary>
/// Get the current users top artists based on calculated affinity.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-top-artists-and-tracks
/// </remarks>
/// <returns></returns>
Task<Paging<FullArtist>> GetTopArtists(PersonalizationTopRequest request);
}
}