mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-25 23:46:27 +00:00
42 lines
31 KiB
HTML
42 lines
31 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="generator" content="Docusaurus v2.0.0-alpha.56">
|
|
<title data-react-helmet="true">5.x.x to 6.x.x | SpotifyAPI-NET</title><meta data-react-helmet="true" name="docsearch:version" content="next"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="5.x.x to 6.x.x | SpotifyAPI-NET"><meta data-react-helmet="true" name="description" content="SpotifyAPI.Web"><meta data-react-helmet="true" property="og:description" content="SpotifyAPI.Web"><meta data-react-helmet="true" property="og:url" content="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/next/5_to_6"><link data-react-helmet="true" rel="shortcut icon" href="/SpotifyAPI-NET/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/next/5_to_6"><link rel="stylesheet" href="/SpotifyAPI-NET/styles.8a053330.css">
|
|
<link rel="preload" href="/SpotifyAPI-NET/styles.20e5fb07.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/runtime~main.7b8f8358.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/main.420c9379.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/1.d763968b.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/2.c001a4a7.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/3.c31fd0fb.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/1be78505.6d7d8bd2.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/ad407b76.90023bdf.js" as="script">
|
|
<link rel="preload" href="/SpotifyAPI-NET/16b2da92.1ec7de48.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script><div id="__docusaurus">
|
|
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a><div class="navbar__item dropdown dropdown--hoverable dropdown--left"><a activeclassname="navbar__link--active" class="navbar__item navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></div><a class="navbar__item navbar__link" href="/SpotifyAPI-NET/news">News</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a activeclassname="navbar__link--active" class="menu__link menu__link--sublist">Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/news">News</a></li><li class="menu__list-item"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive menu_w2sC"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">SpotifyAPI-NET</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/next/introduction">Introduction</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/next/getting_started">Getting Started</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Guides</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/error_handling">Error Handling</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/configuration">Configuration</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/logging">Logging</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/proxy">Proxy</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/pagination">Pagination</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/retry_handling">Retry Handling</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/iplayableitem">IPlayableItem</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/unit_testing">Unit Testing</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Authentication Guides</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/auth_introduction">Introduction</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/client_credentials">Client Credentials</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/implicit_grant">Implicit Grant</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/authorization_code">Authorization Code</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/pkce">PKCE</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/token_swap">Token Swap</a></li></ul></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/next/showcase">Showcase</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!" tabindex="0">Examples</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_asp">ASP.NET</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_blazor_wasm">Blazor WASM</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_blazor">Blazor ServerSide</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_cli_custom_html">CLI - Custom HTML</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_cli_persistent_config">CLI - Persistent Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_token_swap">Token Swap</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/next/example_uwp">UWP</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!" tabindex="0">Migration Guides</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/SpotifyAPI-NET/docs/next/5_to_6">5.x.x to 6.x.x</a></li></ul></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="container padding-vert--lg docItemWrapper_1cc7"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><div><span class="badge badge--secondary">Version: next</span></div><header><h1 class="docTitle_1vWb">5.x.x to 6.x.x</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="spotifyapiweb"></a>SpotifyAPI.Web<a aria-hidden="true" tabindex="-1" class="hash-link" href="#spotifyapiweb" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="initialization"></a>Initialization<a aria-hidden="true" tabindex="-1" class="hash-link" href="#initialization" title="Direct link to heading">#</a></h3><p>In <code>5.x</code>, a new <code>SpotifyWebAPI</code> instance could be created without supplying necessary values, since they were implemented as properties. With <code>6.x</code>, necessary values have to be given in the constructor and <code>SpotifyWebAPI</code> has been renamed to <code>SpotifyClient</code>. Also, <code>SpotifyClientConfig</code> has been introduced to give a better configuration experience, including retry handlers, automatic authenticators and proxy configurations.</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">// OLD</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyWebAPI { AccessToken = "YourAccessToken" };</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyWebAPI(ProxyConfig); // No access token - invalid</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">// NEW</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyClient("YourAccessToken");</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var config = SpotifyClientConfig</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .CreateDefault()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .WithToken("YourAccessToken");</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyClient(config);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var config = SpotifyClientConfig</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .CreateDefault()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .WithAuthenticator(new ClientCredentialsAuthenticator(CLIENT_ID, CLIENT_SECRET)); // takes care of access tokens</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyClient(config);</span></div></div></div></div></div><p>For some performance guides, have a look at the <a href="/SpotifyAPI-NET/docs/next/configuration">Configuration Guide</a></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="proxy"></a>Proxy<a aria-hidden="true" tabindex="-1" class="hash-link" href="#proxy" title="Direct link to heading">#</a></h3><p>In <code>5.x</code>, the proxy configuration could be passed to the <code>SpotifyWebAPI</code> constructor. In <code>6.x</code>, they're part of the HTTP Client. The built-in http client supports proxies out of the box:</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">var httpClient = new NetHttpClient(new ProxyConfig("localhost", 8080)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> User = "",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Password = "",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> SkipSSLCheck = false,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">});</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var config = SpotifyClientConfig</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .CreateDefault()</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> .WithHTTPClient(httpClient);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var spotify = new SpotifyClient(config);</span></div></div></div></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="calling-api-endpoints"></a>Calling API Endpoints<a aria-hidden="true" tabindex="-1" class="hash-link" href="#calling-api-endpoints" title="Direct link to heading">#</a></h3><p>In <code>5.x</code>, there was one big instance to support all API endpoints. Parameters to these endpoints were passed directly as method parameters. Optional parameters were nullable and could be excluded. In <code>6.x</code>, every endpoint group (<code>albums</code>, <code>tracks</code>, <code>userprofile</code>) has their own API-Client, which is available as a property in a <code>SpotifyClient</code> instance. While URI path parameters are still passed as method parameter, query and body parameters are now passed as a grouped class instance, where required parameters are needed in the constructor and optional parameters can be supplied as properties. All endpoints are also only implemented as async methods.</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">// OLD:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">PrivateProfile profile = await spotify.GetPrivateProfileAsync();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var playlists = await spotify.GetUserPlaylists(profile.Id, 100, 0);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">// NEW:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">PrivateUser user = await spotify.UserProfile.Current();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var playlists = await spotify.Playlists.GetUsers(user.Id, new PlaylistGetUsersRequest</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Limit = 100,</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Offset = 0</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">});</span></div></div></div></div></div><p>All required arguments are checked for non-null values. If it's null, the methods will throw a <code>ArgumentNullException</code></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="errorheader-handling"></a>Error/Header Handling<a aria-hidden="true" tabindex="-1" class="hash-link" href="#errorheader-handling" title="Direct link to heading">#</a></h3><p>In <code>5.x</code>, all response models included a base error model, with properties like <code>Headers</code>, <code>Error</code> and <code>HasError</code>. This was not a good decision since response models should be clean and only contain API response data. In <code>6.x</code>, error handling is <code>Exception</code> based. For example, if the access token is invalid, calling API endpoints will throw a <code>APIUnauthorizedException</code>. If you hit the API too many times, the method will throw a <code>APITooManyRequestsException</code>. They all derive from a base exception <code>APIException</code>, which is also thrown in more general cases, e.g bad request input parameters. If you're interested in the headers of the last response, you can use <code>spotify.LastResponse</code>, <strong>make sure there is only one thread using this instance!</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">// OLD:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">PrivateProfile profile = await spotify.GetPrivateProfileAsync();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">if(profile.HasError())</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // handle error</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var headers = profile.Headers(); // access to headers</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">// NEW:</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">try</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> PrivateProfile profile = await spotify.GetPrivateProfileAsync();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> var response = spotify.LastResponse; // response.Headers</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">catch (APIUnauthorizedException e)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // handle unauthorized error</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // e.Response contains HTTP response</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // e.Message contains Spotify error message</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">catch (APIException e)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // handle common error</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // e.Response contains HTTP response</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> // e.Message contains Spotify error message</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div></div></div></div></div><p>More Info: <a href="/SpotifyAPI-NET/docs/next/error_handling">Error Handling</a></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="spotifyapiwebauth"></a>SpotifyAPI.Web.Auth<a aria-hidden="true" tabindex="-1" class="hash-link" href="#spotifyapiwebauth" title="Direct link to heading">#</a></h2><p>In <code>5.x</code>, <code>SpotifyAPI.Web.Auth</code> contained every logic related to the OAuth flows. In <code>6.x</code>, <code>SpotifyAPI.Web.Auth</code> is only required if you need a HTTP Server for handling OAuth responses. For example, if you're in a ASP.NET environment or just use the <a href="/SpotifyAPI-NET/docs/next/client_credentials">Client Credentials</a> flow, there is no need to install <code>SpotifyAPI.Web.Auth</code> anymore.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="authorization-code-auth"></a>Authorization Code Auth<a aria-hidden="true" tabindex="-1" class="hash-link" href="#authorization-code-auth" title="Direct link to heading">#</a></h3><p>As an example, this shows how to convert a <code>5.x</code> authorization code flow to <code>6.x</code>:</p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">// OLD</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var auth =</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> new AuthorizationCodeAuth(_clientId, _secretId, "http://localhost:4002", "http://localhost:4002",</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Scope.PlaylistReadPrivate | Scope.PlaylistReadCollaborative);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">auth.AuthReceived += AuthOnAuthReceived;</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">auth.Start();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">auth.OpenBrowser();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">private static async void AuthOnAuthReceived(object sender, AuthorizationCode payload)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> var auth = (AuthorizationCodeAuth) sender;</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> auth.Stop();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Token token = await auth.ExchangeCode(payload.Code);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> var spotify = new SpotifyWebAPI { AccessToken = token.AccessToken };</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> await PrintUsefulData(spotify);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">// NEW</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var config = SpotifyClientConfig.CreateDefault();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var server = new EmbedIOAuthServer(new Uri("http://localhost:5000/callback"), 5000);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">server.AuthorizationCodeReceived += async (sender, response) =></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> await server.Stop();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> var tokenResponse = await new OAuthClient(config).RequestToken(new AuthorizationCodeTokenRequest(</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> _clientId, _secretId, response.Code, server.BaseUri</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> ));</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> var spotify = new SpotifyClient(config.WithToken(tokenResponse.AccessToken));</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">}</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">await server.Start();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">var loginRequest = new LoginRequest(server.BaseUri, _clientId, LoginRequest.ResponseType.Code)</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">{</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> Scope = new[] { Scopes.PlaylistReadPrivate, Scopes.PlaylistReadCollaborative }</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">};</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">BrowserUtil.Open(loginRequest.ToUri());</span></div></div></div></div></div><p>While it is more code to write, there is a better seperation of concerns. For example, it is able to construct a <code>LoginRequest</code> without starting a server. This <code>LoginRequest</code> can also be used to forward the user to in a web-based context. The same auth server <code>EmbedIOAuthServer</code> can be used to receive <code>AuthorizationCodes</code> and <code>ImplictGrants</code> responses.</p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/docs/5_to_6.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2020-11-14T12:19:20.000Z" class="docLastUpdatedAt_1sqk">11/14/2020</time> by <strong>Jonas Dellinger</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/next/example_uwp"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« UWP</div></a></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#spotifyapiweb" class="table-of-contents__link">SpotifyAPI.Web</a><ul><li><a href="#initialization" class="table-of-contents__link">Initialization</a></li><li><a href="#proxy" class="table-of-contents__link">Proxy</a></li><li><a href="#calling-api-endpoints" class="table-of-contents__link">Calling API Endpoints</a></li><li><a href="#errorheader-handling" class="table-of-contents__link">Error/Header Handling</a></li></ul></li><li><a href="#spotifyapiwebauth" class="table-of-contents__link">SpotifyAPI.Web.Auth</a><ul><li><a href="#authorization-code-auth" class="table-of-contents__link">Authorization Code Auth</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="text--center"><div>Copyright © 2020 Jonas Dellinger. Built with Docusaurus.</div></div></div></footer></div>
|
|
<script src="/SpotifyAPI-NET/styles.20e5fb07.js"></script>
|
|
<script src="/SpotifyAPI-NET/runtime~main.7b8f8358.js"></script>
|
|
<script src="/SpotifyAPI-NET/main.420c9379.js"></script>
|
|
<script src="/SpotifyAPI-NET/1.d763968b.js"></script>
|
|
<script src="/SpotifyAPI-NET/2.c001a4a7.js"></script>
|
|
<script src="/SpotifyAPI-NET/3.c31fd0fb.js"></script>
|
|
<script src="/SpotifyAPI-NET/1be78505.6d7d8bd2.js"></script>
|
|
<script src="/SpotifyAPI-NET/ad407b76.90023bdf.js"></script>
|
|
<script src="/SpotifyAPI-NET/16b2da92.1ec7de48.js"></script>
|
|
</body>
|
|
</html> |