mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-23 14:46:26 +00:00
1 line
9.0 KiB
JavaScript
1 line
9.0 KiB
JavaScript
"use strict";(self.webpackChunkspotify_api_docs=self.webpackChunkspotify_api_docs||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"6.X","banner":null,"badge":true,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"category","label":"SpotifyAPI-NET","items":[{"type":"link","label":"Introduction","href":"/SpotifyAPI-NET/docs/introduction","docId":"introduction"},{"type":"link","label":"Getting Started","href":"/SpotifyAPI-NET/docs/getting_started","docId":"getting_started"},{"type":"category","label":"Guides","items":[{"type":"link","label":"Error Handling","href":"/SpotifyAPI-NET/docs/error_handling","docId":"error_handling"},{"type":"link","label":"Configuration","href":"/SpotifyAPI-NET/docs/configuration","docId":"configuration"},{"type":"link","label":"Logging","href":"/SpotifyAPI-NET/docs/logging","docId":"logging"},{"type":"link","label":"Proxy","href":"/SpotifyAPI-NET/docs/proxy","docId":"proxy"},{"type":"link","label":"Pagination","href":"/SpotifyAPI-NET/docs/pagination","docId":"pagination"},{"type":"link","label":"Retry Handling","href":"/SpotifyAPI-NET/docs/retry_handling","docId":"retry_handling"},{"type":"link","label":"IPlayableItem","href":"/SpotifyAPI-NET/docs/iplayableitem","docId":"iplayableitem"},{"type":"link","label":"Unit Testing","href":"/SpotifyAPI-NET/docs/unit_testing","docId":"unit_testing"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Authentication Guides","items":[{"type":"link","label":"Introduction","href":"/SpotifyAPI-NET/docs/auth_introduction","docId":"auth_introduction"},{"type":"link","label":"Client Credentials","href":"/SpotifyAPI-NET/docs/client_credentials","docId":"client_credentials"},{"type":"link","label":"Implicit Grant","href":"/SpotifyAPI-NET/docs/implicit_grant","docId":"implicit_grant"},{"type":"link","label":"Authorization Code","href":"/SpotifyAPI-NET/docs/authorization_code","docId":"authorization_code"},{"type":"link","label":"PKCE","href":"/SpotifyAPI-NET/docs/pkce","docId":"pkce"},{"type":"link","label":"Token Swap","href":"/SpotifyAPI-NET/docs/token_swap","docId":"token_swap"}],"collapsed":true,"collapsible":true},{"type":"link","label":"Showcase","href":"/SpotifyAPI-NET/docs/showcase","docId":"showcase"},{"type":"category","label":"Examples","items":[{"type":"link","label":"ASP.NET","href":"/SpotifyAPI-NET/docs/example_asp","docId":"example_asp"},{"type":"link","label":"Blazor WASM","href":"/SpotifyAPI-NET/docs/example_blazor_wasm","docId":"example_blazor_wasm"},{"type":"link","label":"Blazor ServerSide","href":"/SpotifyAPI-NET/docs/example_blazor","docId":"example_blazor"},{"type":"link","label":"CLI - Custom HTML","href":"/SpotifyAPI-NET/docs/example_cli_custom_html","docId":"example_cli_custom_html"},{"type":"link","label":"CLI - Persistent Config","href":"/SpotifyAPI-NET/docs/example_cli_persistent_config","docId":"example_cli_persistent_config"},{"type":"link","label":"Token Swap","href":"/SpotifyAPI-NET/docs/example_token_swap","docId":"example_token_swap"},{"type":"link","label":"UWP","href":"/SpotifyAPI-NET/docs/example_uwp","docId":"example_uwp"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Migration Guides","items":[{"type":"link","label":"5.x.x to 6.x.x","href":"/SpotifyAPI-NET/docs/5_to_6","docId":"5_to_6"}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true}]},"docs":{"5_to_6":{"id":"5_to_6","title":"5.x.x to 6.x.x","description":"SpotifyAPI.Web","sidebar":"docs"},"auth_introduction":{"id":"auth_introduction","title":"Introduction","description":"Spotify does not allow unauthorized access to the API. Thus, you need an access token to make requests. This access token can be gathered via multiple schemes, all following the OAuth2 spec. Since it\'s important to choose the correct scheme for your usecase, make sure you have a grasp of the following terminology/docs:","sidebar":"docs"},"authorization_code":{"id":"authorization_code","title":"Authorization Code","description":"This flow is suitable for long-running applications in which the user grants permission only once. It provides an access token that can be refreshed. Since the token exchange involves sending your secret key, perform this on a secure location, like a backend service, and not from a client such as a browser or from a mobile app.","sidebar":"docs"},"client_credentials":{"id":"client_credentials","title":"Client Credentials","description":"The Client Credentials flow is used in server-to-server authentication.","sidebar":"docs"},"configuration":{"id":"configuration","title":"Configuration","description":"To configure the Spotify client functionality, the SpotifyClientConfig class exists.","sidebar":"docs"},"error_handling":{"id":"error_handling","title":"Error Handling","description":"API calls can fail when input data is malformed or the server detects issues with the request. As an example, the following request obviously fails:","sidebar":"docs"},"example_asp":{"id":"example_asp","title":"ASP.NET","description":"Description","sidebar":"docs"},"example_blazor":{"id":"example_blazor","title":"Blazor ServerSide","description":"Description","sidebar":"docs"},"example_blazor_wasm":{"id":"example_blazor_wasm","title":"Blazor WASM","description":"Description","sidebar":"docs"},"example_cli_custom_html":{"id":"example_cli_custom_html","title":"CLI - Custom HTML","description":"Description","sidebar":"docs"},"example_cli_persistent_config":{"id":"example_cli_persistent_config","title":"CLI - Persistent Config","description":"Description","sidebar":"docs"},"example_token_swap":{"id":"example_token_swap","title":"Token Swap","description":"","sidebar":"docs"},"example_uwp":{"id":"example_uwp","title":"UWP","description":"","sidebar":"docs"},"getting_started":{"id":"getting_started","title":"Getting Started","description":"Adding SpotifyAPI-NET to your project","sidebar":"docs"},"implicit_grant":{"id":"implicit_grant","title":"Implicit Grant","description":"Implicit grant flow is for clients that are implemented entirely using JavaScript and running in the resource owner\u2019s browser. You do not need any server-side code to use it. Rate limits for requests are improved but there is no refresh token provided. This flow is described in RFC-6749.","sidebar":"docs"},"introduction":{"id":"introduction","title":"Introduction","description":"This open source library for the Spotify Web API provides an easy to use interface for .NET based languages, like C# and VisualBasic .NET. By using it you can query general spotify catalog information (tracks, albums and playlists), manage user-related content (\\"My Library\\", create and edit playlists) and control the users music players (play, stop, transfer playback, play specific track).","sidebar":"docs"},"iplayableitem":{"id":"iplayableitem","title":"IPlayableItem","description":"When working with playlists or the current playing context, you will encounter the IPlayableItem type, which only contains a Type property. Spotify recently introduced shows/episodes to the API, and thus had to adapt API endpoints which previously just returned track objects. Now, playlists and the current playing context can include two types: tracks and episodes. To reflect this in our models, we introduced IPlayableItem.","sidebar":"docs"},"logging":{"id":"logging","title":"Logging","description":"The library provides a way to inject your own, custom HTTP Logger. By default, no logging is performed.","sidebar":"docs"},"pagination":{"id":"pagination","title":"Pagination","description":"When working with Spotify responses, you will often encounter the Paging type.","sidebar":"docs"},"pkce":{"id":"pkce","title":"PKCE","description":"The authorization code flow with PKCE is the best option for mobile and desktop applications where it is unsafe to store your client secret. It provides your app with an access token that can be refreshed. For further information about this flow, see IETF RFC-7636.","sidebar":"docs"},"proxy":{"id":"proxy","title":"Proxy","description":"The included HTTPClient has full proxy configuration support:","sidebar":"docs"},"retry_handling":{"id":"retry_handling","title":"Retry Handling","description":"In Error Handling, we already found out that requests can fail. We provide a way to automatically retry requests via retry handlers. Note that, by default, no retries are performed.","sidebar":"docs"},"showcase":{"id":"showcase","title":"Showcase","description":"Are you using SpotifyAPI-NET and would like to include your project in this list?","sidebar":"docs"},"token_swap":{"id":"token_swap","title":"Token Swap","description":"Token Swap provides an authenticatiow flow where client-side apps (like CLI/desktop/mobile apps) are still able to use long-living tokens and the opportunity to refresh them without exposing your application\'s secret. This however requires a server-side part to work.","sidebar":"docs"},"unit_testing":{"id":"unit_testing","title":"Unit Testing","description":"The modular structure of the library makes it easy to mock the API when unit testing. Consider the following method:","sidebar":"docs"}}}')}}]); |