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

27 lines
1.2 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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