forked from JohnnyCrazy/SpotifyAPI-NET
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIOAuthClient.cs
More file actions
61 lines (56 loc) · 2.56 KB
/
IOAuthClient.cs
File metadata and controls
61 lines (56 loc) · 2.56 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
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
/// <summary>
/// An OAuth Client, which allows to get inital and updated tokens from the Spotify Service
/// </summary>
public interface IOAuthClient
{
/// <summary>
/// Requests a new token using client_ids and client_secrets.
/// If the token is expired, simply call the funtion again to get a new token
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow
/// </remarks>
/// <returns></returns>
Task<ClientCredentialsTokenResponse> RequestToken(ClientCredentialsRequest request);
/// <summary>
/// Refresh an already received token via Authorization Code Auth
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
/// </remarks>
/// <returns></returns>
Task<AuthorizationCodeRefreshResponse> RequestToken(AuthorizationCodeRefreshRequest request);
/// <summary>
/// Reequest an initial token via Authorization Code Auth
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
/// </remarks>
/// <returns></returns>
Task<AuthorizationCodeTokenResponse> RequestToken(AuthorizationCodeTokenRequest request);
/// <summary>
/// Swaps out a received code with a access token using a remote server
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/ios/guides/token-swap-and-refresh/
/// </remarks>
/// <returns></returns>
Task<AuthorizationCodeTokenResponse> RequestToken(TokenSwapTokenRequest request);
/// <summary>
/// Gets a refreshed access token using an already received refresh token using a remote server
/// </summary>
/// <param name="request"></param>
/// <remarks>
/// https://developer.spotify.com/documentation/ios/guides/token-swap-and-refresh/
/// </remarks>
/// <returns></returns>
Task<AuthorizationCodeRefreshResponse> RequestToken(TokenSwapRefreshRequest request);
}
}