Spotify.NET/SpotifyAPI/Web/IClient.cs

126 lines
5.7 KiB
C#
Raw Normal View History

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
2017-05-31 16:25:56 +01:00
using System.Net.Http.Headers;
2015-11-05 20:20:22 +00:00
using System.Threading.Tasks;
2016-07-07 20:23:36 +01:00
using SpotifyAPI.Web.Models;
namespace SpotifyAPI.Web
{
public interface IClient : IDisposable
{
JsonSerializerSettings JsonSettings { get; set; }
/// <summary>
/// Downloads data from an URL and returns it
/// </summary>
/// <param name="url">An URL</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, string> Download(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Downloads data async from an URL and returns it
/// </summary>
/// <param name="url"></param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, string>> DownloadAsync(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Downloads data from an URL and returns it
/// </summary>
/// <param name="url">An URL</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, byte[]> DownloadRaw(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Downloads data async from an URL and returns it
/// </summary>
/// <param name="url"></param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, byte[]>> DownloadRawAsync(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Downloads data from an URL and converts it to an object
/// </summary>
/// <typeparam name="T">The Type which the object gets converted to</typeparam>
/// <param name="url">An URL</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, T> DownloadJson<T>(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Downloads data async from an URL and converts it to an object
/// </summary>
/// <typeparam name="T">The Type which the object gets converted to</typeparam>
/// <param name="url">An URL</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, T>> DownloadJsonAsync<T>(string url, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data from an URL and returns the response
/// </summary>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, string> Upload(string url, string body, string method, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data async from an URL and returns the response
/// </summary>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, string>> UploadAsync(string url, string body, string method, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data from an URL and returns the response
/// </summary>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, byte[]> UploadRaw(string url, string body, string method, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data async from an URL and returns the response
/// </summary>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, byte[]>> UploadRawAsync(string url, string body, string method, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data from an URL and converts the response to an object
/// </summary>
/// <typeparam name="T">The Type which the object gets converted to</typeparam>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Tuple<ResponseInfo, T> UploadJson<T>(string url, string body, string method, Dictionary<string, string> headers = null);
2015-11-05 20:20:22 +00:00
/// <summary>
/// Uploads data async from an URL and converts the response to an object
/// </summary>
/// <typeparam name="T">The Type which the object gets converted to</typeparam>
/// <param name="url">An URL</param>
/// <param name="body">The Body-Data (most likely a JSON String)</param>
/// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
2017-05-31 18:54:13 +01:00
/// <param name="headers"></param>
2015-11-05 20:20:22 +00:00
/// <returns></returns>
2017-05-31 16:25:56 +01:00
Task<Tuple<ResponseInfo, T>> UploadJsonAsync<T>(string url, string body, string method, Dictionary<string, string> headers = null);
}
}