Repository navigation
Expand file tree
/
Copy pathIAlbumsClient.cs
More file actions
73 lines (68 loc) · 3.47 KB
/
Copy pathIAlbumsClient.cs
File metadata and controls
73 lines (68 loc) · 3.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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>
[System.Obsolete("This endpoint (GET /albums) has been removed.")]
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);
}
}