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

28 lines
1.2 KiB
C#
Raw Normal View History

2020-05-01 19:05:28 +01:00
using System.Threading.Tasks;
using SpotifyAPI.Web.Models;
namespace SpotifyAPI.Web
{
2020-05-13 17:25:42 +01:00
/// <summary>
/// Endpoints for retrieving information about a users profile.
/// </summary>
/// <remarks>https://developer.spotify.com/documentation/web-api/reference-beta/#category-user-profile</remarks>
2020-05-01 19:05:28 +01:00
public interface IUserProfileClient
{
/// <summary>
2020-05-13 17:25:42 +01:00
/// Get detailed profile information about the current user (including the current users username).
2020-05-01 19:05:28 +01:00
/// </summary>
2020-05-13 17:25:42 +01:00
/// <remarks>https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-current-users-profile</remarks>
2020-05-01 19:05:28 +01:00
/// <exception cref="APIUnauthorizedException">Thrown if the client is not authenticated.</exception>
Task<PrivateUser> Current();
/// <summary>
2020-05-13 17:25:42 +01:00
/// Get public profile information about a Spotify user.
2020-05-01 19:05:28 +01:00
/// </summary>
2020-05-13 17:25:42 +01:00
/// <remarks>https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-users-profile</remarks>
2020-05-01 19:05:28 +01:00
/// <exception cref="APIUnauthorizedException">Thrown if the client is not authenticated.</exception>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
2020-05-01 19:05:28 +01:00
Task<PublicUser> Get(string userId);
}
}