2020-05-13 22:49:54 +01:00
|
|
|
using System.Threading.Tasks;
|
|
|
|
|
|
|
|
namespace SpotifyAPI.Web
|
|
|
|
{
|
2020-05-30 22:20:42 +01:00
|
|
|
/// <summary>
|
|
|
|
/// An OAuth Client, which allows to get inital and updated tokens from the Spotify Service
|
|
|
|
/// </summary>
|
2020-05-13 22:49:54 +01:00
|
|
|
public interface IOAuthClient
|
|
|
|
{
|
2020-05-29 12:06:20 +01:00
|
|
|
/// <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"></param>
|
2020-05-30 22:20:42 +01:00
|
|
|
/// <remarks>
|
|
|
|
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow
|
|
|
|
/// </remarks>
|
2020-05-29 12:06:20 +01:00
|
|
|
/// <returns></returns>
|
2020-05-15 19:06:24 +01:00
|
|
|
Task<CredentialsTokenResponse> RequestToken(ClientCredentialsRequest request);
|
2020-05-29 12:06:20 +01:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Refresh an already received token via Authorization Code Auth
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request"></param>
|
2020-05-30 22:20:42 +01:00
|
|
|
/// <remarks>
|
|
|
|
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
|
|
|
|
/// </remarks>
|
2020-05-29 12:06:20 +01:00
|
|
|
/// <returns></returns>
|
|
|
|
Task<AuthorizationCodeRefreshResponse> RequestToken(AuthorizationCodeRefreshRequest request);
|
2020-05-30 22:20:42 +01:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Reequest an initial token via Authorization Code Auth
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="request"></param>
|
|
|
|
/// <remarks>
|
|
|
|
/// https://developer.spotify.com/documentation/general/guides/authorization-guide/#authorization-code-flow
|
|
|
|
/// </remarks>
|
|
|
|
/// <returns></returns>
|
2020-05-29 12:06:20 +01:00
|
|
|
Task<AuthorizationCodeTokenResponse> RequestToken(AuthorizationCodeTokenRequest request);
|
2020-05-13 22:49:54 +01:00
|
|
|
}
|
|
|
|
}
|