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

108 lines
4.4 KiB
C#
Raw Normal View History

2020-05-04 22:02:53 +01:00
using System.Collections.Generic;
using System.Threading.Tasks;
namespace SpotifyAPI.Web
{
public interface IFollowClient
{
2020-05-28 15:30:17 +01:00
/// <summary>
/// Check to see if the current user is following one or more artists or other Spotify users.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-check-current-user-follows
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<List<bool>> CheckCurrentUser(FollowCheckCurrentUserRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Check to see if one or more Spotify users are following a specified playlist.
/// </summary>
/// <param name="playlistId">The Spotify ID of the playlist.</param>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-check-if-user-follows-playlist
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<List<bool>> CheckPlaylist(string playlistId, FollowCheckPlaylistRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Add the current user as a follower of one or more artists or other Spotify users.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-follow-artists-users
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<bool> Follow(FollowRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Add the current user as a follower of a playlist.
/// </summary>
/// <param name="playlistId">
/// The Spotify ID of the playlist.
/// Any playlist can be followed, regardless of its public/private status,
/// as long as you know its playlist ID.
/// </param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-follow-playlist
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<bool> FollowPlaylist(string playlistId);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Add the current user as a follower of a playlist.
/// </summary>
/// <param name="playlistId">
/// The Spotify ID of the playlist.
/// Any playlist can be followed, regardless of its public/private status,
/// as long as you know its playlist ID.
/// </param>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-follow-playlist
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<bool> FollowPlaylist(string playlistId, FollowPlaylistRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get the current users followed artists.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-followed
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<FollowedArtistsResponse> OfCurrentUser();
2020-05-28 15:30:17 +01:00
/// <summary>
/// Get the current users followed artists.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-followed
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<FollowedArtistsResponse> OfCurrentUser(FollowOfCurrentUserRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Remove the current user as a follower of one or more artists or other Spotify users.
/// </summary>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-unfollow-artists-users
/// </remarks>
/// <returns></returns>
2020-05-04 22:02:53 +01:00
Task<bool> Unfollow(UnfollowRequest request);
2020-05-28 15:30:17 +01:00
/// <summary>
/// Remove the current user as a follower of a playlist.
/// </summary>
/// <param name="playlistId">The Spotify ID of the playlist that is to be no longer followed.</param>
/// <returns></returns>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-unfollow-playlist
/// </remarks>
2020-05-04 22:02:53 +01:00
Task<bool> UnfollowPlaylist(string playlistId);
}
}