Added docs for proxy usage

This commit is contained in:
Jonas Dellinger 2018-03-25 19:56:59 +02:00
parent dd77be8a8a
commit eb0309c7cc
4 changed files with 43 additions and 0 deletions

View File

@ -52,6 +52,21 @@ _spotify = new SpotifyLocalAPI(new SpotifyLocalAPIConfig
}); });
``` ```
## Proxy Settings
You can forward your proxy settings to the local api by using a field in the `SpotifyLocalAPIConfig`.
```cs
_spotify = new SpotifyLocalAPI(new SpotifyLocalAPIConfig
{
ProxyConfig = new ProxyConfig() {
Host = "127.0.0.1",
Port = 8080
// Additional values like Username and Password are available
}
});
```
## Anti-Virus Blocking Response ## Anti-Virus Blocking Response
Some Anti-Virus Software blocks the response from spotify due wrong headers. Some Anti-Virus Software blocks the response from spotify due wrong headers.

View File

@ -0,0 +1,18 @@
## Proxy Settings
You can forward your proxy settings to the web api by using a field in the `SpotifyLocalAPIConfig`.
```cs
ProxyConfig proxyConfig = new ProxyConfig()
{
Host = "127.0.0.1",
Port = 8080
// Additional values like Username and Password are available
};
SpotifyWebAPI api = new SpotifyWebAPI(proxyConfig);
// or
WebAPIFactory webApiFactory = new WebAPIFactory(..., proxyConfig);
SpotifyWebAPI api = await webApiFactory.GetWebApi();
```

View File

@ -1,6 +1,7 @@
# SpotifyAPI-NET Documentation # SpotifyAPI-NET Documentation
##About ##About
This Library, written in C#/.NET, combines two independent SpotifyAPIs into one. This Library, written in C#/.NET, combines two independent SpotifyAPIs into one.
**Spotify's Web API** ([link](https://developer.spotify.com/web-api/)) **Spotify's Web API** ([link](https://developer.spotify.com/web-api/))
@ -16,6 +17,7 @@ Both combined can be used for any kind of application.
--- ---
##Installing ##Installing
* Via NuGet Package: * Via NuGet Package:
```cs ```cs
Install-Package SpotifyAPI-NET Install-Package SpotifyAPI-NET
@ -28,6 +30,13 @@ Install-Package SpotifyAPI-NET -pre
--- ---
##Projects ##Projects
###[Spofy](https://github.com/eltoncezar/Spofy) by [@eltoncezar](https://github.com/eltoncezar) ###[Spofy](https://github.com/eltoncezar/Spofy) by [@eltoncezar](https://github.com/eltoncezar)
> A Spotify mini player and notifier for Windows > A Spotify mini player and notifier for Windows
###[Toastify](https://github.com/aleab/toastify) by [@aleab](https://github.com/aleab)
> Toastify adds global hotkeys and toast notifications to Spotify
>
> *Forked from [nachmore/toastify](https://github.com/nachmore/toastify)*

View File

@ -6,6 +6,7 @@ pages:
- 'Getting started': 'SpotifyWebAPI/gettingstarted.md' - 'Getting started': 'SpotifyWebAPI/gettingstarted.md'
- 'Examples': 'SpotifyWebAPI/examples.md' - 'Examples': 'SpotifyWebAPI/examples.md'
- 'Authentication': 'SpotifyWebAPI/auth.md' - 'Authentication': 'SpotifyWebAPI/auth.md'
- 'Proxy': 'SpotifyWebAPI/proxy.md'
- '- Albums': 'SpotifyWebAPI/albums.md' - '- Albums': 'SpotifyWebAPI/albums.md'
- '- Artists': 'SpotifyWebAPI/artists.md' - '- Artists': 'SpotifyWebAPI/artists.md'
- '- Browse': 'SpotifyWebAPI/browse.md' - '- Browse': 'SpotifyWebAPI/browse.md'