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

71 lines
2.9 KiB
C#
Raw Normal View History

2020-05-07 12:48:31 +01:00
using System.Threading.Tasks;
2020-05-04 22:04:59 +01:00
namespace SpotifyAPI.Web
{
/// <summary>
/// Endpoints for retrieving information about one or more tracks from the Spotify catalog.
/// </summary>
2020-05-04 22:04:59 +01:00
public interface ITracksClient
{
/// <summary>
/// Get Spotify catalog information for multiple tracks based on their Spotify IDs.
/// </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-several-tracks
/// </remarks>
/// <returns></returns>
2020-05-07 12:48:31 +01:00
Task<TracksResponse> GetSeveral(TracksRequest request);
/// <summary>
/// Get a detailed audio analysis for a single track identified by its unique Spotify ID.
/// </summary>
/// <param name="trackId">The Spotify ID for the track.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-audio-analysis
/// </remarks>
/// <returns></returns>
2020-05-07 12:48:31 +01:00
Task<TrackAudioAnalysis> GetAudioAnalysis(string trackId);
/// <summary>
/// Get audio feature information for a single track identified by its unique Spotify ID.
/// </summary>
/// <param name="trackId">The Spotify ID for the track.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-audio-features
/// </remarks>
/// <returns></returns>
Task<TrackAudioFeatures> GetAudioFeatures(string trackId);
2020-05-07 12:48:31 +01:00
/// <summary>
/// Get Spotify catalog information for a single track identified by its unique Spotify ID.
/// </summary>
/// <param name="trackId">The Spotify ID for the track.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-track
/// </remarks>
/// <returns></returns>
2020-05-07 12:48:31 +01:00
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullTrack> Get(string trackId);
/// <summary>
/// Get Spotify catalog information for a single track identified by its unique Spotify ID.
/// </summary>
/// <param name="trackId">The Spotify ID for the track.</param>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <returns></returns>
2020-05-07 12:48:31 +01:00
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullTrack> Get(string trackId, TrackRequest request);
/// <summary>
/// Get audio features for multiple tracks based on their Spotify IDs.
/// </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-several-audio-features
/// </remarks>
/// <returns></returns>
2020-05-07 12:48:31 +01:00
Task<TracksAudioFeaturesResponse> GetSeveralAudioFeatures(TracksAudioFeaturesRequest request);
2020-05-04 22:04:59 +01:00
}
}