Repository navigation
Expand file tree
/
Copy pathIAudiobooksClient.cs
More file actions
71 lines (66 loc) · 3.9 KB
/
Copy pathIAudiobooksClient.cs
File metadata and controls
71 lines (66 loc) · 3.9 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
using System.Threading;
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// Endpoints for retrieving information about one or more audiobooks from the Spotify catalog.
/// </summary>
public interface IAudiobooksClient
{
/// <summary>
/// Get Spotify catalog information for a single audiobook. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
/// </summary>
/// <param name="audiobookId">The Spotify ID for the audiobook.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/get-multiple-audiobooks
/// </remarks>
/// <returns></returns>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullAudiobook> Get(string audiobookId, CancellationToken cancel = default);
/// <summary>
/// Get Spotify catalog information for a single audiobook. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
/// </summary>
/// <param name="audiobookId">The Spotify ID for the audiobook.</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/get-multiple-audiobooks
/// </remarks>
/// <returns></returns>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullAudiobook> Get(string audiobookId, AudiobookRequest request, CancellationToken cancel = default);
/// <summary>
/// Get Spotify catalog information for several audiobooks identified by their Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
/// </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/get-multiple-audiobooks
/// </remarks>
/// <returns></returns>
[System.Obsolete("This endpoint (GET /audiobooks) has been removed.")]
Task<AudiobooksResponse> GetSeveral(AudiobooksRequest request, CancellationToken cancel = default);
/// <summary>
/// Get Spotify catalog information about an audiobook's chapters. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
/// </summary>
/// <param name="audiobookId">The Spotify ID for the audiobook.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference/get-audiobook-chapters
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAudiobookChapter>> GetChapters(string audiobookId, CancellationToken cancel = default);
/// <summary>
/// Get Spotify catalog information about an audiobook's chapters. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
/// </summary>
/// <param name="audiobookId">The Spotify ID for the audiobook.</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/get-audiobook-chapters
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAudiobookChapter>> GetChapters(string audiobookId, AudiobookChaptersRequest request, CancellationToken cancel = default);
}
}